阅读811 返回首页    go 阿里云


移动推送辅助通道配置__Android SDK手册_App SDK 手册_移动推送-阿里云

小米/华为系统推送支持


1.相关概念

  • 辅助通道:移动推送针对小米、华为设备管控较严的情况特意接入华为,小米推送辅助通道以提高在华为、小米设备上的到达率。移动推送优先选择自有通道进行推送消息下发,只有在自有通道断连时选择辅助通道下发消息。当前辅助通道通过华为、小米推送下发透传消息,消息到达应用后经移动推送SDK处理后触发onNotification,onMessage回调。小米、华为推送在下发透传消息时并不保证会拉起被杀死进程(相关机制可参考小米、华为推送官网),所以辅助通道在进程被杀死情况下无法保证消息一定到达。
  • 小米弹窗:小米弹窗通过小米通道下发通知,可以在进程被杀死情况下推送成功。由于小米弹窗通过小米推送通知实现,因而通过小米弹窗下发的通知不会触发onNotification回调。当前小米弹窗到达率统计只覆盖用户点击小米弹窗推送通知的场景,未点击部分暂未覆盖。

2. 配置应用

  • 小米开放平台 注册你的App, 得到相应的小米AppID,小米AppKey,小米AppSecert。在控制台App详情设置你的小米AppSecert。(注意:小米开发者平台的消息推送开关记得打开
  • 同理在 华为开发者联盟 注册App,应用审核通过后,能够得到华为的AppID和AppSecert。在控制台App详情中设置你的华为AppID和AppSecert。(注意,您的app不能是草稿状态,必须是审核中,或者通过审核的状态,不然通道不会生效。请确保您在华为控制台激活了推送通道功能)

3. 下载扩展包

将小米华为扩展包拷贝到你项目的Lib目录下,下载地址

4. 配置Manifest

  • 为小米特别通道新增配置Permission
  1. <!--小米通道相关权限 -->
  2. <permission
  3. android:name="你的包名.permission.MIPUSH_RECEIVE"
  4. android:protectionLevel="signatureOrSystem"/>
  5. <uses-permission android:name="你的包名.permission.MIPUSH_RECEIVE"/>

【注意】: 请确保上述Permission配置是在manifest标签域,而非application标签域。关于AndroidManifest.xml应用清单文件的说明参考:https://developer.android.com/guide/topics/manifest/manifest-intro.html#filec

  • 为小米特别通道新增配置Manifest:
  1. <!-- 小米通道官方配置 -->
  2. <service android:name="com.xiaomi.mipush.sdk.PushMessageHandler" android:enabled="true" android:exported="true" />
  3. <service android:enabled="true" android:name="com.xiaomi.mipush.sdk.MessageHandleService" />
  4. <receiver android:name="com.alibaba.sdk.android.push.MiPushBroadcastReceiver" android:exported="true" >
  5. <intent-filter>
  6. <action android:name="com.xiaomi.mipush.RECEIVE_MESSAGE" />
  7. </intent-filter>
  8. <intent-filter>
  9. <action android:name="com.xiaomi.mipush.MESSAGE_ARRIVED" />
  10. </intent-filter>
  11. <intent-filter>
  12. <action android:name="com.xiaomi.mipush.ERROR" />
  13. </intent-filter>
  14. </receiver>
  15. <receiver android:name="com.xiaomi.push.service.receivers.NetworkStatusReceiver" android:exported="true" >
  16. <intent-filter>
  17. <action android:name="android.net.conn.CONNECTIVITY_CHANGE" />
  18. <category android:name="android.intent.category.DEFAULT" />
  19. </intent-filter>
  20. </receiver>

注意,com.xiaomi.push.service.XMPushService加入Manifest后,这个类名会在Android Studio中显示成红色,请忽略该错误,不要删除这行配置。(该应用在小米机器上会找到对应的Service)

  • 为华为特别通道新增配置Manifest:
  1. <!-- 华为通道官方配置 -->
  2. <receiver android:name="com.alibaba.sdk.android.push.HuaWeiReceiver">
  3. <intent-filter>
  4. <action android:name="com.huawei.android.push.intent.REGISTRATION"/>
  5. <action android:name="com.huawei.android.push.intent.RECEIVE"/>
  6. <action android:name="com.huawei.intent.action.PUSH"/>
  7. <action android:name="com.huawei.intent.action.PUSH_STATE"/>
  8. </intent-filter>
  9. </receiver>

5. Proguard配置

  • 如果集成推送SDK的工程开启代码混淆,在Proguard配置的基础上,需要添加以下辅助通道的Proguard配置。
  1. # 小米通道
  2. -keep class com.xiaomi.** {*;}
  3. -dontwarn com.xiaomi.**
  4. # 华为通道
  5. -keep class com.huawei.** {*;}
  6. -dontwarn com.huawei.**

6. 在应用中初始化小米华为通道

将以下代码加入你application.onCreate()方法中初始通道:

  1. // 注册方法会自动判断是否支持小米系统推送,如不支持会跳过注册。
  2. MiPushRegister.register(applicationContext, "小米AppID", "小米AppKey");
  3. // 注册方法会自动判断是否支持华为系统推送,如不支持会跳过注册。
  4. HuaWeiRegister.register(applicationContext);

本方法会自动判断是否支持小米系统推送,如不支持会跳过注册。

7. 在日志中查看初始化情况

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

  1. 11-11 22:21:33.671 30248-30324/com.xxx E/MPS:HuaWeiRegister: HuaWeiRegister checkDevice flag=true //确认是华为的手机
  2. 11-11 22:21:33.674 30248-30324/com.xxx E/MPS:HuaWeiRegister﹕ Register huawei push............ //开始注册华为手机
  3. 11-11 22:21:33.714 29643-30328/com.xxx E/MPS:HuaWeiReceiver﹕ huawei register success,token = 08657430243125472000000411000001
  4. 11-11 22:21:33.714 29643-30328/com.xxx E/MPS:HuaWeiReceiver﹕ report huaweiPushId intent... //完成华为注册和信息上报

小米通道初始化成功,可以看到以下日志:

  1. 12-09 22:20:39.710 19566-19566/com.xxx E/MPS:MiPushRegister: MiPushRegister checkDevice flag=true //确认是小米的手机
  2. 12-09 22:20:39.712 19566-19566/com.xxx E/MPS:MiPushRegister: Register mipush. //开始注册小米
  3. 12-09 22:20:40.596 19566-19733/com.xxx E/MPS:MiPushReceiver: XiaoMi register success. //小米注册成功 regid=d//igwEhgBGCI2TG6lWqlCesc0I6xE1wUhNCBXQ8uNOi/dDZioYXVysbrVrvRmyEVPn9nWz92D28IzYbA1RzoGDyTzYZwXKfBHEQkrey4G8=

收到小米通道下行的消息:(需要将sdk日志等级设置到DEBUG)

  1. 12-09 22:24:34.065 19566-25042/com.xxx D/MPS:MiPushReceiver: onReceiveMessage,msg=[{"f":262,"b":"{"content" ... ... ,"i":"f__-rnje3_OH74gE|VG0g3kwMnGADAGrXZku1FFW5"}]

注:如果控制台配置了小米/华为的信息,app需要加对应的jar包依赖,不然会有crash的风险。

8. 小米系统辅助弹窗

小米设备管控严格,接入推送功能的App进程在后台被清理后,收不到推送通知;接入小米辅助弹窗后,可走MIUI系统的通道进行通知的推送,保证App后台被清理后,仍能收到推送通知(v2.3.0及以上支持)。

8.1 客户端

  • 该功能的使用需要接入小米推送辅助通道,确保使用最新的小米华为扩展包,具体参考上文;
  • 小米辅助弹窗送达的通知展示效果,和普通通知相同;
  • 服务端指定小米辅助弹窗通道推送时,一定要指定通知点击后要打开的Activity,该Activity需继承自抽象类MiPushSystemNotificationActivity,否则无法获取到通知的相关信息,并且会影响通知到达率的统计;
  • MiPushSystemNotificationActivity中提供抽象方法onMiPushSysNoticeOpened(),实现该方法后可获取到小米辅助弹窗通知的标题内容额外参数,在通知点击时触发,原本的通知回调onNotification()onNotificationOpened()不适用于小米辅助弹窗;

  • 接入如下所示:

  1. import com.alibaba.sdk.android.push.MiPushSystemNotificationActivity;
  2. public class XiaoMiPushActivity extends MiPushSystemNotificationActivity {
  3. static final String TAG = "XiaoMiPushActivity";
  4. @Override
  5. protected void onCreate(Bundle savedInstanceState) {
  6. super.onCreate(savedInstanceState);
  7. }
  8. /**
  9. * 实现通知打开回调方法,获取通知相关信息
  10. * @param title 标题
  11. * @param summary 内容
  12. * @param extMap 额外参数
  13. */
  14. @Override
  15. protected void onMiPushSysNoticeOpened(String title, String summary, Map<String, String> extMap) {
  16. Log.d("OnMiPushSysNoticeOpened, title: " + title + ", content: " + summary + ", extMap: " + extMap);
  17. }
  18. }

8.2 服务端

  • OpenAPI提供setXiaoMiActivity()接口,参数为小米辅助弹窗通知打开时跳转的Activity,setStoreOffline为true时生效;
  • 配置setXiaoMiActivity()后,仅对后台进程被清理的小米设备生效,对非小米设备和在线小米设备不生效;
  • 推送通知标题内容额外参数的设置和普通推送接口相同,即setTitle()setBody()setAndroidActivity(),额外参数设置中的功能性设置如声音、震动等对小米辅助弹窗通知不生效;
    1. PushRequest pushRequest = new PushRequest();
    2. // 其余设置省略
    3. // ...
    4. // 0:表示消息(默认为0), 1:表示通知
    5. pushRequest.setType(1);
    6. // 标题
    7. pushRequest.setTitle(dateFormat.format(new Date()));
    8. // 内容
    9. pushRequest.setBody("PushRequest body");
    10. // 额外参数
    11. pushRequest.setAndroidExtParameters("{"k1":"android","k2":"v2"}");
    12. // 设置小米辅助弹窗打开Activity
    13. pushRequest.setXiaomiActivity("*****");

8.3 场景解析

以下几种普通推送结合小米辅助弹窗推送的场景,帮助您快速理解小米辅助弹窗功能的配置。

客户端配置

客户端有Main、Second两个Activity,MainActivity为App打开主页面,SecondActivity extends MiPushSystemNotificationActivity;

  • 普通通知回调配置:
  1. public class MyMessageReceiver extends MessageReceiver {
  2. /**
  3. * 推送通知的回调方法
  4. * @param context
  5. * @param title
  6. * @param summary
  7. * @param extraMap
  8. */
  9. @Override
  10. public void onNotification(Context context, String title, String summary, Map<String, String> extraMap) {
  11. Log.d(TAG, "Receive notification, title: " + title + ", content: " + summary + ", extraMap: " + extraMap);
  12. }
  13. }
  • MainActivity定义:
  1. package com.alibaba.push.testdemo;
  2. public class MainActivity extends Activity {
  3. @Override
  4. protected void onCreate(Bundle savedInstanceState) {
  5. Log.d(TAG, "Main");
  6. }
  7. }
  • SecondActivity定义:
  1. package com.alibaba.push.testdemo;
  2. import com.alibaba.sdk.android.push.MiPushSystemNotificationActivity;
  3. public class SecondActivity extends MiPushSystemNotificationActivity {
  4. /**
  5. * 小米辅助弹窗指定打开Activity回调
  6. * @param title 标题
  7. * @param content 内容
  8. * @param extraMap 额外参数
  9. */
  10. @Override
  11. protected void onMiPushSysNoticeOpened(String title, String content, Map<String, String> extraMap) {
  12. Log.d(TAG, "Receive XiaoMi notification, title: " + title + ", content: " + content + ", extraMap: " + extraMap);
  13. }
  14. }

场景1:普通推送打开App + 小米辅助弹窗

服务端配置如下:

  1. PushRequest pushRequest = new PushRequest();
  2. // 其余设置省略
  3. // ...
  4. // 0:表示消息(默认为0), 1:表示通知
  5. pushRequest.setType(1);
  6. // 标题
  7. pushRequest.setTitle("hello");
  8. // 内容
  9. pushRequest.setBody("PushRequest body");
  10. // 点击通知后动作,1:打开应用 2: 打开应用Activity 3:打开 url
  11. pushRequest.setAndroidOpenType("1");
  12. // 设置小米辅助弹窗打开Activity
  13. pushRequest.setXiaomiActivity("com.alibaba.push.testdemo.SecondActivity");
  14. // 设定android类型设备通知的扩展属性
  15. pushRequest.setAndroidExtParameters("{"k1":"android","k2":"v2"}");;

推送结果:

  • 非小米设备和在线小米设备

    • 收到普通推送通道弹出的通知,点击后打开App,进入首页MainActivity,如果设备在前台,保持当前界面不变;
    • onNotification()回调输出Receive notification, title: hello, content: PushRequest body, extraMap: {k1=android, k2=v2}
  • 清理进程后的小米设备

    • 小米辅助弹窗通道弹出通知,点击后跳转到SecondActivity
    • onMiPushSysNoticeOpened()回调输出Receive XiaoMi notification, title: hello, content: PushRequest body, extraMap: {k1=android, k2=v2}

场景2:普通推送打开Activity + 小米辅助弹窗

服务端配置如下:

  1. PushRequest pushRequest = new PushRequest();
  2. // 其余设置省略
  3. // ...
  4. // 0:表示消息(默认为0), 1:表示通知
  5. pushRequest.setType(1);
  6. // 标题
  7. pushRequest.setTitle("hello");
  8. // 内容
  9. pushRequest.setBody("PushRequest body");
  10. // 点击通知后动作,1:打开应用 2: 打开应用Activity 3:打开 url
  11. pushRequest.setAndroidOpenType("2");
  12. // 指定普通推送要打开的Activity
  13. pushRequest.setAndroidActivity("com.alibaba.push.testdemo.SecondActivity");
  14. // 设置小米辅助弹窗打开Activity
  15. pushRequest.setXiaomiActivity("com.alibaba.push.testdemo.SecondActivity");
  16. // 设定android类型设备通知的扩展属性
  17. pushRequest.setAndroidExtParameters("{"k1":"android","k2":"v2"}");

推送结果:

  • 非小米设备和在线小米设备

    • 收到普通推送通道弹出的通知,点击后跳转到SecondActivity
    • onNotification()回调输出Receive notification, title: hello, content: PushRequest body, extraMap: {k1=android, k2=v2}
  • 清理进程后的小米设备

    • 小米辅助弹窗通道弹出通知,点击后跳转到SecondActivity
    • onMiPushSysNoticeOpened()回调输出Receive XiaoMi notification, title: hello, content: PushRequest body, extraMap: {k1=android, k2=v2}

最后更新:2016-12-20 16:09:47

  上一篇:go SDK API介绍__Android SDK手册_App SDK 手册_移动推送-阿里云
  下一篇:go iOS推送证书设置__iOS SDK手册_App SDK 手册_移动推送-阿里云