在 Ionic + Angular 应用中使用 Firebase 推送通知

Web 框架： Angular 平台： iOS、Android

应用开发者向其用户提供的最常见功能之一就是推送通知。在本教程中，我们将逐步介绍让 Firebase Cloud Messaging 在 iOS 和 Android 上正常工作所需的所有步骤。

为了注册和监听来自 Firebase 的推送通知，我们将在 Ionic + Angular 应用中使用 Capacitor 的推送通知 API。

必需的依赖项

使用 Capacitor 构建和部署 iOS 及 Android 应用需要一些设置。在继续之前，请按照说明安装必要的 Capacitor 依赖项。

要在 iOS 上测试推送通知，Apple 要求您拥有付费的 Apple Developer 帐户和一台实体 iOS 设备。

如果您遇到问题或您的控制台抛出有关过时或弃用包的警告，请确保您使用的是 Node、Android Studio 和 Xcode 的最新稳定版本。

此外，我们使用 Firebase 进行推送通知，因此如果您使用其他使用 Firebase SDK 的 Cordova 插件，请确保它们使用的是最新版本。

准备 Ionic Capacitor 应用

如果您有现有的 Ionic 应用，请跳过此部分。如果没有，让我们先创建一个 Ionic 应用。

在您喜欢的终端中，安装最新版本的 Ionic CLI：

npm install -g @ionic/cli

接下来，让我们使用 CLI 基于 blank 启动模板创建一个新的 Ionic Angular 应用，并将其命名为 capApp：

ionic start capApp blank --type=angular

在提示将您的新应用与 Capacitor 集成时，输入 y 并按回车。这将把 Capacitor 和 Capacitor CLI 添加到我们的新应用中。

应用创建成功后，切换到新创建的项目目录：

cd capApp/

最后运行 npx cap init，这将允许我们填写应用信息。

npx cap init
? App name: CapApp
? App Package ID: com.mydomain.myappname

构建应用并添加平台

在此项目中添加任何原生平台之前，必须至少构建应用一次。Web 构建会创建 Capacitor 所需的 Web 资源目录（Ionic Angular 项目中为 www 文件夹）。

ionic build

接下来，让我们为应用添加 iOS 和 Android 平台。

npx cap add ios
npx cap add android

运行这些命令后，会在项目根目录创建 android 和 ios 文件夹。这些是完全独立的原生项目资产，应被视为 Ionic 应用的一部分（即纳入源代码管理）。

使用 Capacitor 推送通知 API

首先，我们需要安装 Capacitor 推送通知插件。

npm install @capacitor/push-notifications
npx cap sync

然后，在开始使用 Firebase 之前，我们需要确保我们的应用能够通过使用 Capacitor 推送通知 API 注册推送通知。我们还会添加一个 alert（您也可以使用 console.log 语句）来在通知到达且应用在设备上打开时显示通知的负载。

在您的应用中，进入 home.page.ts 文件，添加 import 语句和 const 以使用 Capacitor Push API：

import {
  ActionPerformed,
  PushNotificationSchema,
  PushNotifications,
  Token,
} from '@capacitor/push-notifications';

然后，添加 ngOnInit() 方法，其中包含一些注册和监听推送通知的 API 方法。我们还将添加 alert() 到几个事件中以监控正在发生的事情：

export class HomePage implements OnInit {

ngOnInit() {
    console.log('正在初始化 HomePage');

    // 请求使用推送通知的权限
    // iOS 将提示用户并返回是否授予权限
    // Android 将直接授予而不提示
    PushNotifications.requestPermissions().then(result => {
      if (result.receive === 'granted') {
        // 向 Apple/Google 注册以通过 APNS/FCM 接收推送
        PushNotifications.register();
      } else {
        // 显示一些错误信息
      }
    });

    // 成功后，我们应该能够接收通知
    PushNotifications.addListener('registration',
      (token: Token) => {
        alert('推送注册成功，token：' + token.value);
      }
    );

    // 设置存在问题，推送将无法工作
    PushNotifications.addListener('registrationError',
      (error: any) => {
        alert('注册错误：' + JSON.stringify(error));
      }
    );

    // 如果应用在设备上打开，显示通知负载
    PushNotifications.addListener('pushNotificationReceived',
      (notification: PushNotificationSchema) => {
        alert('收到推送：' + JSON.stringify(notification));
      }
    );

    // 点击通知时调用的方法
    PushNotifications.addListener('pushNotificationActionPerformed',
      (notification: ActionPerformed) => {
        alert('推送操作已执行：' + JSON.stringify(notification));
      }
    );
}

以下是 home.page.ts 的完整实现：

import { Component, OnInit } from '@angular/core';

import {
  ActionPerformed,
  PushNotificationSchema,
  PushNotifications,
  Token,
} from '@capacitor/push-notifications';

@Component({
  selector: 'app-home',
  templateUrl: 'home.page.html',
  styleUrls: ['home.page.scss'],
})
export class HomePage implements OnInit {
  ngOnInit() {
    console.log('正在初始化 HomePage');

    // 请求使用推送通知的权限
    // iOS 将提示用户并返回是否授予权限
    // Android 将直接授予而不提示
    PushNotifications.requestPermissions().then(result => {
      if (result.receive === 'granted') {
        // 向 Apple/Google 注册以通过 APNS/FCM 接收推送
        PushNotifications.register();
      } else {
        // 显示一些错误信息
      }
    });

    PushNotifications.addListener('registration', (token: Token) => {
      alert('推送注册成功，token：' + token.value);
    });

    PushNotifications.addListener('registrationError', (error: any) => {
      alert('注册错误：' + JSON.stringify(error));
    });

    PushNotifications.addListener(
      'pushNotificationReceived',
      (notification: PushNotificationSchema) => {
        alert('收到推送：' + JSON.stringify(notification));
      },
    );

    PushNotifications.addListener(
      'pushNotificationActionPerformed',
      (notification: ActionPerformed) => {
        alert('推送操作已执行：' + JSON.stringify(notification));
      },
    );
  }
}

之后，您需要生成新的构建并让 Capacitor 知道这些更改。您可以通过以下方式完成：

ionic build
npx cap copy

在 Firebase 上为您的应用创建项目

在将 Firebase Cloud Messaging 连接到您的应用并发送推送通知之前，您需要在 Firebase 中启动一个项目。

前往 Firebase 控制台，点击 Add project 按钮。

为项目命名，接受 Firebase 服务条款，然后点击 Create project 继续。系统会自动为您生成一个项目 ID。

Android

将 Firebase 与 Android 应用集成

本节或多或少与使用 Firebase 控制台文档设置 Firebase 相对应。请参阅下面的特定 Capacitor 相关说明。

转到 Firebase 项目的项目概览页面，在顶部点击 Android 图标以添加一个新的 Android 应用。

下一个屏幕将询问您一些关于应用的信息。

• 您的 Android 包名 应与 capacitor.config.json 文件中的 appId 匹配
• 我们在此 Capacitor 应用 ID 中使用了 com.mydomain.myappname，因此我们将在该条目中使用它。
• 昵称和调试签名证书是可选的

然后点击 Register app 按钮。

下载并使用 google-services.json 文件

下一个提示将要求您下载 google-services.json 文件。此文件包含您的 Capacitor 应用从 Android 连接到 Firebase 所需的信息。

将 google-services.json 文件下载到您的本地机器。然后将该文件移到您的 Capacitor Android 项目目录中，具体在 android/app/ 下。

我们不需要向项目_添加_任何依赖项，因为 Capacitor 项目在其 build.gradle 文件中自动包含了 firebase-messaging 的版本。

iOS

前提条件

iOS 推送通知的设置比 Android 复杂得多。您必须拥有付费的 Apple Developer 帐户 并且 在能够测试 iOS 应用的推送通知之前，需要处理以下事项：

1. 在 Apple Developer Portal 中为您的 iOS 应用设置适当的开发或生产证书和配置文件
2. 在 Apple Developer Portal 中创建 APNS 证书或密钥用于开发或生产
3. 确保在 Xcode 中为您的应用启用了推送通知功能
4. 按照环境设置文档中的指南，准备一台实体 iOS 设备

将 Firebase 与原生 iOS 应用集成

这部分与上面的 Android 部分非常相似，但有一些关键区别。

首先，转到 Firebase 项目的项目概览页面。如果您一直在遵循本指南，页面顶部应该已经列出了一个 Android 应用。

要向 Firebase 项目添加 iOS，请点击 Add App 按钮并选择 iOS 平台。

下一个屏幕将询问您一些关于应用的信息。

• 您的 iOS Bundle ID 应与 capacitor.config.json 文件中的 appId 匹配
• 我们在此 Capacitor 应用 ID 中使用了 com.mydomain.myappname，因此我们将在该条目中使用它。
• 应用昵称和 App Store ID 是可选的

然后点击 Register app 按钮。

将 GoogleService-Info.plist 文件添加到 iOS 应用

注意：这与用于 Android 应用的文件不同。

将提供的 GoogleService-Info.plist 下载到您的本地机器。

然后您必须打开 Xcode...

npx cap open ios

...并按照 Firebase 的指示将 .plist 文件移动到您的 Xcode 项目中，确保将其添加到所有 target。

通过 CocoaPods 添加 Firebase SDK

iOS 上的推送通知 API 使用 CocoaPods（一个 iOS 依赖项管理系统），我们需要告诉 CocoaPods 使用 Firebase。

为此，我们需要修改 Podfile，可以在 Xcode 中的 Pods 下找到：

我们需要将 Firebase 添加到为我们的 App target 提供的 CocoaPods 中。为此，请将 pod Firebase/Messaging 添加到您的 target 'App' 部分，如下所示：

target 'App' do
capacitor_pods
# 在此处添加您的 Pods
pod 'Firebase/Messaging' # 添加此行
end

您的 Podfile 应该类似于这样：

platform :ios, '12.0'
use_frameworks!

# 解决 Xcode 缓存 Pods 的变通方法，需要在安装新的 Cordova 插件后执行
# Product -> Clean Build Folder
# 需要 CocoaPods 1.6 或更高版本
install! 'cocoapods', :disable_input_output_paths => true

def capacitor_pods
  pod 'Capacitor', :path => '../../node_modules/@capacitor/ios'
  pod 'CapacitorCordova', :path => '../../node_modules/@capacitor/ios'
end

target 'App' do
  capacitor_pods
  # 在此处添加您的 Pods
  pod 'Firebase/Messaging'
end

更新项目

现在我们需要确保我们的 iOS 项目已更新，并安装了正确的 Firebase CocoaPod。

注意：这部分可能需要一些时间，因为 CocoaPods 需要下载所有适当的文件/依赖项。

npx cap update ios

添加初始化代码

要在 iOS 应用启动时连接到 Firebase，您需要在 AppDelegate.swift 文件中添加以下内容。

首先，在文件顶部添加一个 import：

import Firebase

...然后在 AppDelegate.swift 文件的 application(didFinishLaunchingWithOptions) 方法中添加 Firebase 的配置方法。

FirebaseApp.configure()

然后您需要添加以下两个方法来正确处理推送注册事件：

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
  Messaging.messaging().apnsToken = deviceToken
  Messaging.messaging().token(completion: { (token, error) in
    if let error = error {
        NotificationCenter.default.post(name: .capacitorDidFailToRegisterForRemoteNotifications, object: error)
    } else if let token = token {
        NotificationCenter.default.post(name: .capacitorDidRegisterForRemoteNotifications, object: token)
    }
  })
}

func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
  NotificationCenter.default.post(name: .capacitorDidFailToRegisterForRemoteNotifications, object: error)
}

您完成的 AppDelegate.swift 文件应类似于以下内容：

import UIKit
import Capacitor
import Firebase

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

  var window: UIWindow?


  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // 应用启动后的自定义覆盖点
    FirebaseApp.configure()
    return true
  }

  func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    Messaging.messaging().apnsToken = deviceToken
    Messaging.messaging().token(completion: { (token, error) in
      if let error = error {
          NotificationCenter.default.post(name: .capacitorDidFailToRegisterForRemoteNotifications, object: error)
      } else if let token = token {
          NotificationCenter.default.post(name: .capacitorDidRegisterForRemoteNotifications, object: token)
      }
    })
  }

  func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
    NotificationCenter.default.post(name: .capacitorDidFailToRegisterForRemoteNotifications, object: error)
  }

将 APNS 证书或密钥上传到 Firebase

如果您从一开始就按照说明操作，您已经在 Apple Developer Portal 中创建了 Apple APNS 证书或 APNS Auth Key。您需要将其中一个上传到 Firebase，Firebase 才能与 APNS 通信并向您的应用发送推送通知。

要上传您的证书或 Auth Key，从项目概览页面：

1. 点击您的 iOS 应用，然后点击 Settings 齿轮图标。
2. 在设置页面上，点击 Cloud Messaging 选项卡。
3. 在 iOS app configuration 标题下，使用提供的 Upload 按钮上传您的 Auth Key 或证书。

发送测试通知

现在是令人兴奋的部分——让我们验证来自 Firebase 的推送通知在 Android 和 iOS 上是否正常工作！

我们需要在 Android 或 iOS 上启动应用，以便 home.page.ts 页面可以注册并接收通知。

要在 Android Studio 中打开您的 Android 项目：

npx cap open android

要在 Xcode 中打开您的 iOS 项目：

npx cap open ios

项目打开后，使用 Android Studio 或 Xcode 的 Run 功能将应用侧加载到您的设备上。应用应在主页上启动。

注意：在 iOS 上，您会看到一个弹窗询问您是否允许应用的通知——请确保选择 Allow notifications！

如果您的应用成功注册，并且您遵循了上述代码，您应该会看到一个带有成功消息的 alert！

现在我们将测试设备是否收到通知。要发送通知，在 Firebase 中，转到项目窗格中 Grow 标题下的 Cloud Messaging 部分。

接下来，选择 New Notification 按钮。

创建通知时，您只需指定以下信息：

1. 通知的文本
2. 标题（仅 Android，iOS 可选）
3. 目标（用户段或主题；我建议只针对 iOS 或 Android 应用本身，见下方）

4. 计划（保持为"Now"）

此时，您可以 Review 您组合好的通知，然后选择 Publish 发送通知。

如果您正确设置了应用，您将看到主屏幕上弹出一个 alert，其中包含您在 Firebase 中编写的推送通知。然后您可以点击通知，根据我们上面的代码，您应该会收到 pushActionPerformed 事件的 alert。