中文网
Nodejs.cn 旗下网站
首页指南EAS参考教程

使用 FCM 和 APN 发送通知

了解如何使用 FCM 和 APN 发送通知。

你可能需要对通知进行更细粒度的控制，在这种情况下，可能需要直接与 FCM 和 APNs 通信。Expo 平台不会限制你使用 Expo 应用服务，expo-notifications API 与推送服务无关。

¥You may need finer-grained control over your notifications, in which case communicating directly with FCM and APNs may be necessary. The Expo platform does not lock you into using Expo Application Services, and the expo-notifications API is push-service agnostic.

注意：本指南并非旨在成为通过 FCM 或 APN 发送通知的综合资源。我们建议你阅读官方文档以确保你遵循最新的说明。

¥Note: This guide does not aim to be a comprehensive resource for sending notifications via FCM or APNs. We recommend you read the official documentation to make sure you're following the latest instructions.

获取 FCM 或 APN 的设备令牌

¥Obtaining a device token for FCM or APNs

使用 Expo 通知服务时，你使用通过 getExpoPushTokenAsync 获得的 ExpoPushToken。

¥When using Expo notification service, you use the ExpoPushToken obtained with getExpoPushTokenAsync.

如果你希望通过 FCM 或 APNs 发送通知，则需要使用 getDevicePushTokenAsync 获取原生设备令牌。

¥If you instead want to send notifications via FCM or APNs, you need to obtain the native device token with getDevicePushTokenAsync.

import * as Notifications from 'expo-notifications';
...
- const token = (await Notifications.getExpoPushTokenAsync()).data;
+ const token = (await Notifications.getDevicePushTokenAsync()).data;
// send token to your server

FCMv1 服务器

¥FCMv1 server

本指南基于 Firebase 官方文档。

¥This guide is based on Firebase official documentation.

与 FCM 的通信是通过发送 POST 请求来完成的。但是，在发送或接收任何通知之前，你需要按照 配置 FCM 的步骤操作并获取你的 FCM-SERVER-KEY。

¥Communicating with FCM is done by sending a POST request. However, before sending or receiving any notifications, you'll need to follow the steps to configure FCM and get your FCM-SERVER-KEY.

获取身份验证令牌

¥Getting an authentication token

FCM 需要 Oauth 2.0 访问令牌，必须通过 "更新发送请求的授权" 中描述的方法之一获取。

¥FCM requires an Oauth 2.0 access token, which must be obtained via one of the methods described in "Update authorization of send requests".

出于测试目的，你可以使用 Google Auth 库和上面获得的私钥文件来获取单个通知的短期令牌，如从 Firebase 文档改编的此 Node 示例所示：

¥For testing purposes, you can use the Google Auth Library and your private key file obtained above, to obtain a short lived token for a single notification, as in this Node example adapted from Firebase documentation:

import { JWT } from 'google-auth-library';

function getAccessTokenAsync(
  key: string // Contents of your FCM private key file
) {
  return new Promise(function (resolve, reject) {
    const jwtClient = new JWT(
      key.client_email,
      null,
      key.private_key,
      ['https://www.googleapis.com/auth/cloud-platform'],
      null
    );
    jwtClient.authorize(function (err, tokens) {
      if (err) {
        reject(err);
        return;
      }
      resolve(tokens.access_token);
    });
  });
}

发送通知

¥Sending the notification

下面的示例代码调用上面的 getAccessTokenAsync() 来获取 Oauth 2.0 令牌，然后构造并发送通知 POST 请求。请注意，与 FCM 旧协议不同，请求的端点包含你的 Firebase 项目的名称。

¥The example code below calls getAccessTokenAsync() above to get the Oauth 2.0 token, then constructs and sends the notification POST request. Note that unlike FCM legacy protocol, the endpoint for the request includes the name of your Firebase project.

// FCM_SERVER_KEY: Environment variable with the path to your FCM private key file
// FCM_PROJECT_NAME: Your Firebase project name
// FCM_DEVICE_TOKEN: The client's device token (see above in this document)

async function sendFCMv1Notification() {
  const key = require(process.env.FCM_SERVER_KEY);
  const firebaseAccessToken = await getAccessTokenAsync(key);
  const deviceToken = process.env.FCM_DEVICE_TOKEN;

  const messageBody = {
    message: {
      token: deviceToken,
      data: {
        channelId: 'default',
        message: 'Testing',
        title: `This is an FCM notification message`,
        body: JSON.stringify({ title: 'bodyTitle', body: 'bodyBody' }),
        scopeKey: '@yourExpoUsername/yourProjectSlug',
        experienceId: '@yourExpoUsername/yourProjectSlug',
      },
    },
  };

  const response = await fetch(
    `https://fcm.googleapis.com/v1/projects/${process.env.FCM_PROJECT_NAME}/messages:send`,
    {
      method: 'POST',
      headers: {
        Authorization: `Bearer ${firebaseAccessToken}`,
        Accept: 'application/json',
        'Accept-encoding': 'gzip, deflate',
        'Content-Type': 'application/json',
      },
      body: JSON.stringify(messageBody),
    }
  );

  const readResponse = (response: Response) => response.json();
  const json = await readResponse(response);

  console.log(`Response JSON: ${JSON.stringify(json, null, 2)}`);
}

experienceId 和 scopeKey 字段仅在使用 Expo Go 时适用（从 SDK 53 开始，Expo Go 不再支持推送通知）。否则，你的通知将不会发送到你的应用。FCM 在 通知负载 中有一个支持的字段列表，你可以通过查看 FirebaseRemoteMessage 来了解 Android 上的 expo-notifications 支持哪些字段。

¥The experienceId and scopeKey fields are only applicable when using Expo Go (from SDK 53, push notifications support is removed from Expo Go). Otherwise, your notifications will not go through to your app. FCM has a list of supported fields in the notification payload, and you can see which ones are supported by expo-notifications on Android by looking at the FirebaseRemoteMessage.

FCM 还提供了一些你可以使用的 几种不同语言的服务器端库，而不是原始 fetch 请求。

¥FCM also provides some server-side libraries in a few different languages you can use instead of raw fetch requests.

如何查找 FCM 服务器密钥

¥How to find FCM server key

你可以通过确保遵循 配置步骤 来找到你的 FCM 服务器密钥，并且无需将 FCM 密钥上传到 Expo，而是直接在服务器中使用该密钥（如上例中的 FCM-SERVER-KEY）。

¥Your FCM server key can be found by making sure you've followed the configuration steps, and instead of uploading your FCM key to Expo, you would use that key directly in your server (as the FCM-SERVER-KEY in the previous example).

APNs 服务器

¥APNs server

本文档基于 苹果的文档，本节介绍了帮助你入门的基础知识。

与 APN 的通信比与 FCM 的通信稍微复杂一些。有些库将所有这些功能封装到一两个函数调用中，例如 node-apn。但是，在下面的示例中，使用了最少的库集。

¥Communicating with APNs is a little more complicated than with FCM. Some libraries wrap all of this functionality into one or two function calls such as node-apn. However, in the examples below, a minimum set of libraries are used.

授权

¥Authorization

最初，在向 APNS 发送请求之前，你需要获得向应用发送通知的权限。这是通过使用 iOS 开发者凭据生成的 JSON Web 令牌授予的：

¥Initially, before sending requests to APNS, you need permission to send notifications to your app. This is granted via a JSON web token which is generated using iOS developer credentials:

  • 与你的应用关联的 APN 密钥（.p8 文件）

    ¥APN key (.p8 file) associated with your app

  • 上述 .p8 文件的密钥 ID

    ¥Key ID of the above .p8 file

  • 你的 Apple 团队 ID

    ¥Your Apple Team ID

const jwt = require("jsonwebtoken");
const authorizationToken = jwt.sign(
  {
    iss: "YOUR-APPLE-TEAM-ID"
    iat: Math.round(new Date().getTime() / 1000),
  },
  fs.readFileSync("./path/to/appName_apns_key.p8", "utf8"),
  {
    header: {
      alg: "ES256",
      kid: "YOUR-P8-KEY-ID",
    },
  }
);

HTTP/2 连接

¥HTTP/2 connection

获得 authorizationToken 后，你可以打开与 Apple 服务器的 HTTP/2 连接。在开发中，向 api.sandbox.push.apple.com 发送请求。在生产中，将请求发送到 api.push.apple.com。

¥After getting the authorizationToken, you can open up an HTTP/2 connection to Apple's servers. In development, send requests to api.sandbox.push.apple.com. In production, send requests to api.push.apple.com.

以下是构建请求的方法：

¥Here's how to construct the request:

const http2 = require('http2');

const client = http2.connect(
  IS_PRODUCTION ? 'https://api.push.apple.com' : 'https://api.sandbox.push.apple.com'
);

const request = client.request({
  ':method': 'POST',
  ':scheme': 'https',
  'apns-topic': 'YOUR-BUNDLE-IDENTIFIER',
  ':path': '/3/device/' + nativeDeviceToken, // This is the native device token you grabbed client-side
  authorization: `bearer ${authorizationToken}`, // This is the JSON web token generated in the "Authorization" step
});
request.setEncoding('utf8');

request.write(
  JSON.stringify({
    aps: {
      alert: {
        title: "📧 You've got mail!",
        body: 'Hello world! 🌐',
      },
    },
    experienceId: '@yourExpoUsername/yourProjectSlug', // Required when testing in the Expo Go app
    scopeKey: '@yourExpoUsername/yourProjectSlug', // Required when testing in the Expo Go app
  })
);
request.end();

此示例是最小的，不包含错误处理和连接池。出于测试目的，你可以参考 sendNotificationToAPNS 示例代码。

¥This example is minimal and includes no error handling and connection pooling. For testing purposes, you can refer to sendNotificationToAPNS example code.

APNs 在 通知负载 中提供了受支持字段的完整列表。

¥APNs provide their full list of supported fields in the notification payload.