最近在研究推播相關的技術,專案後端用的是信鴿,所以客戶端也選擇了信鴿 SDK。
第三方推播的基本原理是:客戶端建立一個廣播接收器,當伺服器要發送訊息時先送到信鴿,信鴿再統一轉發,接收器收到後自行處理。
這裡實作的功能比較簡單:App 處於前台運行時,在主頁面用彈窗呈現推播內容;若 App 不在運行狀態且 Service 尚未被銷毀,則走系統預設的通知樣式。
要在主頁面彈出提示,做法是讓廣播接收器收到訊息後透過觀察者模式把資料轉發給主介面。
官方 Demo 下載:https://xg.qq.com/xg/help/ctr_help/download
修改後的 Demo:https://download.csdn.net/detail/qq_29774291/9635735
1. 依官方範例配置權限與服務
部分服務名稱需要替換成自己的包名。
2. 匯入廣播接收器
把官方的接收器複製進專案,並在清單檔中註冊。
3. 填入三組 AccessKey 設定
<meta-data android:name="com.tencent.rdm.uuid" android:value="eb5fa555d70c3246a4944f55be8c266b" /> <!-- 【必須】請修改為 APP 的 AccessId,「21」開頭的 10 位數字,中間無空格 --> <meta-data android:name="XG_V2_ACCESS_ID" android:value="2100219302" /> <!-- 【必須】請修改為 APP 的 AccessKey,「A」開頭的 12 位字串,中間無空格 --> <meta-data android:name="XG_V2_ACCESS_KEY" android:value="A15KJ71W9ELC" />
4. 在主介面註冊信鴿,取得 token
註冊成功後會拿到 token,上傳給後端即可接收推播。信鴿後台也能直接發送訊息,不過實測從後台發送的訊息偶爾會收不到,這點穩定性不如極光推播。
提醒:XGPushConfig.enableDebug(this, true); 這行在正式發布前務必改為 false 或直接移除。
// 信鴿 start
private String token;
private Message message = null;
private void XGInit() {
XGPushConfig.enableDebug(this, true);
// 若需知道註冊結果,使用帶 callback 的 registerPush 版本
// 若需綁定帳號,使用 registerPush(context, account) 版本
Handler handler = new HandlerExtension(MainActivity.this);
message = handler.obtainMessage();
XGPushManager.registerPush(getApplicationContext(), new XGIOperateCallback() {
@Override
public void onSuccess(Object data, int flag) {
Log.d("jiejie", "+++ register push sucess. token:" + data + " " + flag);
token = data + "";
message.obj = "+++ register push sucess. token:" + data;
System.out.println(token);
message.sendToTarget();
}
@Override
public void onFail(Object data, int errCode, String msg) {
Log.d("jiejie", "+++ register push fail. token:" + data + ", errCode:" + errCode + ",msg:" + msg);
message.obj = "+++ register push fail. token:" + data + ", errCode:" + errCode + ",msg:" + msg;
message.sendToTarget();
}
});
}
private static class HandlerExtension extends Handler {
WeakReference<MainActivity> mActivity;
HandlerExtension(MainActivity activity) {
mActivity = new WeakReference<MainActivity>(activity);
}
@Override
public void handleMessage(Message msg) {
super.handleMessage(msg);
MainActivity theActivity = mActivity.get();
if (theActivity == null) {
theActivity = new MainActivity();
}
if (msg != null) {
Log.d(Constants.LogTag, msg.obj.toString());
System.out.println("ddd" + msg.obj.toString());
}
}
}
5. 判斷 App 是否在前台
改造接收器的 onTextMessage 之前,得先知道 App 的運行狀態。
/**
* 判斷是否運行在前台
*/
public static boolean isRunningForeground(Context context) {
String packageName = getPackageName(context);
String topActivityClassName = getTopActivityName(context);
Log.d("TAG", "packageName=" + packageName + ",topActivityClassName=" + topActivityClassName);
if (packageName != null && topActivityClassName != null
&& topActivityClassName.startsWith(packageName)) {
Log.d("TAG", "---> isRunningForeGround");
return true;
} else {
Log.d("TAG", "---> isRunningBackGround");
return false;
}
}
// 方法二:透過 RunningAppProcessInfo 判斷(不需額外權限)
public static boolean isBackground(Context context) {
ActivityManager activityManager = (ActivityManager) context.getSystemService(Context.ACTIVITY_SERVICE);
List<RunningAppProcessInfo> appProcesses = activityManager.getRunningAppProcesses();
for (RunningAppProcessInfo appProcess : appProcesses) {
if (appProcess.processName.equals(context.getPackageName())) {
if (appProcess.importance == RunningAppProcessInfo.IMPORTANCE_BACKGROUND) {
Log.i("後台", appProcess.processName);
return true;
} else {
Log.i("前台", appProcess.processName);
return false;
}
}
}
return false;
}
6. 用 EventBus 在接收器中轉發訊息
// 訊息透傳
@Override
public void onTextMessage(Context context, XGPushTextMessage message) {
String text = "收到消息:" + message.toString();
EventBus.getDefault().post(text);
System.out.println(text);
// 取得自訂 key-value
PushTextMessage pushTextMessage = new PushTextMessage();
String title = message.getTitle();
String content = message.getContent();
pushTextMessage.setTitle(title);
pushTextMessage.setContent(content);
String customContent = message.getCustomContent();
if (customContent != null && customContent.length() != 0) {
try {
CustomContent custom = com.alibaba.fastjson.JSONObject.parseObject(customContent, CustomContent.class);
if (custom != null) {
pushTextMessage.setCustomContent(custom);
}
} catch (Exception e) {
e.printStackTrace();
}
}
show(context, text);
Log.d("jiejie", "pushTextMessage:" + pushTextMessage);
try {
boolean isForeground = AppUtil.isRunningForeground(context);
Log.d("jiejie", isForeground + "d");
if (isForeground) {
EventBus.getDefault().post(pushTextMessage);
} else {
notify(context, title, content);
}
} catch (Exception e) {
e.printStackTrace();
}
}
7. 主介面接收 EventBus 訊息並彈窗
@Subscribe
public void onMessageReviced(final PushTextMessage pushTextMessage) {
Log.d("jiejie", "好" + " 標題" + pushTextMessage.getTitle()
+ " 內容:" + pushTextMessage.getContent()
+ "CustomContent" + pushTextMessage.getCustomContent().getCmd());
if (pushTextMessage != null) {
showAlertDialog(this, pushTextMessage);
}
}
private void showAlertDialog(Context context, PushTextMessage text) {
AlertDialog.Builder dialog = new AlertDialog.Builder(context);
dialog.setTitle("推送的標題");
dialog.setMessage(text.getContent());
dialog.setPositiveButton("確認", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface arg0, int arg1) { }
});
AlertDialog mDialog = dialog.create();
mDialog.show();
}
@Override
protected void onDestroy() {
super.onDestroy();
EventBus.getDefault().unregister(this);
}
最後別忘了在銷毀時反註冊 EventBus,避免記憶體洩漏。整體流程就是:信鴿接收器收訊 → 判斷前後台 → 前台走 EventBus 彈窗,後台走系統通知。