一、极光推送介绍
说起推送,不得不提到极光,高效,稳定,最重要的是免费(用户量不是非常大的情况下),让它在推送界占据了很高地位,如果没有完全没有用过的话,还是要花点时间去研究一下,或者遇到一些问题,下面我详细地一步一步来介绍它,废话不多说,一起操练起来吧。
二、使用
1.集成
极光的文档集成这块还是很详细的,有自动集成和手动集成两种 ,推荐自动集成,除非你有特殊的癖好
确认android studio的 Project 根目录的主 gradle 中配置了jcenter支持。(新建project默认配置就支持)
buildscript {
repositories {
jcenter()
}
......
}
allprojets {
repositories {
jcenter()
}
}
AndroidManifest的替换变量。
android { ...... defaultConfig { applicationId "com.xxx.xxx" //应用的applicationId,极光说是包名,但应该是applicationId更严谨一下,可以和包名不一致 ...... ndk { //选择要添加的对应cpu类型的.so库。 abiFilters 'armeabi', 'armeabi-v7a', 'arm64-v8a' //一般这几个就行了,毕竟Android手机基本都是arm // 还可以添加 'x86', 'x86_64', 'mips', 'mips64' } manifestPlaceholders = [ JPUSH_PKGNAME : applicationId, //
注意这里不是让你替换成你的applicationId,不要动
JPUSH_APPKEY : "你的appkey", //JPush上注册的包名对应的appkey. JPUSH_CHANNEL : "developer-default", //暂时填写默认值即可. ] ...... } ...... }
在 module 的 gradle 中添加依赖
dependencies { ...... compile 'cn.jiguang.sdk:jpush:3.0.9' // 此处以JPush 3.0.9 版本为例。 compile 'cn.jiguang.sdk:jcore:1.1.7' // 此处以JCore 1.1.7 版本为例。 ...... }
注 : 如果在添加以上 abiFilter 配置之后android Studio出现以下提示:
NDK integration is deprecated in the current plugin. Consider trying the new experimental plugin
则在 Project 根目录的gradle.properties文件中添加:
android.useDeprecatedNdk=true
注意在使用前要在Application中调用JpushInterface.init(this);进行初始化
三、配置别名和标签
别名(Alias),一个用户只能设置一个,String类型
标签(Tag),一个用户可以设置多个,Set<String>类型
不一定都要设置,可以根据自己需要只设置某一项,或者都设置
从3.0.7开始别名,标签的设置方法发生了变化,这里只介绍新的,推荐新的方法,比老方法更好。可以下载官方的Demo看一下,官方的Demo中有一个TagAliasOperatorHelper类,这个是设置的核心类。
下面的方法是核心方法public void handleAction(Context context,int sequence, TagAliasBean tagAliasBean){
init(context);
if(tagAliasBean == null){
Logger.w(TAG,"tagAliasBean was null");
return;
}
put(sequence,tagAliasBean);
if(tagAliasBean.isAliasAction){
switch (tagAliasBean.action){
case ACTION_GET:
JPushInterface.getAlias(context,sequence);
break;
case ACTION_DELETE:
JPushInterface.deleteAlias(context,sequence);
break;
case ACTION_SET:
JPushInterface.setAlias(context,sequence,tagAliasBean.alias);
break;
default:
Logger.w(TAG,"unsupport alias action type");
return;
}
}else {
switch (tagAliasBean.action) {
case ACTION_ADD:
JPushInterface.addTags(context, sequence, tagAliasBean.tags);
break;
case ACTION_SET:
JPushInterface.setTags(context, sequence, tagAliasBean.tags);
break;
case ACTION_DELETE:
JPushInterface.deleteTags(context, sequence, tagAliasBean.tags);
break;
case ACTION_CHECK:
//一次只能check一个tag
String tag = (String)tagAliasBean.tags.toArray()[0];
JPushInterface.checkTagBindState(context,sequence,tag);
break;
case ACTION_GET:
JPushInterface.getAllTags(context, sequence);
break;
case ACTION_CLEAN:
JPushInterface.cleanTags(context, sequence);
break;
default:
Logger.w(TAG,"unsupport tag action type");
return;
}
}
}
这个方法封装了Alias和Tag的所有操作,当然也可以自己封装,三个参数,第一个,context是Applicaiton的上下文(因为我的ApplicationContext可以在Application中直接取到,所以去掉了这个参数),第二个,sequence 代表一个序号,这个是和老方法的主要区别,目的是区分设置的序号,本类静态成员变量,需要注意的是在调用之前一定要先把它+1,不然会有问题。第三个参数tagAliasBean是一个自定义的类,里面有放了设置的主要信息。
handleAction方法以tagAliasBean中的isAliasAction来区分是操作Alias的还是操作Tag的,true为Alias,false为Tag。
具体的操作是设置,删除还是别的,以tagAliasBean中的action来区分,action的值在类中有定义。前面的一切都是铺垫,甚至可以不用Demo的方法,自己封装方法来控制sequence的变化即可,下面的方法才是真正的开始设置,以设置Alias为例
JPushInterface.setAlias(context,sequence,tagAliasBean.alias);
设置了之后如何查看操作是否成功呢?下面看一下回调方法,首先用一个类如MyJpushMessageReceiver继承JpushMessageReceiver类,然后在清单文件中按照要求配置一下,并在类中实现回调方法
<receiver android:name=".infrastructure.listener.MyJpushMessageReceiver">
<intent-filter>
<action android:name="cn.jpush.android.intent.RECEIVE_MESSAGE" />
<category android:name="com.bravolinks.wemeeting.wemeetingcustomer_test"/>
</intent-filter>
</receiver>
/**
* 设置标签回调
* @param jPushMessage
*/
public void onTagOperatorResult(Context context, JPushMessage jPushMessage) {
TagAliasHelper.getInstance().onTagOperatorResult(jPushMessage);
super.onTagOperatorResult(context,jPushMessage);
}
/**
* 设置别名回调
* @param jPushMessage
*/
public void onAliasOperatorResult(Context context,JPushMessage jPushMessage) {
TagAliasHelper.getInstance().onAliasOperatorResult(jPushMessage);
super.onAliasOperatorResult(context,jPushMessage);
}
/**
* 检查Tag设置
* @param context
* @param jPushMessage
*/
public void onCheckTagOperatorResult(Context context,JPushMessage jPushMessage){
TagAliasHelper.getInstance().onCheckTagOperatorResult(context,jPushMessage);
super.onCheckTagOperatorResult(context,jPushMessage);
}
之所以得到回调结果中要把结果调回TagAliasOperatorHepler中,是因为如果设置失败的话,还要再进行处理,下面看一下TagAliasOperatorHepler中的回调方法。以Alias为例
public void onAliasOperatorResult(Context context, JPushMessage jPushMessage) {
int sequence = jPushMessage.getSequence();
Logger.i(TAG,"action - onAliasOperatorResult, sequence:"+sequence+",alias:"+jPushMessage.getAlias());
init(context);
//根据sequence从之前操作缓存中获取缓存记录
TagAliasBean tagAliasBean = tagAliasActionCache.get(sequence);
if(tagAliasBean == null){
ExampleUtil.showToast("获取缓存记录失败", context);
return;
}
if(jPushMessage.getErrorCode() == 0){
Logger.i(TAG,"action - modify alias Success,sequence:"+sequence);
tagAliasActionCache.remove(sequence);
String logs = getActionStr(tagAliasBean.action)+" alias success";
Logger.i(TAG,logs);
ExampleUtil.showToast(logs, context);
}else{
String logs = "Failed to " + getActionStr(tagAliasBean.action)+" alias, errorCode:" + jPushMessage.getErrorCode();
Logger.e(TAG, logs);
if(!RetryActionIfNeeded(jPushMessage.getErrorCode(),tagAliasBean)) {
ExampleUtil.showToast(logs, context);
}
}
}
jPushMessage.getErrorCode() == 0代表设置成功,设置成功的话移除掉之前存储的设置信息,这就是要在调用handleAction前,把sequecen+1的原因,如果同时设置Alias和Tag,因为sequece是相同的,先设置成功的一个会把存储的信息remove掉,后面设置回调的方法里就取不到了。
如果因为网络原因设置失败的话(返回的错误码为6002 超时,6014 服务器繁忙,都建议延迟重试),可以利用Hander再次设置。可以参考下面的方法
private boolean RetryActionIfNeeded(int errorCode,TagAliasBean tagAliasBean){ if(!ExampleUtil.isConnected(context)){ Logger.w(TAG,"no network"); return false; } //返回的错误码为6002 超时,6014 服务器繁忙,都建议延迟重试 if(errorCode == 6002 || errorCode == 6014){ Logger.d(TAG,"need retry"); if(tagAliasBean!=null){ Message message = new Message(); message.what = DELAY_SEND_ACTION; message.obj = tagAliasBean; delaySendHandler.sendMessageDelayed(message,1000*60); String logs =getRetryStr(tagAliasBean.isAliasAction, tagAliasBean.action,errorCode); ExampleUtil.showToast(logs, context); return true; } } return false; }
private Handler delaySendHandler = new Handler(){
@Override
public void handleMessage(Message msg) {
switch (msg.what){
case DELAY_SEND_ACTION:
if(msg.obj !=null && msg.obj instanceof TagAliasBean){
Logger.i(TAG,"on delay time");
sequence++;
TagAliasBean tagAliasBean = (TagAliasBean) msg.obj;
tagAliasActionCache.put(sequence, tagAliasBean);
if(context!=null) {
handleAction(context, sequence, tagAliasBean);
}else{
Logger.e(TAG,"#unexcepted - context was null");
}
}else{
Logger.w(TAG,"#unexcepted - msg obj was incorrect");
}
break;
}
}
};
注:Alias和Tag是不用每次启动App都要设置的,可以用SharePreference来标记是否设置成功。记得用户退出登录的时候调用清除
Alias和Tag的方法,并把SharePreference的值改变。
Alias和Tag设置成功要怎么接收消息呢,极光推送分为通知和自定义消息,通知的话是默认有通知栏且不可取消,自定义消息可以自己写通知栏,因为项目中使用的是通知,这里只介绍通知。用一个类如JpushReceiver继承BroadcastRecevier并实现onReceive方法,在清单文件中按要求配置,如下
<receiver android:name=".infrastructure.listener.JPushReceiver" android:enabled="true" android:exported="false"> <intent-filter> <action android:name="cn.jpush.android.intent.REGISTRATION" /> <!--Required 用户注册SDK的intent--> <action android:name="cn.jpush.android.intent.MESSAGE_RECEIVED" /> <!--Required 用户接收SDK消息的intent--> <action android:name="cn.jpush.android.intent.NOTIFICATION_RECEIVED" /> <!--Required 用户接收SDK通知栏信息的intent--> <action android:name="cn.jpush.android.intent.NOTIFICATION_OPENED" /> <!--Required 用户打开自定义通知栏的intent--> <action android:name="cn.jpush.android.intent.CONNECTION" /><!-- 接收网络变化 连接/断开 since 1.6.3 --> <category android:name="你的applicationId" /> </intent-filter> </receiver>
下面接收的方法中就可以进行处理了
@Override public void onReceive(Context context, Intent intentReceive) { String action = intentReceive.getAction(); Bundle bundle = intentReceive.getExtras(); //-------------------------------接收到通知------------------------------- if (JPushInterface.ACTION_NOTIFICATION_RECEIVED.equals(action)) { String extra = bundle.getString(JPushInterface.EXTRA_EXTRA); String alert = bundle.getString(JPushInterface.EXTRA_ALERT); //----------------------------点击了通知------------------------------------ } else if (JPushInterface.ACTION_NOTIFICATION_OPENED.equals(action)) { String extra = bundle.getString(JPushInterface.EXTRA_EXTRA); } }
四、其他说明
设置好Alias和Tag,可以利用极光后台进行发送通知的测试,来看是否能够接收到通知。
所有的推送记录都能够在极光后台中查询到(后台推送的要切换成api查看),如果推送有问题,可以去后台看看推送记录,再分析具体是哪个环节出现了问题。
如有错误或者任何问题,可以跟我回复,希望大家都能用的顺利,愉快,哈哈哈