最近由于公司有需求需要集成OPPO平台的推送,所以在此处写下自己的心路历程,以便后来的人可以避免遇到跟笔者一样的坑。以下如果有错误的地方希望大家指出,谢谢各位看官。
OPPO开放平台:https://open.oppomobile.com/
首先介绍一下OPPO推送平台:
OPPO Push是OPPO公司向开发者提供的消息推送服务,通过服务端端与OS端建立的一条稳定、可靠的长连接通道,向OPPO手机系统(ColorOS)上的APP应用客户端实时推送消息的服务。在最新ColorOS系统上,会直接使用系统长连接通道,所有app会和系统共享一个长连接
通过消息推送服务,可有效的提升开发者应用的活跃和留存,改善产品体验。
1)支持平台
目前支持 ColorOS3.1及以上的系统的oppo的机型,一加5/5t及以上机型,realme所有机型。
2)通知消息类型
OPPO推送暂时只支持通知栏消息的推送。消息下发到OS系统模块并由系统通知模块展示,在用户点击通知前,不启动应用。整个过程环保省电。
2.1.主要功能
1)保持与服务器的长连接,以便消息能够即时推送到达客户端;
2)接收通知与自定义消息,并向开发者App 传递相关信息。
2.2.主要特点
1)客户端维持连接占用资源少、耗电低
2)SDK集成方便,接口功能齐全
3)服务器大容量、稳定
2.3.资源说明
4)AndroidManifest.xml:客户端嵌入SDK参考的配置文件;
5)Libs:OPush SDK 开发包;
6)OpushDemo:是一个完整的Android 项目,通过这个演示了OPush SDK的基本用法,可以用来做代码参考。
7)目前只支持通知栏消息,透传消息暂不支持
2.4.版本说明
目前SDK只支持Android 4.0或以上版本的手机系统。
OPPO推送数量限制如下图
公信和私信的区别详细的请查看:https://open.oppomobile.com/wiki/doc#id=10614
下面的集成教程主要分为两个部分:
第一部分主要是申请账号和申请appKey;(注意坑,已标注)
第二部分主要是代码上的实现;
第一部分介绍:
如果要集成推送的话,首先需要注册一个账号,这里我就不多说,只需要注意记住一点,我们需要选择主体类型为企业(当为主体为个人的时候不能创建App)点击即可填写相关信息。
主体类型为个人的账户会在后续接入推送时遇到以下场景
而主体类型为企业则如下,可以愉快的进行下去
这个时候点击创建应用,第一个选择框我个人选择的是普通应用,后面两个编辑框就不用我多说了,appname和applicationId 直接提交就好了
=====================坑来了=====================
看到下面这个证明你的app包名没有被注册过,但是不要以为这样就可以直接用appkey和appsecret,这个时候坑来了,我们需要点击一下“推送服务”,如下
然后可以看到下面这样一个页面,上面写得很清楚,这个时候需要“申请开通”一下,审核时间差不多一天(如果少了这一步,会出现这样一个错误:INVALID_APP_KEY = 14; // Invalid App Key,即:无效的AppKey参数)
申请成功之后,这里会出现如下字样:点击就可以直接进入消息推送平台
如何使用消息推送平台,官方提供了详细的文档,其实使用起来也很简单,
没使用过的可以点击这个链接直接进入
官方教程:https://open.oppomobile.com/wiki/doc#id=10198
到此为止 我们就把准备工作做好了,以下就开始看代码上的实现
第二部分介绍:
老规矩,下载官方demo,注意这里官方demo刚开始会运行不起来,又一个包下载不下来,我怀疑是OPPO内部的maven库无法访问导致的,这个时候我们只需要去官网下载一个jar包导入进来就OK了,笔者这里的jar包是 mcssdk-2.0.2.jar
SDK下载地址:https://open.oppomobile.com/wiki/doc#id=10201
直接下载 OPPO PUSH 客户端 SDK 解压导入jar,然后注视掉上面报错这行代码即可
// compile 'com.heytap.mcssdk:mcssdk:2.0.3-SNAPSHOT' 注视掉rebuild就好了
这个时候如果你想用官方demo测试,肯定是不行的,尽管demo里面提供了appkey和appsecret,但是这个已经过期了,并且由于applicationId重名不能被重新申请,那么如果想用官方demo测试就有一个蠢办法,修改官方demo的applicationId和appname。这里笔者就修改了官方demo,这里我就不赘述如何修改包名了,贴个修改包名的链接:https://www.e-learn.cn/content/qita/804868
首先在需要集成推送的module中的Manifast中加入权限申请
<uses-permission android:name="com.coloros.mcs.permission.RECIEVE_MCS_MESSAGE"/>
<uses-permission android:name="com.heytap.mcs.permission.RECIEVE_MCS_MESSAGE"/>
注册服务
<service
android:name="com.heytap.mcssdk.PushService"
android:permission="com.coloros.mcs.permission.SEND_MCS_MESSAGE">
<intent-filter>
<action android:name="com.coloros.mcs.action.RECEIVE_MCS_MESSAGE" />
</intent-filter>
</service>
<service android:name="com.heytap.mcssdk.AppPushService"
android:permission="com.heytap.mcs.permission.SEND_PUSH_MESSAGE">
<intent-filter>
<action android:name="com.heytap.mcs.action.RECEIVE_MCS_MESSAGE"/>
</intent-filter>
</service>
在自己的application的onCreate()方法里面初始化
PushManager.getInstance().register(getApplicationContext(), AppParam.appKey, AppParam.appSecret, new OPPOPushCallback());//setPushCallback接口也可设置callback
PushManager.getInstance().requestNotificationPermission();//申请通知栏权限
其实OPPOPushCallback类就是集成自PushAdapter的一个类,类里面主要关注onRegister()方法
@Override
public void onRegister(int code, String s) {
if (code == 0){
Log.i("bqt", "OPPO【注册成功,推送ID】=" + s);
BaseData.PUSH_ID = s; // 即我们需要的registerID
} else {
//失败之后的重试操作
// PushManager.getInstance().getRegister();
Log.i("bqt", "OPPO【注册失败,msg=" + s + " 错误码code : " + code);
}
}
这样下来初步的推送就算已经集成完成了
这里需要注意几个地方:
1,下面这行代码在android8.0之前都是没问题的,但是在Android8.0就存在适配问题,会出现推送之后在8.0的机型上无法展示出通知的问题,这一点也可以从推送运营平台的通知栏数据中看到
PushManager.getInstance().requestNotificationPermission();//申请通知栏权限
在消息推送平台已经提示了:
在官方问题技术问题列表中也有讲到:(https://open.oppomobile.com/wiki/doc#id=10200)
那么肯定要进行通道的适配了,其实官方也给了建议:
OPPO官方对此的讲解https://open.oppomobile.com/wiki/doc#id=10289
其实很简单,适配代码:请在初始化时一并调用
//oppo 设置通知通道 兼容Android8.0及以上机型
private static void notifyChannel(Application context) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
String channelId = "default";
String channelName = "Default_Channel";
String channelDescription = "this is default channel!";
NotificationChannel mNotificationChannel = new NotificationChannel(channelId, channelName, NotificationManager.IMPORTANCE_DEFAULT);
mNotificationChannel.setDescription(channelDescription);
((NotificationManager)context.getSystemService(Activity.NOTIFICATION_SERVICE)).createNotificationChannel(mNotificationChannel);
}
}
2,推送后的数据如何获取
这是官方给出的答案:但是在应用没有被启动的时候,点击推送的消息,这个方法不会被调用,所以应该在onCreate()里面加上相同的方法
目前笔者无法获取到推送消息的消息标题和消息内容,只能获取到拓展字段的内容,如果有看官能获取到,请留言,谢谢
解析参数的代码如下:
// 取参数值
if (getIntent().getExtras() != null) {
// 取参数值
Bundle bundle = getIntent().getExtras();
Set<String> set = bundle.keySet();
HashMap<String, String> hm = new HashMap<>();
if (set != null) {
for (String key : set) {
hm.put(key, bundle.getString(key));
}
}
Log.e("NPL", "hm的值是:" + hm.toString());
}
3,跳转打开APP的方法有三种,其实官网都有介绍
1:Intent action 注意manifest中需要启动的activity的action应该与推送运营平台保持一致
2:Activity manifest中需要启动的activity的全类名
3:Intent Scheme URL 方式 manifest代码:
<activity android:name="com.yitong.mbank.ly.hn.uat.component.AboutActivity"
android:screenOrientation="portrait"
android:launchMode="singleTop"
android:configChanges="orientation|screenSize"
android:exported="true"> //封装module的时候可以加上这个
<intent-filter>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.BROWSABLE" />
<category android:name="android.intent.category.DEFAULT" />
<data android:scheme="https" /> //打开网页时需要
<data android:scheme="http" /> //打开网页时需要
<data
android:host="pushtest"
android:path="/message"
android:scheme="command" />
</intent-filter>
</activity>
官网中没有提及要设置path,之所以写这个 主要是因为小米和华为都支持该种方式作为推送打开应用的一种方式,所以,我们这里为了跟其他平台的兼容,故添加了path
推送平台应为:
点击动作 选择 打开应用内页
Intent Scheme URL 值为: command://pushtest/message?key=value&key1=value1
推送后在AboutActivity的onCreate()中:
String intentUrl = intent.toUri(Intent.URI_INTENT_SCHEME);
Log.i("test"," == " + intentUrl);
//打印出来的内容为:
// intent://pushtest/message?key=value&key1=value1#Intent;scheme=command;launchFlags=0x30000000;package=com.yitong.mbank.ly.hn.uat;component=com.yitong.mbank.ly.hn.uat/.component.AboutActivity;end
最后解析这个打印出来的IntentUri就可以拿到对应的参数(key=value&key1=vaule1)