Flutter TPNS
1. 基本接入
1.1 環境配置
小編在接入 Flutter TPNS 時，需要在 Flutter 和 Android 兩端進行插件的安裝配置；
-
Flutter
在工程 pubspec.yaml 中 dependencies 下引入 tpns_flutter_plugin 插件；
dependencies:
flutter:
sdk: flutter
tpns_flutter_plugin:
git:
url: https://github.com/TencentCloud/TPNS-Flutter-Plugin
ref: V1.0.7
-
Android
在 app build.gradle 檔案下配置 ID 和 KEY 以及支持的 .so 庫；
defaultConfig {
applicationId "com.ace.plugin.flutter_app07"
minSdkVersion 16
targetSdkVersion 28
versionCode flutterVersionCode.toInteger()
versionName flutterVersionName
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
ndk {
abiFilters 'armeabi', 'armeabi-v7a', 'x86', 'x86_64', 'mips', 'mips64', 'arm64-v8a', 'arm6'
}
manifestPlaceholders = [
XG_ACCESS_ID : "1500018481",
XG_ACCESS_KEY : "AW8Y2K3KXZ38",
]
}
1.2 方法使用
我按照官網的介紹嘗試了一些常用的 API 方式，主要分為應用類，賬號類和標簽類三種 API，小菜業務中沒有應用賬號和標簽模塊，暫未深入研究；
- 應用介面 API
a. 注冊推送服務
對于服務的注冊初始化，可以在首次進入應用 initState() 中直接初始化，也可以根據業務邏輯在固定的位置進行初始化，需要傳遞申請的賬號 ID 和 KEY；注冊成功之后會在 onRegisteredDone() 中進行回呼，并獲取對應設備的唯一 Token；
XgFlutterPlugin().startXg("1500018481", "AW8Y2K3KXZ38");
// 注冊回呼
XgFlutterPlugin().addEventHandler(
onRegisteredDone: (String msg) async {
print("HomePage -> onRegisteredDone -> $msg");
_showDialog('注冊成功', msg);
},
);
b. 注銷推送服務
服務的注銷方法可以通過 stopXg() 進行處理，并在 unRegistered 進行回呼監聽；
XgFlutterPlugin().stopXg();
// 注銷回呼
XgFlutterPlugin().addEventHandler(
unRegistered: (String msg) async {
print("HomePage -> unRegistered -> $msg");
},
);
c. 設備推送標識
對于設備唯一標識的獲取，可以通過注冊初始化成功之后獲取，也可以通過 XgFlutterPlugin.xgToken 獲取唯一 Token；
Future<void> getTPNSToken(title) async {
try {
String xgToken = await XgFlutterPlugin.xgToken;
print('HomePage -> getTPNSToken -> $xgToken');
_showDialog(title, xgToken);
} catch (e) {
print(e.toString());
}
}
d. 上報角標數
對于桌面角標，在通知類訊息中 華為 和 小米 設備在開啟權限之后，接收通知會由桌面角標的更新；而 TPNS 提供的 setBadge() 只有在 iOS 環境下支持，對于 Android 環境下的透傳型別或其他廠商設備的支持，可以通過 Flutter 與 Native 通信來由原生實作；
e. SDK 版本
TPNS SDK 版本可以通過 XgFlutterPlugin.xgSdkVersion 獲取；
Future<void> getTPNSSDKVersion(title) async {
try {
String sdkVersion = await XgFlutterPlugin.xgSdkVersion;
print('HomePage -> getTPNSSDKVersion -> $sdkVersion');
_showDialog(title, sdkVersion);
} catch (e) {
print(e.toString());
}
}
-
賬號介面 API
TPNS 提供了個性化服務，關于賬號的系結和解綁等功能，可以根據具體的業務邏輯進行處理；
String inputStr = "ACE_Flutter";
// 設定賬號
XgFlutterPlugin().setAccount(inputStr, AccountType.UNKNOWN);
// 解綁賬號
XgFlutterPlugin().deleteAccount(inputStr, AccountType.UNKNOWN);
// 清空賬號
XgFlutterPlugin().cleanAccounts();
XgFlutterPlugin().addEventHandler(
xgPushDidBindWithIdentifier: (String msg) async {
print("HomePage -> xgPushDidBindWithIdentifier -> $msg");
_showDialog('系結標簽 $inputStr', msg);
},
xgPushDidUnbindWithIdentifier: (String msg) async {
print("HomePage -> xgPushDidUnbindWithIdentifier -> $msg");
_showDialog('解綁賬號', msg);
},
xgPushDidClearAllIdentifiers: (String msg) async {
print("HomePage -> xgPushDidClearAllIdentifiers -> $msg");
_showDialog('清除全部賬號', msg);
}
)
-
標簽介面 API
TPNS 的用戶標簽功能比較強大，可以針對性的進行地理圍欄或標簽分布的推送；TPNS 提供了系結和解綁標簽，更新和清理標簽等功能，方便針對性的進行資料推送；
String inputStr = "ACE_Flutter";
// 系結標簽
XgFlutterPlugin().addTags([inputStr]);
// 解綁標簽
XgFlutterPlugin().deleteTags([inputStr]);
// 更新標簽
XgFlutterPlugin().setTags([inputStr]);
// 清除標簽
XgFlutterPlugin().cleanTags();
2. 通知類訊息
小編在上一篇文章中介紹了 TPNS 訊息發布后臺，不管是哪種方式集成，發布后臺是一致的；
2.1 接收 & 展示
通知類 Push 在設備開啟權限時，接收訊息后會自動展示通知，這是由 TPNS SDK 實作好的，與原生一致，通知類 Push 標題和內容也只能以通過訊息后臺發布為準，不能自由更改；其中 通知類 Push 接收通過 onReceiveNotificationResponse() 方法回呼監聽；
XgFlutterPlugin().addEventHandler(
onReceiveNotificationResponse: (Map<String, dynamic> msg) async {
print("HomePage -> onReceiveNotificationResponse -> $msg");
_showDialog('通知類訊息接收', msg.toString());
},
);
2.2 點擊
通知類 Push 訊息點擊是通過 xgPushClickAction() 方法進行回呼，之后的業務邏輯可以根據訊息回傳的資訊進行處理；小編為了適配其他的 Push 型別，調整了點擊后的操作，默認為啟動 app，小編通常在【附加引數】中添加 Json 進行資料決議，在進行之后的業務處理；
XgFlutterPlugin().addEventHandler(
xgPushClickAction: (Map<String, dynamic> msg) async {
print("HomePage -> xgPushClickAction -> $msg");
_showDialog('通知類訊息點擊', msg.toString());
},
);
3. 透傳類訊息
透傳類 Push 相比 通知類 Push 要復雜一些，TPNS 只提供了 透傳類 Push 接收，不會進行 Notification 通知展示；因此小菜通過 Flutter-Native 訊息通信進行處理；其中 Notification 的展示點擊需要 Native 方面進行配合處理；
3.1 接收
透傳類 Push 通過 onReceiveMessage() 進行訊息接收的回呼監聽；之后，小編建立一個 MethodChannel 將訊息傳遞給 Android Native；
XgFlutterPlugin().addEventHandler(
onReceiveMessage: (Map<String, dynamic> msg) async {
print("HomePage -> onReceiveMessage -> $msg");
_showDialog('透傳類訊息接收', msg.toString());
await methodChannel
.invokeMethod('tpns_extras', msg['customMessage'])
.then((val) {
print("HomePage -> 透傳類訊息接收 -> $val");
if (val != null) {
_showDialog('透傳類訊息點擊', val);
}
});
},
);
3.2 展示
Flutter 端在接收到 透傳類 Push 訊息時，發送 MethodChannel 到 Android Native，Native 端在決議對應引數進行 Notification 展示；
@Override
public void configureFlutterEngine(@NonNull FlutterEngine flutterEngine) {
GeneratedPluginRegistrant.registerWith(flutterEngine);
new MethodChannel(flutterEngine.getDartExecutor().getBinaryMessenger(),
"com.ace.plugin.flutter_app/tpns_notification").setMethodCallHandler(new MethodChannel.MethodCallHandler() {
@Override
public void onMethodCall(MethodCall call, MethodChannel.Result result) {
if (call != null && call.method.equals("tpns_extras")) {
setNotification(MainActivity.this, call.arguments.toString());
mResult = result;
} else {
result.notImplemented();
}
}
});
}
3.3 點擊
Native 端展示 Notification 后，小編嘗試兩種方式，第一種是通過一個新的 BasicMessageChannel 來進行訊息通信到 Flutter 端，第二種是通過之前 Flutter 發送的 MethodChannel 進行 result 回呼；小編雖然應用了第二種方式，但更傾向于第一種，每個事件更加專一；
Flutter 端接收到 Native 發送或回傳的訊息后便可自由進行業務邏輯處理了；
private void setNotification(Context context, String extras) {
NotificationManager notificationManager = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
NotificationChannel channel =
new NotificationChannel("ace_push", "ace_push_name", NotificationManager.IMPORTANCE_HIGH);
if (notificationManager != null) {
notificationManager.createNotificationChannel(channel);
}
}
int notificationId = new java.util.Random().nextInt(1000);
//Intent intent = new Intent(MainActivity.this, TPNSNotificationReceiver.class);
//PendingIntent pendingIntent = PendingIntent.getBroadcast(MainActivity.this, 101, intent, 102);
Intent intent = new Intent(context, MainActivity.class);
intent.putExtra("push_extras", extras);
intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
PendingIntent pendingIntent =
PendingIntent.getActivity(context, notificationId, intent, PendingIntent.FLAG_CANCEL_CURRENT);
JSONObject json = JSONObject.parseObject(extras);
String extrasStr = json.getString("extras");
json = JSONObject.parseObject(extrasStr);
String title = json.getString("title");
String desc = json.getString("desc");
Notification notification = new NotificationCompat.Builder(context, "ace_push").setContentTitle(title)
.setContentText(desc)
.setContentIntent(pendingIntent)
.setWhen(System.currentTimeMillis())
.setSmallIcon(R.mipmap.ic_launcher)
.setAutoCancel(true)
.build();
notificationManager.notify(notificationId, notification);
}
3.4 注意事項
小編在 PendingIntent 中傳遞的頁面依舊是 MainActivity，可以根據具體的業務邏輯啟動專門的中轉頁面；其中使用 MainActivity 時需要，因為設定了 Flag 為 Intent.FLAG_ACTIVITY_NEW_TASK 因此注意資料的接收通過 onNewIntent 進行接收；
@Override
protected void onNewIntent(Intent intent) {
super.onNewIntent(intent);
if (intent != null && intent.getExtras() != null && intent.getExtras().containsKey("push_extras")) {
String extras = intent.getStringExtra("push_extras");
if (mResult != null) {
mResult.success(extras);
}
}
}
最后
小編在網上收集了一些 Android 開發相關的學習檔案、面試題、Android 核心筆記等等檔案，希望能幫助到大家學習提升，如有需要參考的可以直接點擊這里免費領取
轉載請註明出處，本文鏈接：https://www.uj5u.com/yidong/286981.html
標籤：其他