推送服务接入指导（HarmonyOS篇）
消息推送作为App运营日常使用的用户促活和召回手段，是与用户建立持续互动和连接的良好方式。推送服务（Push Kit）是华为提供的消息推送平台，建立了从云端到终端的消息推送通道，本文旨在介绍HarmonyOS（Java）版本的功能及接入指导。
HarmonyOS（Java）版本主要功能为根据token推送通知栏和透传消息。HarmonyOS Java SDK为您的HarmonyOS应用开发提供推送消息相关的接口，适用于手机和平板。
根据Push Token推送消息
您可以输入目标用户的Push Token来推送消息，一次最多可填1000个Push Token。
透传消息
透传消息是由客户端应用负责处理的消息。终端设备收到Push云端发送的数据或指令后不直接展示，而是将数据传递给应用，由应用解析内容，并触发相关动作（如跳转网页、应用内页面等等）。您可以自定义消息样式，从而更高效灵活地推送消息。
透传消息的到达率受Android系统和应用是否驻留在后台影响，推送服务不保证透传消息的高到达率。
透传消息的常用场景：VoIP呼叫、语音播报、好友互动通知等。
开发准备
具体开发准备请参考官网。
应用开发
获取Push Token
Token是推送令牌，每个设备上的每个应用的Token都是唯一存在的，客户端调用getToken方法向Push服务端请求应用的Token，您可以根据Push服务端返回的Token向应用推送消息。当getToken方法返回为空时，可通过onNewToken方法获取Token值。
建议将Push Token上报到您自己的应用服务器，并定时更新Token列表。您可以调用下行消息API，根据这些Token批量推送消息。
- 创建一个新的线程，并调用getToken方法获取Push Token（建议在应用启动后的首个Ability中调用getToken方法）。
public class TokenAbilitySlice extends AbilitySlice {
private static final HiLogLabel LABEL_LOG = new HiLogLabel(HiLog.LOG_APP, 0xD001234,
"TokenAbilitySlice");
private void getToken() {
// 创建新线程
new Thread("getToken") {
@Override
public void run() {
try {
// 从agconnect-services.json文件中读取client/app_id
String appId = "your APP_ID";
// 输入token标识"HCM"
String tokenScope = "HCM";
// 获取Push Token
String token = HmsInstanceId.getInstance(getAbility().getAbilityPackage(), TokenAbilitySlice.this).getToken(appId, tokenScope);
} catch (ApiException e) {
// 获取Push Token失败时，打印错误码
HiLog.error(LABEL_LOG, "get token failed, the error code is %{public}d", e.getStatusCode());
}
}
}.start();
}
}
- 在您的service（已继承HmsMessageService）中，覆写onNewToken方法，当Token发生变化时以onNewToken方法返回。
public class DemoHmsMessageServiceAbility extends HmsMessageService {
private static final HiLogLabel LABEL_LOG = new HiLogLabel(HiLog.LOG_APP, 0xD001234, "DemoHmsMessageServiceAbility");
@Override
// 获取Token
public void onNewToken(String token) {
HiLog.info(LABEL_LOG, "onNewToken called, token:%{public}s", token);
}
@Override
// 获取Token失败，打印错误码
public void onTokenError(Exception exception) {
HiLog.error(LABEL_LOG, "get onNewtoken error, error code is %{public}d", ((ZBaseException)exception).getErrorCode());
}
}
获取透传消息数据
在您的service（已继承HmsMessageService）中，覆写onMessageReceived方法，只要您发送透传消息至终端设备，都会获得透传消息的内容。
public class DemoHmsMessageServiceAbility extends HmsMessageService {
private static final HiLogLabel LABEL_LOG = new HiLogLabel(HiLog.LOG_APP, 0xD001234,
"DemoHmsMessageServiceAbility");
@Override
public void onMessageReceived(ZRemoteMessage message) {
// 打印消息的内容字段
HiLog.info(LABEL_LOG, "get token, %{public}s", message.getToken());
HiLog.info(LABEL_LOG, "get data, %{public}s", message.getData());
ZRemoteMessage.Notification notification = message.getNotification();
if (notification != null) {
HiLog.info(LABEL_LOG, "get title, %{public}s", notification.getTitle());
HiLog.info(LABEL_LOG, "get body, %{public}s", notification.getBody());
}
}
}
发送消息
? 您可以登录AppGallery Connect网站发送消息，详情请参见HarmonyOS应用推送消息。
? 您可以使用服务端API向应用推送消息：
- 您的服务器调用华为帐号服务器的接口（https://oauth-login.cloud.huawei.com/oauth2/v3/token）请求凭证Token。请求示例如下：
POST /oauth2/v3/token HTTP/1.1
Host: oauth-login.cloud.huawei.com
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id=<客户端ID>&client_secret=<客户端密钥>
响应示例如下：
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
{
"access_token": "<返回的Access Token>",
"expires_in": 3600,
"token_type": "Bearer"
}
- 您的服务端调用API推送消息，请求示例如下。
HTTPS POST URL：
POST https://push-api.cloud.huawei.com/v1/clientid/messages:send
请求消息头示例：
Content-Type: application/json; charset=UTF-8
Authorization: Bearer CF3Xl2XV6jMK************************DgAPuzvNm3WccUIaDg==
请求消息体（通知栏消息）示例：
{
"validate_only": false,
"message": {
"android": {
"notification": {
"title": "test title",
"body": "test body",
"click_action": {
"type": 3
}
}
},
"token": ["pushtoken1"]
}
}
自定义点击消息动作
您可以自定义点击通知栏消息的动作，例如：打开应用首页、打开网页URL和打开应用自定义页面。
打开App首页
? 您可以通过AppGallery Connect推送消息，设置点击通知动作为打开应用、App页面为首页。
? 您可以通过服务端API推送消息：
消息体中携带click_action字段，type取值为3表示点击消息后打开应用首页。
{
"validate_only": false,
"message": {
"android": {
"notification": {
"title": "test title",
"body": "test body",
"click_action": {
"type": 3
}
}
},
"token": ["pushtoken1"]
}
}
打开网页
? 您可以通过AppGallery Connect推送消息，设置点击通知动作为打开网页。
? 您可以通过服务端API推送消息：
消息体中携带click_action字段，type取值为2表示点击消息后打开网页。
{
"validate_only": false,
"message": {
"android": {
"notification": {
"title": "test title",
"body": "test body",
"click_action": {
"type": 2,
"url":"https://www.huawei.com"
}
}
},
"token": ["pushtoken1"]
}
}
打开应用自定义页面
- 客户端应用先创建自定义页面（以“MyActionAbility”为例），在您项目的“entry/src/main”目录下的“config.json”文件中添加该Ability的skills字段。其中entities的值为“entity.system.default”不可改变，actions的值由您自定义（以“com.test.myaction”为例）。
{
"orientation": "unspecified",
"name": "com.test.java.MyActionAbility",
"icon": "$media:icon",
"description": "$string:myactionability_description",
"label": "$string:entry_MyActionAbility",
"type": "page",
"launchType": "standard",
"skills": [
{
"entities": ["entity.system.default"],
"actions": ["com.test.myaction"]
}
]
}
- 您可以通过AppGallery Connect推送消息，设置点击通知动作为打开应用、App页面为自定义action页面（action请输入上一步中定义的actions的值）。
您也可以通过服务端API推送消息。消息体中携带click_action和action字段，type取值为1表示点击消息后打开应用自定义页面，action取值为上一步中定义的actions的值。
{
"validate_only": false,
"message": {
"android": {
"notification": {
"title": "test title",
"body": "test body",
"click_action": {
"type": 1,
"action":"com.test.myaction"
}
}
},
"token": ["pushtoken1"]
}
}
传递数据
您推送消息时可携带data字段，当用户点击消息时通过下述方法将data中的数据传递至客户端应用。
- 推送消息时携带data字段：
? 通过AppGallery Connect推送消息且设置自定义键值对。
? 通过服务端API推送消息，消息体中携带data字段。
{
"validate_only": false,
"message": {
"android": {
"notification": {
"title": "test title",
"body": "test body",
"click_action": {
"type": 1,
"action":"com.test.myaction"
}
},
"data": "{'key_data':'value_data'}"
},
"token": ["pushtoken1"]
}
}
- 在客户端应用开发点击消息跳转的页面获取data字段的功能，此处以点击消息跳转到应用首页（MainAbilitySlice）获取data字段为例。
public class MainAbilitySlice extends AbilitySlice {
private static final HiLogLabel LABEL_LOG = new HiLogLabel(HiLog.LOG_APP, 0xD001234, "myDemo");
@Override
public void onStart(Intent intent) {
HiLog.info(LABEL_LOG, "MainAbilitySlice get started...");
super.onStart(intent);
super.setUIContent(ResourceTable.Layout_ability_main);
// 调用解析方法
parseIntent(intent);
}
private void parseIntent(Intent intent){
if (intent == null){return;}
IntentParams intentParams = intent.getParams();
if (intentParams == null) {return;}
// 获取data字段中的键值对
String key = "key_data";
Object obj = intentParams.getParam(key);
try{
// 打印data字段中的键值对
HiLog.info(LABEL_LOG, "my key: %{public}s, my value: %{public}s", key, obj);
}catch (Exception e){
HiLog.info(LABEL_LOG, "catch exception : " + e.getMessage());
}
}
}
了解更多详情>>
关注我们，第一时间了解 HMS Core 最新技术资讯~