FCM 集成指南

说明

本文适用于 Android 端集成 FCM。

概述

Google 推送 FCM（Firebase Cloud Messaging）是一种跨平台消息传递解决方案，支持海外用户推送离线消息，可供开发者可靠地传递消息。

开发者使用 ZIM 提供的“离线推送”功能之前，请参考本文，接入 Google FCM 厂商的离线推送通道。

注意

启用 Google 推送后，ZPNs SDK 会直接使用 Google 推送通道，其他厂商的推送通道将会失效。

前提条件

使用 FCM 成功推送需要以下条件：

移动设备（如手机）支持 “谷歌移动服务 GMS”。
移动设备（如手机）连接的网络属于海外网络。

在接入 FCM 的离线推送通道之前，请确保：

已集成最新版本的 ZIM SDK，详情请参考快速开始 - 实现基本收发消息。
已完成如下步骤：
1. 前往 Firebase 平台，登录自己的 Google 账号。
2. 登录成功后，在页面中，选择 “添加项目”，输入项目名称及相关信息。
3. 添加项目完成后，点击，进入项目详情。
4. 在界面中点击如图的按钮，创建 Android 应用。
5. 填写 Android 应用的相关信息，然后点击 “注册应用”。
6. 注册完成后，点击 “下载 google-services.json” 文件。
将下载好的 “google-services.json” 文件，复制到自己项目根目录下的 “nativeResources/android” 目录。
1. 自助配置 ZIM 离线推送证书
以上配置完成后，请在 ZEGO 控制台自助配置 ZIM 离线推送证书（详情请参考项目管理 - 即时通讯 - 离线推送配置），若无法配置，请联系 ZEGO 技术支持处理。

添加 FCM 推送服务

配置 google-services.json。

将下载好的 “google-services.json” 文件，复制到自己项目的 “app” 目录下，如下图：

在项目级 “build.gradle”（文件路径：项目/build.gradle）文件中，配置 Google 的 maven 仓库，拉取 Google 的依赖。

buildscript {
    repositories {
        // 请检查代码是否有以下内容（若无，请添加）：
        google()  // Google 的 Maven 库
        mavenCentral()
    }
    dependencies {
        ...
        // 添加此行
        classpath 'com.google.gms:google-services:4.3.5'

    }
}

allprojects {
    ...
    repositories {
        // 请检查代码是否有以下内容（若无，请添加）：
        google()  // Google 的 Maven 库
        mavenCentral()
        ...
    }
}

buildscript {
    repositories {
        // 请检查代码是否有以下内容（若无，请添加）：
        google()  // Google 的 Maven 库
        mavenCentral()
    }
    dependencies {
        ...
        // 添加此行
        classpath 'com.google.gms:google-services:4.3.5'

    }
}

allprojects {
    ...
    repositories {
        // 请检查代码是否有以下内容（若无，请添加）：
        google()  // Google 的 Maven 库
        mavenCentral()
        ...
    }
}

在应用级 “build.gradle”（文件路径：项目/应用模块/build.gradle）文件中，增加 Firebase 相关依赖。

apply plugin: 'com.android.application'

// 添加此行
apply plugin: 'com.google.gms.google-services'

dependencies {
    // 引入 Firebase BoM
    implementation platform('com.google.firebase:firebase-bom:31.0.2')

    // 添加 Firebase SDK 用于 Google Analytics 和 FCM 的依赖。 
    // 使用 BoM 时，请勿在 Firebase 依赖中指明版本
    implementation 'com.google.firebase:firebase-analytics'
    implementation 'com.google.firebase:firebase-messaging:23.2.1' 
    implementation 'im.zego:zpns-fcm:2.8.0' // 用于 Google FCM 推送的 ZPNs 包

    // 为任何其他所需的 Firebase 产品添加依赖
    // https://firebase.google.com/docs/android/setup#available-libraries
}

apply plugin: 'com.android.application'

// 添加此行
apply plugin: 'com.google.gms.google-services'

dependencies {
    // 引入 Firebase BoM
    implementation platform('com.google.firebase:firebase-bom:31.0.2')

    // 添加 Firebase SDK 用于 Google Analytics 和 FCM 的依赖。 
    // 使用 BoM 时，请勿在 Firebase 依赖中指明版本
    implementation 'com.google.firebase:firebase-analytics'
    implementation 'com.google.firebase:firebase-messaging:23.2.1' 
    implementation 'im.zego:zpns-fcm:2.8.0' // 用于 Google FCM 推送的 ZPNs 包

    // 为任何其他所需的 Firebase 产品添加依赖
    // https://firebase.google.com/docs/android/setup#available-libraries
}

防止混淆代码

在“proguard-rules.pro”文件中，为 FCM SDK 添加 -keep 类的配置，这样可以防止混淆 FCM SDK 公共类名称：
```
-dontwarn com.google.**
-keep class com.google.** {*;}
```
```
-dontwarn com.google.**
-keep class com.google.** {*;}
```
自助配置 ZIM 离线推送证书

以上配置完成后，请在 ZEGO 控制台自助配置 ZIM 离线推送证书（详情请参考项目管理 - 即时通讯 - 离线推送配置），若无法配置，请联系 ZEGO 技术支持处理。

在控制台添加 FCM 证书

获取 Firebase 服务账号凭证

Android 项目支持 Google 服务账号，但是需要使用 Google 服务账号获取的凭证文件，并允许 ZEGO 服务器调用 Firebase 服务器 API。

获取步骤如下：

前往 Firebase 控制台，选择您的项目。

点击项目设置 > 服务账号。

点击生成新的私钥，然后点击生成密钥。

上传 FCM 证书

在离线推送配置中，点击添加证书，上传 FCM 证书，然后点击确定。

至此，您已完成 FCM 离线推送通知的配置。

FCM 集成指南

概述

前提条件

使用步骤

添加 FCM 推送服务

在控制台添加 FCM 证书