Связаться с намиПодключиться

Как начать работать с AWS SDK для Kotlin в Yandex Cloud Notification Service

Статья создана
Обновлена 13 марта 2025 г.

Примечание

Сервис находится на стадии Preview.

Чтобы начать работу с AWS SDK для Kotlin:

  1. Подготовьте облако к работе.
  2. Получите статический ключ доступа.
  3. Настройте AWS SDK.
  4. Создайте канал уведомлений.
  5. Получите список каналов.
  6. Создайте эндпоинт.
  7. Отправьте уведомление.

Подготовьте облако к работе

Зарегистрируйтесь в Yandex Cloud и создайте платежный аккаунт:

  1. Перейдите в консоль управления, затем войдите в Yandex Cloud или зарегистрируйтесь.
  2. На странице Yandex Cloud Billing убедитесь, что у вас подключен платежный аккаунт, и он находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его и привяжите к нему облако.

Если у вас есть активный платежный аккаунт, вы можете создать или выбрать каталог, в котором будет работать ваша инфраструктура, на странице облака.

Подробнее об облаках и каталогах.

Получите статический ключ доступа

Для аутентификации в Cloud Notification Service используется статический ключ доступа. Этот ключ выпускается на сервисный аккаунт, и все действия выполняются от имени этого сервисного аккаунта.

Чтобы получить статический ключ доступа:

  1. Создайте сервисный аккаунт.

  2. Назначьте сервисному аккаунту роль editor на каталог.

  3. Для сервисного аккаунта создайте статический ключ доступа.

    Сохраните идентификатор и секретный ключ.

Настройте AWS SDK

Пререквизиты и инструкция по установке AWS SDK для Kotlin описаны в документации AWS.

Для работы с уведомлениями RuStore Android познакомьтесь с документацией RuStore SDK.

Подготовьте ОС к работе

  1. Установите Java версии 8 или выше, например, Oracle Java SE Development Kit. Другие JDK, с которыми работает AWS SDK описаны в документации AWS.
  2. Установите систему сборки Gradle.

Создайте проект

  1. Создайте новый проект:

    1. Выполните следующую команду:

      gradle init --type kotlin-application --dsl kotlin

    2. В интерактивном режиме для каждого сообщения выберите значение по умолчанию, нажав клавишу Enter.

  2. В файл settings.gradle.kts в корне проекта добавьте зависимости:

    dependencyResolutionManagement {
    repositories {
        mavenCentral()
    }

    versionCatalogs {
        create("awssdk") {
            from("aws.sdk.kotlin:version-catalog:1.4.0")
        }
    }
}

    Версию 1.4.0 можно заменить на последнюю версию SDK для Kotlin.

  3. Скопируйте в файл gradle/libs.versions.toml следующий код:

    [versions]
junit-jupiter-engine = "5.10.3"

[libraries]
junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit-jupiter-engine" }

[plugins]
kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version = "2.1.0" }

  4. Скопируйте в файл app/build.gradle.kts следующий код:

    plugins {
    alias(libs.plugins.kotlin.jvm)
    application
}


dependencies {
    implementation(awssdk.services.sns) // Add dependency on the AWS SDK for Kotlin's SNS client.

    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
    testImplementation(libs.junit.jupiter.engine)
    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
}

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(21)
    }
}

application {
    mainClass = "org.example.AppKt"
}

tasks.named<Test>("test") {
    useJUnitPlatform()
}

  5. Создайте клиент в файле app/src/main/kotlin/org/example/App.kt:

    package org.example

import aws.sdk.kotlin.services.sns.SnsClient
import aws.smithy.kotlin.runtime.net.url.Url
import aws.sdk.kotlin.runtime.auth.credentials.StaticCredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.Credentials

import kotlinx.coroutines.runBlocking

suspend fun main(): Unit = runBlocking {
    val snsClient = SnsClient {
        region = "ru-central1"; endpointUrl =
        Url.parse("https://notifications.yandexcloud.net/"); credentialsProvider =
        StaticCredentialsProvider(
            Credentials(
                "<идентификатор_статического_ключа>",
                "<секретный_ключ>"
            )
        )
    }

    // Используйте snsClient
}

    Где credentialsProvider содержит идентификатор статического ключа и секретный ключ.

  6. Выполните следующую команду для запуска проекта:

    gradle run

Создайте канал уведомлений

  1. Импортируйте классы:

    import aws.sdk.kotlin.services.sns.model.CreatePlatformApplicationRequest

  2. Выполните код:

    snsClient.use {
    val response = snsClient.createPlatformApplication(CreatePlatformApplicationRequest {
        name = "<имя_канала>"
        platform = "<тип_платформы>"
        attributes = mapOf("<тип_аутентификации>" to "<ключ>")
    })
    println("Platform application ARN: ${response.platformApplicationArn}")
}

    Где:

    • name — имя канала уведомлений, задается пользователем.

      Имя должно быть уникальным для всего CNS. После создания канала изменить имя нельзя. Имя может содержать строчные и заглавные буквы латинского алфавита, цифры, подчеркивания, дефисы и точки. Длина — от 1 до 256 символов. Рекомендуется для каналов APNs указывать в имени идентификатор приложения (Bundle ID), для FCM и HMS — полное название пакета приложения (Package name), для RuStore — значение packageName.

    • platform — тип мобильной платформы:

      • APNS и APNS_SANDBOX — Apple Push Notification service (APNs). Для тестирования приложения используйте APNS_SANDBOX.
      • GCM — Firebase Cloud Messaging (FCM).
      • HMS — Huawei Mobile Services (HMS).
      • RUSTORE — RuStore Android.

    • attributes — параметры аутентификации на мобильной платформе в формате ключ=значение. Значения зависят от типа платформы:

      • APNs:

        • Аутентификация с токеном:

          • PlatformPrincipal — путь к файлу с ключом подписи токена, полученный в Apple.
          • PlatformCredential — идентификатор ключа подписи (Key ID).
          • ApplePlatformTeamID — идентификатор разработчика (Team ID).
          • ApplePlatformBundleID — идентификатор приложения (Bundle ID).

        • Аутентификация с сертификатом:

          • PlatformPrincipal — SSL-сертификат в формате .pem.

          • PlatformCredential — закрытый ключ сертификата в формате .pem.

            Чтобы сохранить сертификат и закрытый ключ в отдельных файлах формата .pem, вы можете воспользоваться утилитой openssl в Linux:

            openssl pkcs12 -in Certificates.p12 -nokeys -nodes -out certificate.pem
openssl pkcs12 -in Certificates.p12 -nocerts -nodes -out privatekey.pem

        Аутентификация с токеном — более современный и безопасный метод.

      • FCM: PlatformCredential — ключ сервисного аккаунта Google Cloud в формате JSON для аутентификации с помощью HTTP v1 API или API-ключ (server key) для аутентификации с помощью Legacy API.

        Используйте HTTP v1 API, так как с июля 2024 года FCM legacy API не поддерживается.

      • HMS:

        • PlatformPrincipal — идентификатор ключа.
        • PlatformCredential — API-ключ.

    В результате вы получите идентификатор (ARN) канала уведомлений.

Получите список каналов уведомлений

  1. Импортируйте классы:

    import aws.sdk.kotlin.services.sns.model.ListPlatformApplicationsRequest

  2. Выполните код:

    snsClient.use {
    val response = snsClient.listPlatformApplications(ListPlatformApplicationsRequest {})
    response.platformApplications?.forEach { app ->
        println("Application ARN: ${app.platformApplicationArn}")
    }
}

    В результате будет выведен список каналов уведомлений, размещенных в том же каталоге, в котором находится сервисный аккаунт.

Создайте эндпоинт

  1. Импортируйте классы:

    import aws.sdk.kotlin.services.sns.model.CreatePlatformEndpointRequest

  2. Выполните код:

    snsClient.use {
    val response = snsClient.createPlatformEndpoint(CreatePlatformEndpointRequest {
        platformApplicationArn = "<ARN_канала_уведомлений>"
        token = "<Push-токен>"
    })
    println("Endpoint ARN: ${response.endpointArn}")
}

    Где:

    • platformApplicationArn — идентификатор (ARN) канала уведомлений.
    • token — уникальный Push-токен приложения на устройстве пользователя.

Отправьте уведомление

Явные уведомления (Bright Push)

  1. Импортируйте классы:

    import aws.sdk.kotlin.services.sns.model.PublishRequest

  2. Выполните код:

    snsClient.use {
    val response = snsClient.publish(PublishRequest {
        targetArn = "<ARN_эндпоинта>"
        message = "{\"default\": \"<текст_уведомления>\", \"APNS\": \"{\\\"aps\\\": {\\\"alert\\\": \\\"<текст_уведомления>\\\"}}\"}"
        messageStructure = "json"
    })
    println("Message id: ${response.messageId}")
}

    snsClient.use {
    val response = snsClient.publish(PublishRequest {
        targetArn = "<ARN_эндпоинта>"
        message = "{\"default\": \"<текст_уведомления>\", \"GCM\": \"{\\\"notification\\\": {\\\"body\\\": \\\"<текст_уведомления>\\\"}}\"}"
        messageStructure = "json"
    })
    println("Message id: ${response.messageId}")
}

    Где:

    • targetArn — идентификатор (ARN) мобильного эндпоинта.
    • message — сообщение.
    • messageStructure — формат сообщения.

Тихие уведомления (Silent Push)

  1. Импортируйте классы:

    import aws.sdk.kotlin.services.sns.model.PublishRequest

  2. Выполните код:

    snsClient.use {
    val response = snsClient.publish(PublishRequest {
        targetArn = "<ARN_эндпоинта>"
        message = "{\"default\": \"<текст_уведомления>\", \"APNS\": \"{\\\"key\\\": \\\"value\\\"}\"}"
        messageStructure = "json"
    })
    println("Message id: ${response.messageId}")
}

    snsClient.use {
    val response = snsClient.publish(PublishRequest {
        targetArn = "<ARN_эндпоинта>"
        message = "{\"default\": \"<текст_уведомления>\", \"GCM\": \"{\\\"data\\\": {\\\"key\\\": \\\"value\\\"}}\"}"
        messageStructure = "json"
    })
    println("Message id: ${response.messageId}")
}

    Где:

    • targetArn — идентификатор (ARN) мобильного эндпоинта.
    • message — сообщение.
    • messageStructure — формат сообщения.

SMS-сообщения

  1. Импортируйте классы:

    import aws.sdk.kotlin.services.sns.model.PublishRequest
import aws.sdk.kotlin.services.sns.model.MessageAttributeValue

  2. Выполните код:

    snsClient.use {
    val response = snsClient.publish(PublishRequest {
        phoneNumber = "<номер_телефона>"
        message = "<текст_уведомления>"
        messageAttributes = mapOf("AWS.SNS.SMS.SenderID" to MessageAttributeValue {
            dataType = "String"; stringValue = "<текстовое_имя_отправителя>"
        })
    })
    println("Message id: ${response.messageId}")
}

    Где:

    • phoneNumber — номер телефона получателя.
    • message — текст уведомления.
    • stringValue — текстовое имя отправителя.

См. также

Предыдущая
AWS SDK для JavaScript
Следующая
AWS SDK для .NET