如何集成移动推送提供的华为辅助通道SDK_移动研发平台(EMAS)-阿里云帮助中心

本章节介绍如何集成移动推送提供的华为辅助通道SDK。

准备工作

已经按照Android SDK接入完成了移动推送SDK的接入。
已经在华为开发者联盟注册了应用，如果没注册请登录华为开发者联盟，注册您的应用。然后在应用信息中获取APP ID和SecretKey。
如果在上图中未找到SecretKey，您也可以在下图中查看OAuth2.0客户端ID（凭据）中的Client Secret。
已经在华为开发者联盟配置SHA256证书指纹。如未配置请参见华为官方文档配置AppGallery Connect。
已经设置消息回执，如未设置可参考设置方法：消息回执。
重要
使用辅助弹窗后，华为通道的到达率统计覆盖用户点击华为弹窗推送通知的场景，未点击部分暂未覆盖，您可在华为端设置消息回执，便于移动推送更好的统计推送数据。
开通回执需配置回调地址：https://amspush-ack.aliyuncs.com/hw/。
若配置了多个回调地址，需要将上述回调地址对应的配置设为默认回执，或者记录回执ID配置到控制台的默认回执ID中。
已经在EMAS控制台配置了推送密钥，如未配置，请登录EMAS移动推送控制台，设置您的华为推送密钥（AppID、AppSecret、默认回执ID），设置方法参见配置厂商通道密钥。

第一步：将SDK添加到您的应用

我们提供了Maven依赖和本地依赖两种集成方式，方便您根据需要将SDK添加到您的应用中。

说明

建议开发者采用Maven依赖方式进行集成，配置简单，不容易出问题，后续更新方便。
3.2.0及以上版辅助通道扩展包以aar形式透出，省去manifest文件配置，减少出错概率。

1 Maven依赖方式

1.1 配置Maven仓库

下面分别介绍Gradle 7.0及以上推荐的dependencyResolutionManagement配置方式和Gradle 7.0之下推荐的allprojects配置方式。

1.1.1 dependencyResolutionManagement方式

在您的根级（项目级）Gradle 文件（<project>/settings.gradle）中，在dependencyResolutionManagement的repositories中添加Maven仓库地址。

dependencyResolutionManagement {
  repositories {
    maven {
      url 'https://developer.huawei.com/repo/'
    }
  }
}

1.1.2 allprojects方式

在您的根级（项目级）Gradle 文件（<project>/build.gradle）中，在allprojects的repositories中添加Maven仓库地址。

allprojects {
  repositories {
    maven {
      url 'https://developer.huawei.com/repo/'
    }
  }
}

1.2 添加SDK依赖

在您的模块（应用级）Gradle 文件（通常是<project>/<app-module>/build.gradl）中，在dependencies中添加SDK依赖。

重要

请阅读Android SDK版本说明，下载对应版本SDK或获取最新SDK配置信息。
华为推送的2.X版本SDK将于2021年9月30日下线。为了避免推送受到影响，请尽快升级推送SDK及华为辅助通道SDK到3.2.4版本及以上。
华为推送在2023年9月15日起对本地通知纳入每天通知条数的管控，请升级推送SDK到3.7.0及以上版本，更多信息：华为推送服务管控新规及适配。

dependencies {
    implementation 'com.aliyun.ams:alicloud-android-third-push-x.x.x'
    implementation 'com.aliyun.ams:alicloud-android-third-push-huawei:x.x.x'
    implementation 'com.huawei.hms:push:5.x.x.x'
}

2 本地依赖方式

2.1 下载SDK

参考下载和集成SDK，选择移动推送进行下载，将SDK包内所有文件拷贝至您的模块（应用级）的<project>/<app-module>/libs目录下。

2.2 添加SDK依赖

2.2.1 配置本地SDK目录

在您的模块（应用级）Gradle 文件（通常是<project>/<app-module>/build.gradle）中，添加本地SDK文件目录地址。

repositories {
  flatDir {
    dirs 'libs'
  }
}

2.2.2 添加SDK依赖

在您的模块（应用级）Gradle 文件（通常是<project>/<app-module>/build.gradle）中，的dependencies中添加SDK依赖。

dependencies {
    implementation(name: 'alicloud-android-third-push-x.x.x', ext: 'aar')
    implementation(name: 'alicloud-android-third-push-huawei-x.x.x', ext: 'aar')
    implementation 'com.huawei.hms:push:5.x.x.x'
}

警告

3.2.4及以上版本华为SDK不支持手动集成。

第二步：配置使用SDK

1 配置AppID

在应用级的AndroidManifest.xml文件下的application节点下添加meta-data来配置AppID。

<meta-data
	android:name="com.huawei.hms.client.appid"
 	android:value="appid=您的华为AppID" />

2 SDK初始化

重要

SDK初始化务必在Application中执行且放在推送SDK初始化代码之后，否则可能导致辅助通道注册失败。

通过如下方式进行初始化：

Kotlin

// 注册方法会自动判断是否支持华为系统推送，如不支持会跳过注册。
HuaWeiRegister.register(application)

Java

// 注册方法会自动判断是否支持华为系统推送，如不支持会跳过注册。
HuaWeiRegister.register(application);

说明

注册方法会自动判断是否支持华为系统推送，如不支持会跳过注册。

3 混淆配置

如果集成推送SDK的工程开启了代码混淆，需要添加以下辅助通道的Proguard配置。

# 华为通道
-keep class com.huawei.** {*;}
-dontwarn com.huawei.**

第三步：接入验证

1 打开SDK日志

Kotlin

val pushService = PushServiceFactory.getCloudPushService()
//仅适用于Debug包，正式包不需要此行
pushService.setLogLevel(CloudPushService.LOG_DEBUG)

Java

CloudPushService pushService = PushServiceFactory.getCloudPushService();
//仅适用于Debug包，正式包不需要此行
pushService.setLogLevel(CloudPushService.LOG_DEBUG);

2 确认成功方法

华为通道初始化成功，可以看到以下日志：

华为通道初始化成功日志

后续步骤

您已经可以通过EMAS后台将推送通知通过辅助通道推送到手机通知栏，但是要处理点击通知后的逻辑，只能通过辅助弹窗来接收推送数据，详情请参见辅助弹窗接入。

重要

使用移动推送进行厂商通道推送时（使用移动推送控制台或者OpenAPI进行推送时），服务端请必须参考辅助弹窗文档进行服务端配置，服务端参数不设置，不会给厂商通道进行推送。

辅助通道常见问题

华为通道注册时返回6003：证书指纹配置不对应，请再次进行“华为辅助通道集成”
Android端辅助通道和弹窗问题的排查步骤
Android端辅助通道SDK与其他厂商SDK冲突
Android端辅助通道收到推送通知后单击通知无法打开相应Activity
Android端辅助弹窗启动报解析body异常
在集成移动推送辅助通道后显示"register not in main process，return"