本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # 在 Amazon SNS 中设置移动应用程序 该主题介绍如何使用 [Amazon SNS 用户通知的先决条件](sns-prerequisites-for-mobile-push-notifications.md)中描述的信息在 AWS 管理控制台中设置移动应用程序。 # Amazon SNS 用户通知的先决条件 要开始使用 Amazon SNS 移动推送通知，您需要： + 用于连接支持的推送通知服务之一的一组凭证：ADM、Baidu、FCM APNs、MPNS 或 WNS。 + 移动应用程序和设备的设备令牌或注册 ID。 + 配置 Amazon SNS 以将推送通知消息发送到移动终端节点。 + 注册并配置移动应用程序来使用支持的推送通知服务之一。 使用推送通知服务注册您的应用程序需要几个步骤。Amazon SNS 需要您提供给推送通知服务的一些信息才能将直接推送通知消息发送到移动终端节点。通常而言，您需要连接推送通知服务所需的凭证、从推送通知服务获得的设备令牌或注册 ID（表示移动设备和移动应用程序），以及已注册推送通知服务的移动应用程序。 凭证的准确格式因移动平台而异，但在所有情况下，这些凭证必须在与平台建立连接时提交。为每个移动应用程序发布一组凭证，并且必须将其用于将消息发送到该应用程序的所有实例。 具体名称根据使用的推送通知服务而不同。例如，当 APNs 用作推送通知服务时，您需要*设备令牌*。或者，如果使用 FCM，对应于设备令牌的是*注册 ID*。*设备令牌*或*注册 ID* 是由移动设备的操作系统发送到应用程序的字符串。它唯一标识运行在特定移动设备上的移动应用程序的实例，可以视为此应用程序/设备对的唯一标识符。 Amazon SNS 将凭证（以及其他几个设置）存储为平台应用程序资源。设备令牌（以及一些其他设置）以被称为*平台端点*的对象来表示。每个平台终端节点属于一个特定平台应用程序，可以使用存储在其对应平台应用程序中的凭证与每个平台终端节点进行通信。 下面几节包括每个受支持推送通知服务的先决条件。获得必备信息后，您可以使用 AWS 管理控制台 或 Amazon SNS 移动推送发送推送通知消息。 APIs有关更多信息，请参阅 [使用 Amazon SNS 设置推送通知](sns-mobile-application-as-subscriber.md#sns-user-notifications-process-overview)。 # 创建 Amazon SNS 平台应用程序 要使 Amazon SNS 向移动端点发送通知消息（无论是直接发送还是通过订阅主题），您首先都必须创建平台应用程序。在向 AWS 注册应用程序后，您需要为应用程序和移动设备都创建一个端点。此端点可让 Amazon SNS 向设备发送消息。 **要创建平台应用程序** 1. 登录 [Amazon SNS 控制台](https://console.aws.amazon.com/sns/home)。 1. 在导航窗格中，选择**推送通知**。 1. 在 **Platform applications**（平台应用程序）部分，选择 **Create platform application**（创建平台应用程序）。 1. 选择您的 **AWS 区域**。有关可以在其中创建移动应用程序的 AWS 区域的列表，请参阅[Amazon SNS 移动应用程序支持的区域](sns-mobile-push-supported-regions.md)。 1. 输入以下**应用程序详细信息**： + **应用程序名称** - 提供您的平台应用程序的**名称**。名称长度在 1 到 256 个字符之间，可以包含字母（大写和小写）、数字、连字符、下划线和句号。 + **推送通知平台** - 选择应用程序注册的相应**通知服务**（例如 Apple Push Notification Service (APNs)、Firebase Cloud Messaging (FCM)）。 1. 根据您选择的平台，您需要提供特定凭证： + 对于 **APNs**（Apple Push Notification Service）– 在**基于令牌的身份验证**或**基于证书的身份验证**之间进行选择。 + 对于基于令牌的身份验证，上传 **.p8 文件**（通过 Keychain Access 生成）。 + 对于基于证书的身份验证，上传 **.p12 文件**（也从 Keychain Access 导出）。 + 对于 **FCM**（Firebase Cloud Messaging）– 输入来自 Firebase 控制台的**服务器密钥**。 + 对于**其他平台**（例如 ADM 或 GCM）– 输入相应的 **API 密钥**或凭证。 1. 输入必要的详细信息后，选择**创建平台应用程序**。此操作将该应用程序注册到 Amazon SNS 并创建相应的平台应用程序对象。 1. 创建后，Amazon SNS 会生成并返回一个 [https://docs.aws.amazon.com/sns/latest/api/API_PlatformApplication.html](https://docs.aws.amazon.com/sns/latest/api/API_PlatformApplication.html)（亚马逊资源名称）。此 ARN 可唯一标识您的平台应用程序，用于为移动设备创建端点。 # 为移动通知设置 Amazon SNS 平台端点 当应用程序和移动设备注册推送通知服务（例如 APNs 或 Firebase Cloud Messaging）时，推送通知服务会返回设备令牌。Amazon SNS 使用此设备令牌创建平台端点，该端点充当向设备上的应用程序发送直接推送通知消息的目标。平台端点充当网桥，将 Amazon SNS 发送的消息路由到推送通知服务，然后传输到相应的移动设备。有关更多信息，请参阅[Amazon SNS 用户通知的先决条件](sns-prerequisites-for-mobile-push-notifications.md)和[使用 Amazon SNS 设置推送通知](sns-mobile-application-as-subscriber.md#sns-user-notifications-process-overview)。 ## 了解设备令牌和平台端点 设备令牌唯一标识在推送通知服务（例如，Firebase 云消息）中注册的移动设备。 APNs当应用程序在推送通知服务中注册时，它会生成特定于该应用程序和设备的设备令牌。Amazon SNS 使用此设备令牌在相应的平台应用程序中创建平台端点。 平台端点支持 Amazon SNS 通过推送通知服务向设备发送推送通知消息，从而保持应用程序与用户设备之间的连接。 ## 创建平台终端节点 要使用 Amazon SNS 将通知推送到应用程序，必须先通过调用创建平台终端节点操作，将该应用程序的设备令牌注册到 Amazon SNS。此操作以参数的形式获取平台应用程序的 Amazon Resource Name (ARN) 以及设备令牌，并返回所创建平台终端节点的 ARN。 [https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformEndpoint.html](https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformEndpoint.html) 操作会执行以下操作： + 如果平台端点已存在，则不重新创建。向调用方返回现有平台终端节点的 ARN。 + 如果存在具有相同设备令牌但不同设置的平台端点，则不重新创建。向调用方引发异常。 + 如果平台端点不存在，则创建它。向调用方返回新创建的平台终端节点的 ARN。 您不应在每次应用程序启动时立即调用创建平台终端节点操作，因为此方法并不总是提供正常工作的终端节点。例如，在相同设备上卸载并重新安装了应用程序，并且其终端节点已存在但被禁用时，会出现这种情况。成功的注册过程应该完成以下任务： 1. 确保此应用程序/设备组合存在平台终端节点。 1. 确保平台终端节点中的设备令牌是最新的有效设备令牌。 1. 确保平台终端节点已启用并且已准备好使用。 ## 伪代码 以下伪代码介绍了在各种各样的开始条件中创建正常工作的、当前启用的平台终端节点的推荐做法。不论应用程序是否首次注册、此应用程序的平台终端节点是否已存在、平台终端节点是否已启用、是否具有正确的设备令牌等等，此方法均适用。连续多次调用该方法是安全的，因为它不会创建重复的平台终端节点；如果现有平台终端节点已是最新的并且已启用，也不会更改它。 ``` retrieve the latest device token from the mobile operating system if (the platform endpoint ARN is not stored) # this is a first-time registration call create platform endpoint store the returned platform endpoint ARN endif call get endpoint attributes on the platform endpoint ARN if (while getting the attributes a not-found exception is thrown) # the platform endpoint was deleted call create platform endpoint with the latest device token store the returned platform endpoint ARN else if (the device token in the endpoint does not match the latest one) or (GetEndpointAttributes shows the endpoint as disabled) call set endpoint attributes to set the latest device token and then enable the platform endpoint endif endif ``` 在应用程序希望注册或重新注册自身时，可以随时使用此方法。它还可在向 Amazon SNS 通知设备令牌更改时使用。在这种情况下，只需使用最新的设备令牌值调用操作即可。有关此方法需要说明的几点是： + 在两种情况下可能会调用创建平台终端节点操作。在刚开始时，应用程序不知道自己的平台终端节点 ARN 时可能会调用该方法；这种情况出现在首次注册期间。在初始 `GetEndpointAttributes` 操作失败并返回“未找到”异常时，也会调用该方法；这种情况发生在应用程序知道其端点 ARN 但该 ARN 已被删除时。 + 调用 `GetEndpointAttributes` 操作来验证平台端点的状态，即使刚刚创建了平台端点。平台终端节点已存在但被禁用时会出现这种情况。在这种情况下，创建平台终端节点操作成功，但不启用平台终端节点，因此您必须在返回成功之前仔细检查平台终端节点的状态。 ## AWS SDK 示例 以下代码显示了如何使用提供的 Amazon SNS 客户端来实现之前的伪代码。 AWS SDKs 要使用 S AWS DK，必须使用您的凭据对其进行配置。有关更多信息，请参阅[《工具参考指南》和《*工具参考指南》中的共享配置AWS SDKs 和*凭据文件](https://docs.aws.amazon.com/sdkref/latest/guide/creds-config-files.html)。 ------ #### [ CLI ] **AWS CLI** **创建平台应用程序端点** 以下 `create-platform-endpoint` 示例使用指定令牌为指定平台应用程序创建端点。 ``` aws sns create-platform-endpoint \ --platform-application-arn arn:aws:sns:us-west-2:123456789012:app/GCM/MyApplication \ --token EXAMPLE12345... ``` 输出： ``` { "EndpointArn": "arn:aws:sns:us-west-2:1234567890:endpoint/GCM/MyApplication/12345678-abcd-9012-efgh-345678901234" } ``` ------ #### [ Java ] **适用于 Java 的 SDK 2.x** 还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/sns#code-examples)中查找完整示例，了解如何进行设置和运行。 ``` import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.sns.SnsClient; import software.amazon.awssdk.services.sns.model.CreatePlatformEndpointRequest; import software.amazon.awssdk.services.sns.model.CreatePlatformEndpointResponse; import software.amazon.awssdk.services.sns.model.SnsException; /** * Before running this Java V2 code example, set up your development * environment, including your credentials. * * For more information, see the following documentation topic: * * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html * * In addition, create a platform application using the AWS Management Console. * See this doc topic: * * https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-register.html * * Without the values created by following the previous link, this code examples * does not work. */ public class RegistrationExample { public static void main(String[] args) { final String usage = """ Usage: Where: token - The device token or registration ID of the mobile device. This is a unique identifier provided by the device platform (e.g., Apple Push Notification Service (APNS) for iOS devices, Firebase Cloud Messaging (FCM) for Android devices) when the mobile app is registered to receive push notifications. platformApplicationArn - The ARN value of platform application. You can get this value from the AWS Management Console.\s """; if (args.length != 2) { System.out.println(usage); return; } String token = args[0]; String platformApplicationArn = args[1]; SnsClient snsClient = SnsClient.builder() .region(Region.US_EAST_1) .build(); createEndpoint(snsClient, token, platformApplicationArn); } public static void createEndpoint(SnsClient snsClient, String token, String platformApplicationArn) { System.out.println("Creating platform endpoint with token " + token); try { CreatePlatformEndpointRequest endpointRequest = CreatePlatformEndpointRequest.builder() .token(token) .platformApplicationArn(platformApplicationArn) .build(); CreatePlatformEndpointResponse response = snsClient.createPlatformEndpoint(endpointRequest); System.out.println("The ARN of the endpoint is " + response.endpointArn()); } catch (SnsException e) { System.err.println(e.awsErrorDetails().errorMessage()); } } } ``` ------ 有关更多信息，请参阅 [移动推送 API 操作](mobile-push-api.md)。 ## 问题排查 ### 使用过期设备令牌重复调用创建平台终端节点操作 特别是对于 FCM 端点，您可能会认为最好是存储应用程序发布的第一个设备令牌，然后在每次应用程序启动时，使用该设备令牌调用创建平台端点操作。这似乎正确，因为它会使得应用程序无需管理设备令牌的状态，Amazon SNS 自动将设备令牌更新为其最新值。但是，此解决方案存在多个严重问题： + Amazon SNS 依靠 FCM 的反馈将失效的设备令牌更新为新的设备令牌。FCM 会将旧设备令牌的相关信息保留一段时间，但并非无限期保留。FCM 忘掉旧设备令牌与新设备令牌之间的联系之后，Amazon SNS 无法再将存储在平台终端节点中的设备令牌更新为其正确值，而只是改为禁用平台终端节点。 + 平台应用程序将包含与同一个设备令牌对应的多个平台终端节点。 + Amazon SNS 对使用相同设备令牌创建的平台终端节点数量施加了配额。最终，新终端节点的创建将会失败，引发无效参数异常并显示以下错误消息：“此终端节点已注册到其他令牌。” 有关管理 FCM 端点的更多信息，请参阅 [Amazon SNS 管理 Firebase Cloud Messaging 端点](sns-fcm-endpoint-management.md)。 ### 重新启用与无效设备令牌关联的平台终端节点 当移动平台（例如 APNs 或 FCM）通知 Amazon SNS 发布请求中使用的设备令牌无效时，Amazon SNS 将禁用与该设备令牌关联的平台终端节点。然后，Amazon SNS 将拒绝向该设备令牌进行的后续发布操作。虽然您可能会认为最好的方法是简单地重新启用平台终端节点并保持发布，但大多数情况下这样做不会有成效：发布的消息不会被传输，平台终端节点随后很快会再次被禁用。 这是因为与平台终端节点关联的设备令牌已真正无效。由于它不再对应于任何已安装的应用程序，因此以它为目标的传输操作不会成功。下次发布到该平台终端节点时，移动平台将再次通知 Amazon SNS 设备令牌无效，Amazon SNS 将再次禁用该平台终端节点。 要重新启用已禁用的平台终端节点，该终端节点需要关联到有效的设备令牌（使用设置终端节点属性操作调用），然后再启用。只有这样，以该平台终端节点为目标的传输操作才会成功。要在不更新设备令牌的情况下重新启用平台终端节点，这种方法只有当与终端节点关联的设备令牌曾经无效但重新变得有效时才有起作用。例如，在相同移动设备上卸载、然后重新安装了某个应用程序并收到了相同的设备令牌时，会出现这种情况。上述方法会执行此操作，确保只有在验证与某个平台终端节点关联的设备令牌是最新可用的设备令牌时，才重新启用该平台终端节点。 # 将设备令牌与 Amazon SNS 集成以发送移动通知 当您首次使用通知服务（例如 Apple 推送通知服务 (APNs) 和 Firebase Cloud Messaging (FCM)）注册应用程序和移动设备时，该服务会返回设备令牌或注册 IDs 信息。 tokens/IDs 它们将添加到 Amazon SNS 中，以便使用 API 为应用程序和设备创建终端节点。[https://docs.aws.amazon.com/sns/latest/api/API_PlatformApplication.html](https://docs.aws.amazon.com/sns/latest/api/API_PlatformApplication.html)端点创建完成后，系统会返回一个 [https://docs.aws.amazon.com/sns/latest/api/API_Endpoint.html](https://docs.aws.amazon.com/sns/latest/api/API_Endpoint.html)，Amazon SNS 就会使用它将通知发送到对应的应用程序或设备。 您可以通过以下方式向 Amazon SNS 添加设备令牌或注册 IDs ： + 通过手动添加单个令牌 AWS 管理控制台 + 使用 [https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformEndpoint.html](https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformEndpoint.html) API 上传多个令牌 + 为未来的设备注册令牌 ****手动添加设备令牌或注册 ID**** 1. 登录 [Amazon SNS 控制台](https://console.aws.amazon.com/sns/home)。 1. 在导航窗格中，选择**推送通知**。 1. 在**平台应用程序**部分，选择您的应用程序，然后选择**编辑**。如果您尚未创建平台应用程序，请按照[创建 Amazon SNS 平台应用程序](mobile-push-send-register.md)指南立即创建。 1. 选择**创建端点**。 1. 在**Endpoint Token**（端点令牌）框中，输入**令牌**或**注册 ID**，具体取决于您使用的通知服务（例如，FCM 注册 ID）。 1. （可选）在 **User Data**（用户数据）字段中输入其他数据。数据必须采用 UTF-8 编码并且小于 2KB。 1. 选择**创建端点**。 创建了端点后，您可以直接向移动设备发送消息，也可以向订阅了某一 Amazon SNS 主题的移动设备发送消息。 ****使用 `CreatePlatformEndpoint` API 上传多个令牌**** 以下步骤说明如何使用提供的示例 Java 应用程序（`bulkupload`软件包）将多个令牌（设备令牌或注册 IDs）上传 AWS 到 Amazon SNS。您可以使用本示例应用帮助您开始上传现有令牌。 **注意** 下面的步骤使用 Eclipse Java IDE。这些步骤假设您已安装 适用于 Java 的 AWS SDK 并且拥有自己的 AWS 安全证书 AWS 账户。有关更多信息，请参阅 [适用于 Java 的 AWS SDK](https://aws.amazon.com/sdkforjava/)。有关更多信息，请参阅《IAM 用户指南》**中的 [AWS 安全性凭证](https://docs.aws.amazon.com/general/latest/gr/getting-aws-sec-creds.html)。 1. 下载并解压缩 [snsmobilepush.zip](samples/snsmobilepush.zip) 文件。 1. 在 Eclipse 中创建一个新的 **Java 项目**，然后将 `SNSSamples` 文件夹导入到该项目中。 1. 下载 [OpenCSV 库](http://sourceforge.net/projects/opencsv/)，并添加到生成路径中。 1. 在 `BulkUpload.properties` 文件中，指定以下项： + 您的 `ApplicationArn`（平台应用程序 ARN）。 + 包含令牌的 CSV 文件的绝对路径。 + 记录成功和失败令牌的文件名。例如，`goodTokens.csv` 和 `badTokens.csv`。 + （可选）用于设置分隔符、引用字符以及线程数量的配置。 完成后的 `BulkUpload.properties` 与下文类似： ``` applicationarn: arn:aws:sns:us-west-2:111122223333:app/FCM/fcmpushapp csvfilename: C:\\mytokendirectory\\mytokens.csv goodfilename: C:\\mylogfiles\\goodtokens.csv badfilename: C:\\mylogfiles\\badtokens.csv delimiterchar: ',' quotechar: '"' numofthreads: 5 ``` 1. 运行 **BatchCreatePlatformEndpointSample.java** 应用程序将令牌上传到亚马逊 SNS。成功上传的令牌将记录在 `goodTokens.csv` 中，而格式错误的令牌将记录在 `badTokens.csv` 中。 **为未来的应用程序安装注册设备令牌** 您可以通过以下两个选项来执行此操作： **使用 Amazon Cognito 服务** 您的移动应用程序可以使用临时安全凭证来创建端点。建议使用 Amazon Cognito 来生成临时凭证。有关更多信息，请参阅 *[Amazon Cognito 开发人员指南](https://docs.aws.amazon.com/cognito/latest/developerguide/)*。 要跟踪应用程序[注册](application-event-notifications.md)，请在创建新的 ARNs 终端节点时使用 Amazon SNS 事件接收通知。 或者，您可以使用 [https://docs.aws.amazon.com/sns/latest/api/API_ListEndpointsByPlatformApplication.html](https://docs.aws.amazon.com/sns/latest/api/API_ListEndpointsByPlatformApplication.html) API 检索已注册的端点列表。 **使用代理服务器** 如果您的应用程序基础架构已支持在安装时注册设备，则可以将服务器用作代理。它将通过 [https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformEndpoint.html](https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformEndpoint.html) API 将设备令牌转发给 Amazon SNS。 Amazon SNS 创建的端点 ARN 将被返回，并可由您的服务器存储起来，以便未来发布消息时使用。 # Amazon SNS Apple 推送通知身份验证方法 您可以通过提供将您识别为应用程序开发人员的信息，授权 Amazon SNS 将推送通知发送到您的 iOS 或 macOS 应用程序。要进行身份验证，请[在创建平台应用程序时](https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html)提供*密钥*或者*证书*，您可以通过 Apple 开发人员账户获得这两项。 **令牌签名密钥** Amazon SNS 用于签署 Apple 推送通知服务 (APNs) 身份验证令牌的私有签名密钥。 如果您提供签名密钥，Amazon SNS 将使用令牌对您发送 APNs的每条推送通知进行身份验证。使用您的签名密钥，您可以向 APNs 生产环境和沙盒环境发送推送通知。 您的签名密钥不会过期，您可以将相同的签名密钥用于多个应用程序。有关更多信息，请参阅 Apple 网站 “**开发者账户帮助**” 部分中的[ APNs 使用身份验证令牌进行通信](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_token-based_connection_to_apns)。 **证书** 在您发送推送通知 APNs 时，Amazon SNS 使用它进行身份验证的 TLS 证书。您可以从 Apple 开发人员账户获取该证书。 证书将在一年后过期。出现这种情况时，您必须创建新证书并将其提供给 Amazon SNS。有关更多信息，请参阅 Apple 开发者网站 APNs上的[与建立基于证书的连接](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_certificate-based_connection_to_apns)。 **使用管理控制台 AWS 管理 APNs 设置** 1. 登录 [Amazon SNS 控制台](https://console.aws.amazon.com/sns/home)。 1. 在导航窗格中，选择**推送通知**。 1. 在**平台应用程序**部分，选择要编辑其 APNs 设置的**应用程序**，然后选择**编辑**。如果您尚未创建平台应用程序，请按照[创建 Amazon SNS 平台应用程序](mobile-push-send-register.md)指南立即创建。 1. 选择**编辑**以修改平台应用程序的设置。 1. 在**身份验证类型**部分，选择下列选项之一： + **基于令牌的身份验证**（建议用于现代 APNs 集成） + **基于证书的身份验证**（旧方法） 1. 根据身份验证类型配置您的**凭证**： + **基于令牌的身份验证**： + 上传 **.p8 文件**，这是您从 Apple 开发者帐户下载的身份验证令牌签名密钥。 + 输入**签名密钥 ID**，您可以在 Apple 开发者账户中找到它。导航到 “**证书**” **IDs、“配置文件**”、“**密钥**”，然后选择要使用的**密**钥。 + 提供 Apple 开发人员账户中的**团队标识符**。可以在“会员资格”页面上找到此值。 + 输入分配给您的应用程序的**捆绑标识符**。您可以在 “证书” IDs 和 “配置文件”、“应用程序” 下找到此信息 IDs。 + **基于证书的身份验证：** + 上传您的 TLS 证书的 **.p12 文件**。当您从 Apple 开发人员账户下载证书之后，可以在 macOS 上从 Keychain Access 导出此文件。 + 如果您的 .p12 证书设置了**密码**，在这里输入它。 1. 输入必要的凭证后，选择**保存更改**以更新设置。 # Amazon SNS 与 Firebase Cloud Messaging 身份验证设置集成 本主题介绍如何从 Google 获取用于该 API 所需的 FCM API (HTTP v1) 凭据， AWS CLI 以及。 AWS AWS 管理控制台 **重要** 2024 年 3 月 26 日 – Amazon SNS 支持适用于 Apple 设备和 Webpush 目的地的 FCM HTTP v1 API。我们建议您在 2024 年 6 月 1 日或之前将现有的移动推送应用程序迁移到最新的 FCM HTTP v1 API，以避免应用程序中断。 2024 年 1 月 18 日 – Amazon SNS 推出了对 FCM HTTP v1 API 的支持，用于向 Android 设备发送移动推送通知。 2023 年 6 月 20 日 - Google 弃用了其 Firebase Cloud Messaging（FCM）旧版 HTTP API。Amazon SNS 现在支持使用 FCM HTTP v1 API 向所有设备类型传送。我们建议您在 2024 年 6 月 1 日或之前将现有的移动推送应用程序迁移到最新的 FCM HTTP v1 API，以避免中断。 您可以通过提供将您识别为应用程序开发人员的信息，授权 Amazon SNS 将推送通知发送到您的应用程序。要进行身份验证，请在[创建平台应用程序时](https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html)提供 **API 密钥**或**令牌**。您可以从 [Firebase 应用程序控制台](https://firebase.google.com/?gad=1&gclid=CjwKCAiA0syqBhBxEiwAeNx9N27M7zxHjlS74_gp4mAS4QTMQH5J35sTO29od-yauuq259zzX_I2DRoCrbsQAvD_BwE&gclsrc=aw.ds)获取以下信息： **API 密钥** API 密钥是调用 Firebase 的旧版 API 时使用的凭证。谷歌 APIs 将于2024年6月20日移除FCM Legacy。如果您当前使用 API 密钥作为平台凭证，则可以通过选择**令牌**作为选项并上传您的 Firebase 应用程序的关联 JSON 文件来更新平台凭证。 **令牌** 在调用 HTTP v1 API 时，会使用有效期很短的访问令牌。这是 Firebase 的建议用于发送推送通知的 API。为了生成访问令牌，Firebase 以私有密钥文件（也称为 service.json 文件）的形式为开发人员提供了一组凭证。 ## 先决条件 您必须先获取 FCM service.json 凭证，然后才能开始在 Amazon SNS 中管理 FCM 设置。要获取您的 service.json 凭据，请参阅谷歌 Firebase 文档中的[从旧版 FCM 迁移 APIs 到 HTTP v1](https://firebase.google.com/docs/cloud-messaging/migrate-v1)。 ## 使用 CLI 管理 FCM 设置 您可以使用 AWS API 创建 FCM 推送通知。一个 AWS 账户中 Amazon SNS 资源的数量和大小是有限的。有关更多信息，请参阅《AWS 一般参考 Guide》**中的 [Amazon Simple Notification Service endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html)。 **创建 FCM 推送通知以及亚马逊 SNS 主题AWS (API)** 使用**密钥**凭证时，`PlatformCredential` 为 `API key`。使用**令牌**凭证时，`PlatformCredential` 为一个采用 JSON 格式的私有密钥文件： + [https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html](https://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html) **检索现有亚马逊 SNS 主题 (API) 的 FCM 凭证类型AWS** 检索凭证类型 `"AuthenticationMethod": "Token"` 或 ` "AuthenticationMethod": "Key"`： + [GetPlatformApplicationAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetPlatformApplicationAttributes.html) **为现有亚马逊 SNS 主题AWS (API) 设置 FCM 属性** 设置 FCM 属性： + [SetPlatformApplicationAttributes](https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html) ## 使用控制台管理 FCM 设置 您可以使用 AWS Command Line Interface (CLI) 创建 FCM 推送通知。一个 AWS 账户中 Amazon SNS 资源的数量和大小是有限的。有关更多信息，请参阅 [Amazon Simple Notification Service endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html)。 **与 Amazon SNS 主题一起创建 FCM 推送通知（AWS CLI）** 使用**密钥**凭证时，`PlatformCredential` 为 `API key`。使用**令牌**凭证时，`PlatformCredential` 为一个采用 JSON 格式的私有密钥文件。使用 AWS CLI 时，文件必须为字符串格式，并且必须忽略特殊字符。为了正确格式化文件，Amazon SNS 建议使用以下命令：`SERVICE_JSON=`jq @json <<< cat service.json``： + [create-platform-application](https://docs.aws.amazon.com/cli/latest/reference/sns/create-platform-application.html) **检索现有 Amazon SNS 主题的 FCM 凭证类型（AWS CLI）** 检索凭证类型 `"AuthenticationMethod": "Token"` 或 ` "AuthenticationMethod": "Key"`： + [get-platform-application-attributes](https://docs.aws.amazon.com/cli/latest/reference/sns/get-platform-application-attributes.html) **为现有 Amazon SNS 主题设置 FCM 属性（AWS CLI）** 设置 FCM 属性： + [set-platform-application-attributes](https://docs.aws.amazon.com/cli/latest/reference/sns/set-platform-application-attributes.html) ## 管理 FCM 设置（控制台） 按照以下步骤在 Amazon SNS 中输入和管理您的 Firebase Cloud Messaging（FCM）凭证。 1. 登录 [Amazon SNS 控制台](https://console.aws.amazon.com/sns/home)。 1. 在导航窗格中，选择**推送通知**。 1. 在**平台应用程序**部分，选择要编辑其凭证的 **FCM 平台应用程序**，然后选择**编辑**。 1. 在 **Firebase Cloud Messaging 凭证**部分，选择以下选项之一： + **基于令牌的身份验证**（推荐方法）：上传您从 Firebase 控制台下载的**私钥文件**（JSON）。此文件包含用于生成发送 FCM 通知所需的短期访问令牌的凭证。要获取此文件，请执行以下操作： 1. 前往您的 [Firebase 应用程序控制台](https://firebase.google.com/?gad=1&gclid=CjwKCAiA0syqBhBxEiwAeNx9N27M7zxHjlS74_gp4mAS4QTMQH5J35sTO29od-yauuq259zzX_I2DRoCrbsQAvD_BwE&gclsrc=aw.ds)。 1. 在**项目设置**中，选择**云消息传递**。 1. 下载**私钥** JSON 文件（用于基于令牌的身份验证方法）。 + **API 密钥身份验证** – 如果您更喜欢使用较旧的 API 密钥身份验证方法，请在提供的字段中输入 **Google API 密钥**。要获取此文件，请执行以下操作： 1. 前往您的 [Firebase 应用程序控制台](https://firebase.google.com/?gad=1&gclid=CjwKCAiA0syqBhBxEiwAeNx9N27M7zxHjlS74_gp4mAS4QTMQH5J35sTO29od-yauuq259zzX_I2DRoCrbsQAvD_BwE&gclsrc=aw.ds)。 1. 在**项目设置**中，选择**云消息传递**。 1. 复制用于发送通知的**服务器密钥**（API 密钥）。 1. 完成后，选择**保存更改**。 **相关主题** + [在 Amazon SNS 中使用 Google Firebase Cloud Messaging v1 有效载荷](sns-fcm-v1-payloads.md) # Amazon SNS 管理 Firebase Cloud Messaging 端点 ## 管理和维护设备令牌 您可以按照以下步骤确保移动应用程序的推送通知的可送达性： 1. 将所有设备令牌、相应的 Amazon SNS 终端节点 ARNs和时间戳存储在您的应用程序服务器上。 1. 移除所有陈旧的令牌并删除相应的 Amazon SNS ARNs 终端节点。 应用程序首次启动后，您将收到该设备的设备令牌（也称为注册令牌）。此设备令牌由设备的操作系统创建，并与您的 FCM 应用程序相关联。收到此设备令牌后，您可以将其作为平台端点注册到 Amazon SNS。我们建议您存储设备令牌、Amazon SNS 平台端点 ARN 和时间戳，方法是将它们保存到您的应用程序服务器或其他永久存储中。要设置 FCM 应用以检索和存储设备令牌，请参阅 Google 的 *Firebase* 文档中的[检索和存储注册令牌](https://firebase.google.com/docs/cloud-messaging/manage-tokens#retrieve-and-store-registration-tokens)。 维护 up-to-date代币很重要。如果满足以下条件，用户的设备令牌可以更改： 1. 移动应用程序将在新设备上恢复。 1. 用户卸载或更新应用程序。 1. 用户清除应用程序数据。 当您的设备令牌发生变化时，我们建议您使用新令牌更新相应的 Amazon SNS 端点。这样，Amazon SNS 就可以继续与注册的设备进行通信。您可以通过在移动应用程序中实现以下伪代码来做到这一点。它描述了创建和维护已启用的平台端点的推荐做法。这种方法可以在每次移动应用程序启动时执行，也可以在后台作为计划任务执行。 ### 伪代码 使用以下 FCM 伪代码管理和维护设备令牌。 ``` retrieve the latest token from the mobile OS if (endpoint arn not stored) # first time registration call CreatePlatformEndpoint store returned endpoint arn endif call GetEndpointAttributes on the endpoint arn if (getting attributes encountered NotFound exception) #endpoint was deleted call CreatePlatformEndpoint store returned endpoint arn else if (token in endpoint does not match latest) or (GetEndpointAttributes shows endpoint as disabled) call SetEndpointAttributes to set the latest token and enable the endpoint endif endif ``` 要详细了解令牌更新要求，请参阅 Google 的 *Firebase* 文档中的[定期更新令牌](https://firebase.google.com/docs/cloud-messaging/manage-tokens#update-tokens-on-a-regular-basis)。 ## 检测令牌无效 当向带有无效设备令牌的 FCM v1 端点发送消息时，Amazon SNS 将收到以下例外情况之一： + `UNREGISTERED`（HTTP 404）– 当 Amazon SNS 收到此异常时，您将收到一个传输失败事件，该事件的 `FailureType` 为 `InvalidPlatformToken`，且 `FailureMessage` 为*与端点关联的平台令牌无效*。当传送失败时，Amazon SNS 将禁用您的平台端点，但有此例外情况。 + `INVALID_ARGUMENT`（HTTP 400）– 当 Amazon SNS 收到此异常时，这意味着设备令牌或消息有效载荷无效。有关更多信息，请参阅[ErrorCode](https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode)谷歌的 *Firebase* 文档。 由于在这两种情况下都可以返回 `INVALID_ARGUMENT`，因此 Amazon SNS 将返回 `InvalidNotification` `FailureType` 以及*通知正文无效* `FailureMessage`。当您收到此错误时，请验证您的有效载荷是否正确。如果正确，请验证设备令牌是否正确 up-to-date。当传送失败时，Amazon SNS 不会禁用您的平台端点，但有此例外情况。 您会遇到 `InvalidPlatformToken` 传送失败事件的另一种情况是，注册的设备令牌不属于尝试发送该消息的应用程序。在这种情况下，Google 将返回 *SENDER\$1ID\$1MISMATCH* 错误。当传送失败时，Amazon SNS 将禁用您的平台端点，但有此例外情况。 当您为应用程序设置[交付状态日志 CloudWatch](topics-attrib.md)时，可以查看从 FCM v1 API 收到的所有观察到的错误代码。 要接收应用程序的传送事件，请参阅[可用应用程序事件](application-event-notifications.md#application-event-notifications-events)。 ## 移除过时令牌 一旦向端点设备传送消息开始失败，令牌就会被视为过时。Amazon SNS 将这些过时令牌设置为您的平台应用程序的禁用端点。当您向已禁用的端点发布内容时，Amazon SNS 将返回一个 `EventDeliveryFailure` 事件，该事件的 `FailureType` 为 `EndpointDisabled`，`FailureMessage` 为*端点处于禁用状态*。要接收应用程序的传送事件，请参阅[可用应用程序事件](application-event-notifications.md#application-event-notifications-events)。 当您收到来自 Amazon SNS 的此错误时，您需要移除或更新平台应用程序中的过时令牌。