这是本文档旧的修订版!


离线推送问题排查


开发者在集成环信的Android离线推送的时候,多少都会遇到离线推送收不到的问题。此文档旨在帮助开发者排查收不到离线推送的问题。环信目前提供了小米、华为、oppo、vivo、魅族,以及给海外用户使用的FCM,下面我们来一一分析下集成离线推送可能出现的问题,和排查的思路

注意:无论集成哪个推送都需要先在环信开发者后台去上传推送证书。

华为推送首先需要开发者自己先集成好,测试调通之后再去接入环信。 接入环信的时候需要注意:

1、在初始化环信之前去设置启用华为推送

EMPushConfig.Builder builder = new EMPushConfig.Builder(context);
builder.enableHWPush();
options.setPushConfig(builder.build());

2、在登录环信成功进入主界面之后再去连接华为移动服务,并获取华为推送token

3、在华为PushReceiver的onToken方法里去判断返回的推送token是否为空,不为空再去调用EMClient.getInstance().sendHMSPushTokenToServer(token)把推送token上传给环信。

注意:连接华为移动服务,并获取华为推送token这块的逻辑是必须放在环信登录成功之后再去执行,不然在登录之前就回调了onToken的话,后面环信账号登录成功就没法绑定推送token的。

接入完成之后在logcat里看下登录之后的日志,通过检索EMPushHelper查看下华为推送token是否上传成功

//1、SDK判断当前设备对应推送是否可用,false代表对应推送不可用,true代表对应推送可用
2019-09-02 10:50:35.972 5446-5475/? D/ONE SDK: [2019/09/02 10:50:35:971]: [EMPushHelper] isSupportPush: FCM - false
2019-09-02 10:50:35.981 5446-5475/? D/ONE SDK: [2019/09/02 10:50:35:977]: [EMPushHelper] isSupportPush: MIPUSH - false
2019-09-02 10:50:35.988 5446-5475/? D/ONE SDK: [2019/09/02 10:50:35:988]: [EMPushHelper] isSupportPush: HMSPUSH - true
2019-09-02 10:50:35.988 5446-5475/? D/ONE SDK: [2019/09/02 10:50:35:988]: [EMPushHelper] EMPushHelper register, prefer push type: HMSPUSH

//2、获取到了华为返回的推送token,这里的推送token可以在华为的推送后台去指定用户测试推送
2019-09-02 10:50:38.298 5446-5475/? D/ONE SDK: [2019/09/02 10:50:38:298]: [EMPushHelper] onReceiveToken: HMSPUSH - 0869379034831543200000121400CN01

2019-09-02 10:50:38.298 5446-5475/? D/ONE SDK: [2019/09/02 10:50:38:298]: [EMPushHelper] Retry upload after 5s if failed.
2019-09-02 10:50:38.298 5446-5475/? D/ONE SDK: [2019/09/02 10:50:38:298]: [EMPushHelper] Retry upload after 50s if failed.
2019-09-02 10:50:38.298 5446-5475/? D/ONE SDK: [2019/09/02 10:50:38:298]: [EMPushHelper] Retry upload after 262s if failed.

//3、去上传推送token,后面有对应的证书名称
2019-09-02 10:50:38.299 5446-5475/? D/ONE SDK: [2019/09/02 10:50:38:298]: [EMPushHelper] uploadTokenInternal, token=0869379034831543200000121400CN01, url=https://a4.easemob.com:443/easemob-demo/chatdemoui/users/omg4, notifier name=10492024

//4、推送token上传成功
2019-09-02 10:50:38.451 5446-5475/? D/ONE SDK: [2019/09/02 10:50:38:450]: [EMPushHelper] uploadTokenInternal success.

上面的是上传推送token成功的日志,可以对比你本地logcat里的日志,看下是否完整。(需在初始化环信SDK的时候设置EMClient.getInstance().setDebugMode(true)才会有详细的日志输出

1、如果在第一步判断当前设备推送,看到HMSPUSH是false,那就是华为推送相关的没有配置好,需要检查下华为推送jar包是否依赖上,清单里是否配置好了华为相关的配置,尤其是com.huawei.hms.client.appid,检查看看配置的格式、字段是否正确。并且要在初始化之前去设置好EMPushConfig.Builder

2、看logcat里的日志,如果HMSPUSH是true,但是没有了之后的日志输出,那就是注册华为推送的时候出问题了,需要看下连接华为移动服务和注册华为推送token这块api返的的错误码,然后根据错误码排查下

这两步都调试正常之后,后面的上传推送token的应该就不会有问题了(如果出现失败的情况,请提供手机本地的log文件反馈环信),之后就可以去测试华为推送了。测试推送的时候需要先把进程杀掉,首先在华为后台去单推消息,看app端是否可以收到(这里一般都是可以收到的,如果没有收到耐心等待几分钟,可能是华为那边推送有延迟,这个可以在华为的开发者群里核实下),然后再使用其他账号给当前的账号发消息测试。

如果出现测试我们的离线推送没有收到,需检查以下两步:

1、是否有调用EMClient.getInstance().pushManager().disableOfflinePush去设置离线推送免打扰时间

2、如果是群组消息是否有调用EMClient.getInstance().pushManager().updatePushServiceForGroup去屏蔽群组离线推送

如果以上两步都没有去设置,需要提供消息内容、消息时间和接收方id反馈给环信来查

小米推送的集成比较简单,导入小米推送的jar包,在清单AndroidManifest.xml里加上小米相关的权限和配置,如下 权限:

<!-- Mi推送配置 start -->
    <permission
        android:name="${applicationId}.permission.MIPUSH_RECEIVE"
        android:protectionLevel="signature" />

    <uses-permission android:name="${applicationId}.permission.MIPUSH_RECEIVE" />
    <!-- Mi推送配置 end -->

配置:

<!-- Mi推送配置 start -->
        <service
            android:name="com.xiaomi.push.service.XMPushService"
            android:enabled="true"
            android:process=":pushservice" />

        <service
            android:name="com.xiaomi.push.service.XMJobService"
            android:enabled="true"
            android:exported="false"
            android:permission="android.permission.BIND_JOB_SERVICE"
            android:process=":pushservice" /> <!--注:此service必须在3.0.1版本以后(包括3.0.1版本)加入-->

        <service
            android:name="com.xiaomi.mipush.sdk.PushMessageHandler"
            android:enabled="true"
            android:exported="true" />

        <service
            android:name="com.xiaomi.mipush.sdk.MessageHandleService"
            android:enabled="true" /> <!--注:此service必须在2.2.5版本以后(包括2.2.5版本)加入-->
        <receiver
            android:name="com.xiaomi.push.service.receivers.NetworkStatusReceiver"
            android:exported="true">

            <intent-filter>
                <action android:name="android.net.conn.CONNECTIVITY_CHANGE" />
                <category android:name="android.intent.category.DEFAULT" />
            </intent-filter>
        </receiver>

        <receiver
            android:name="com.xiaomi.push.service.receivers.PingReceiver"
            android:exported="false"
            android:process=":pushservice">

            <intent-filter>
                <action android:name="com.xiaomi.push.PING_TIMER" />
            </intent-filter>

        </receiver>

        <receiver android:name="com.hyphenate.chatuidemo.receiver.MyxmReceiver">
            <intent-filter>
                <action android:name="com.xiaomi.mipush.RECEIVE_MESSAGE" />
            </intent-filter>
            <intent-filter>
                <action android:name="com.xiaomi.mipush.MESSAGE_ARRIVED" />
            </intent-filter>
            <intent-filter>
                <action android:name="com.xiaomi.mipush.ERROR" />
            </intent-filter>
        </receiver>
        <!-- Mi推送配置 end-->

在初始化环信之前去设置上小米推送的appid和appkey

EMPushConfig.Builder builder = new EMPushConfig.Builder(context);
builder.enableMiPush(appid, appkey);
options.setPushConfig(builder.build());

然后运行app去登录,查看logcat里的日志检索EMPushHelper确认下小米推送是否集成成功

//1、SDK判断当前设备小米推送可用
2019-09-03 15:52:57.275 2984-3173/com.hyphenate.chatuidemo D/ONE SDK: [2019/09/03 15:52:57:275]: [EMPushHelper] isSupportPush: MIPUSH - true
2019-09-03 15:52:57.275 2984-3173/com.hyphenate.chatuidemo D/ONE SDK: [2019/09/03 15:52:57:275]: [EMPushHelper] EMPushHelper register, prefer push type: MIPUSH

//2、获取到了小米返回的推送token,这里的推送token就是小米推送的regid
2019-09-03 15:52:57.725 2984-3173/com.hyphenate.chatuidemo D/ONE SDK: [2019/09/03 15:52:57:725]: [EMPushHelper] onReceiveToken: MIPUSH - Tn0uw0uGRoadNgW6TElcKCGiEwrMCo39nWomRxQU0+K+WlqvFmaHSn45vr9fLG3k

2019-09-03 15:52:57.725 2984-3173/com.hyphenate.chatuidemo D/ONE SDK: [2019/09/03 15:52:57:725]: [EMPushHelper] Retry upload after 2s if failed.
2019-09-03 15:52:57.725 2984-3173/com.hyphenate.chatuidemo D/ONE SDK: [2019/09/03 15:52:57:725]: [EMPushHelper] Retry upload after 48s if failed.
2019-09-03 15:52:57.725 2984-3173/com.hyphenate.chatuidemo D/ONE SDK: [2019/09/03 15:52:57:725]: [EMPushHelper] Retry upload after 287s if failed.

//3、去上传推送token,后面有对应的证书名称
2019-09-03 15:52:57.726 2984-3173/com.hyphenate.chatuidemo D/ONE SDK: [2019/09/03 15:52:57:726]: [EMPushHelper] uploadTokenInternal, token=Tn0uw0uGRoadNgW6TElcKCGiEwrMCo39nWomRxQU0+K+WlqvFmaHSn45vr9fLG3k, url=https://a5-v2.easemob.com:443/easemob-demo/chatdemoui/users/omg4, notifier name=2882303761517426801

//4、推送token上传成功
2019-09-03 15:52:58.930 2984-3173/com.hyphenate.chatuidemo D/ONE SDK: [2019/09/03 15:52:58:930]: [EMPushHelper] uploadTokenInternal success.

上面的是上传推送token成功的日志,可以对比你本地logcat里的日志,看下是否完整。(需在初始化环信SDK的时候设置EMClient.getInstance().setDebugMode(true)才会有详细的日志输出

1、如果在这一步看到MIPUSH是false,那就是小米推送没有配置好,比如没有导入小米推送的jar,清单里的权限和配置没有加上,或者就是没有在初始化之前去设置上小米推送的appid和appkey。

2、如果没有看到小米返回的推送token的日志,那应该会有输出onErrorResponse:后面会有小米那边返回的错误码,需根据错误码去排查下

只要保证这两步是正常的,后面上传推送token的一般不会有问题,如果发现上传失败的情况,请反馈环信。然后在小米推送后台去使用regid(regid在第二步中获取)给设备推送消息,收到之后就可以杀掉进程去测试离线推送了。

如果出现没有收到离线推送,需检查以下两步:

1、是否有调用EMClient.getInstance().pushManager().disableOfflinePush去设置离线推送免打扰时间

2、如果是群组消息是否有调用EMClient.getInstance().pushManager().updatePushServiceForGroup去屏蔽群组离线推送

如果以上两步都没有去设置,需要提供消息内容、消息时间和接收方id反馈给环信来查

集成OPPO推送具体文件参考OPPO推送集成

集成OPPO推送时需要注意以下几点:

1、在环信开发者后台上传OPPO的推送证书时,需要填OPPO推送的AppKey和MasterSecret以及程序的包名,MasterSecret需要到OPPO推送平台-配置管理-应用配置 页面查看。

2、需要在手机通知管理里打开该应用的允许通知权限

3、在初始化环信之前去设置上OPPO推送的AppKey和AppSecret

EMPushConfig.Builder builder = new EMPushConfig.Builder(context);
builder.enableOppoPush(appKey,appSecret);
options.setPushConfig(builder.build()); 

4、需要在消息扩展里设置上oppo的channel id

// 设置自定义推送提示
JSONObject extObject = new JSONObject();
try {
    extObject.put("em_oppo_push_channel_id", channelId);
} catch (JSONException e) {
    e.printStackTrace();
}
// 将推送扩展设置到消息中
message.setAttribute("em_apns_ext", extObject);

集成完成之后运行app去登录,在logcat里检索EMPushHelper查看日志确定下是否集成成功

//1、SDK判断当前设备OPPO推送可用
2019-09-06 14:21:27.532 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:531]: [EMPushHelper] isSupportPush: FCM - false
2019-09-06 14:21:27.556 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:555]: [EMPushHelper] isSupportPush: MIPUSH - false
2019-09-06 14:21:27.575 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:575]: [EMPushHelper] isSupportPush: HMSPUSH - false
2019-09-06 14:21:27.592 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:592]: [EMPushHelper] isSupportPush: MEIZUPUSH - false
2019-09-06 14:21:27.610 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:610]: [EMPushHelper] isSupportPush: OPPOPUSH - true
2019-09-06 14:21:27.610 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:610]: [EMPushHelper] EMPushHelper register, prefer push type: OPPOPUSH

//2、获取到了OPPO返回的推送token
2019-09-06 14:21:27.805 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:805]: [EMPushHelper] onReceiveToken: OPPOPUSH - CN_724a57d2233d2363fbdeff46af095155

2019-09-06 14:21:27.805 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:805]: [EMPushHelper] Retry upload after 1s if failed.
2019-09-06 14:21:27.805 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:805]: [EMPushHelper] Retry upload after 14s if failed.
2019-09-06 14:21:27.806 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:806]: [EMPushHelper] Retry upload after 469s if failed.

//3、去上传推送token,后面有对应的证书名称
2019-09-06 14:21:27.807 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:807]: [EMPushHelper] uploadTokenInternal, token=CN_724a57d2233d2363fbdeff46af095155, url=https://a1.easemob.com:443/easemob-demo/chatdemoui/users/omg4, notifier name=65872dc4c26a446a8f29014f758c8272

//4、推送token上传成功
2019-09-06 14:21:27.934 7852-7912/com.hyphenate.chatuidemo.push D/ONE SDK: [2019/09/06 14:21:27:933]: [EMPushHelper] uploadTokenInternal success.

上面的是上传推送token成功的日志,可以对比你本地logcat里的日志,看下是否完整。(需在初始化环信SDK的时候设置EMClient.getInstance().setDebugMode(true)才会有详细的日志输出

1、如果在这一步看到OPPOPUSH是false,那就是OPPO推送没有配置好,比如没有导入OPPO推送的jar,清单里的配置没有加上,或者就是没有在初始化之前去设置上OPPO推送的AppKey和AppSecret。

2、如果没有看到OPPO返回的推送token的日志,那应该会有输出onErrorResponse:后面会有OPPO那边返回的错误码,需根据错误码去排查下

只要保证这两步是正常的,后面上传推送token的一般不会有问题,如果发现上传失败的情况,请反馈环信。然后在OPPO后台去使用推送token(在第二步中获取)给设备推送消息,收到之后就可以杀掉进程去测试离线推送了。

如果出现没有收到离线推送,需检查以下两步:

1、是否有调用EMClient.getInstance().pushManager().disableOfflinePush去设置离线推送免打扰时间

2、如果是群组消息是否有调用EMClient.getInstance().pushManager().updatePushServiceForGroup去屏蔽群组离线推送

如果以上两步都没有去设置,需要提供消息内容、消息时间和接收方id反馈给环信来查

集成VIVO推送具体文件参考VIVO推送集成

集成OPPO推送时需要注意以下几点:

1、测试的VIVO机型是否是支持VIVO推送的,详情可见 VIVO官网文档_支持机型和系统

2、需要在手机通知管理里打开该应用的允许通知权限

集成完成之后运行app去登录,在logcat里检索EMPushHelper查看日志确定下是否集成成功

//1、SDK判断当前设备VIVO推送可用
2019-10-14 14:57:33.231 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:231]: [EMPushHelper] isSupportPush: FCM - false
2019-10-14 14:57:33.245 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:245]: [EMPushHelper] isSupportPush: MIPUSH - false
2019-10-14 14:57:33.258 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:258]: [EMPushHelper] isSupportPush: HMSPUSH - false
2019-10-14 14:57:33.272 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:272]: [EMPushHelper] isSupportPush: MEIZUPUSH - false
2019-10-14 14:57:33.288 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:288]: [EMPushHelper] isSupportPush: OPPOPUSH - false
2019-10-14 14:57:33.302 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:302]: [EMPushHelper] isSupportPush: VIVOPUSH - true
2019-10-14 14:57:33.303 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:303]: [EMPushHelper] EMPushHelper register, prefer push type: VIVOPUSH

//2、获取到的VIVO返回的推送token
2019-10-14 14:57:33.623 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:623]: [EMPushHelper] onReceiveToken: VIVOPUSH - 15665456497861102581637
2019-10-14 14:57:33.623 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:623]: [EMPushHelper] Retry upload after 4s if failed.
2019-10-14 14:57:33.624 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:623]: [EMPushHelper] Retry upload after 9s if failed.
2019-10-14 14:57:33.624 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:624]: [EMPushHelper] Retry upload after 301s if failed.

//3、去上传推送token,后面有对应的证书名称
2019-10-14 14:57:33.624 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:624]: [EMPushHelper] uploadTokenInternal, token=15665456497861102581637, url=https://a4.easemob.com:443/easemob-demo/chatdemoui/users/omg4, notifier name=11025#9b74dbfc-55c4-4441-9d0a-561ff21addc7

//4、推送token上传成功
2019-10-14 14:57:33.760 24337-24437/com.hyphenate.chatuidemo D/ONE SDK: [2019/10/14 14:57:33:759]: [EMPushHelper] uploadTokenInternal success.

上面的是上传推送token成功的日志,可以对比你本地logcat里的日志,看下是否完整。(需在初始化环信SDK的时候设置EMClient.getInstance().setDebugMode(true)才会有详细的日志输出

1、如果在这一步看到VIVOPUSH是false,那就是VIVO推送没有配置好,比如没有导入VIVO推送的jar,清单里没有去配置VIVO的appid和appkey

2、如果没有看到VIVO返回的推送token的日志,那应该会有输出onErrorResponse:后面会有VIVO那边返回的错误码,需根据错误码去排查下

只要保证这两步是正常的,后面上传推送token的一般不会有问题,如果发现上传失败的情况,请反馈环信。然后在OPPO后台去使用推送token(在第二步中获取)给设备推送消息,收到之后就可以杀掉进程去测试离线推送了。

如果出现没有收到离线推送,需检查以下两步:

1、是否有调用EMClient.getInstance().pushManager().disableOfflinePush去设置离线推送免打扰时间

2、如果是群组消息是否有调用EMClient.getInstance().pushManager().updatePushServiceForGroup去屏蔽群组离线推送

如果以上两步都没有去设置,需要提供消息内容、消息时间和接收方id反馈给环信来查