Flutter消息推送注册插件push_message_register的使用
Flutter消息推送注册插件push_message_register的使用
注册xiaomi、huawei、oppo、vivo、meizu推送,获取设备品牌和token(2022-02更新品牌SDK)。你需要将token和品牌传递给你的web服务器,通过设备制造商的SDK推送通知信息,最后通过deeplink启动APP。
步骤:
- 注册并获取token
- 将token保存到web服务器
- 使用品牌SDK推送通知信息
此项目使用了Github上的push_message_register插件。 flutter_mycommunity_app
应用
if(Platform.isAndroid) {
_pushMessageRegister.onReceiveMessage().listen((event) {
if (event != null) {
if (event["result"] == "success") {
Global.devicetoken = event["token"].toString();
Global.brand = event["brand"].toString();
if (Global.profile.user != null) {
_userService.updatePushToken(
Global.profile.user!.uid, Global.profile.user!.token!,
Global.brand, Global.devicetoken, (error, msg) {
ShowMessage.showToast(msg);
});
}
}
}
});
//vivo配置在AndroidManifest.xml
Map apikey = {
"XIAOMI_APP_ID": "xiaomi appid",
"XIAOMI_APP_KEY": "xiaomi key",
"HUAWEI_APP_ID": "huawei appid",
"HUAWEI_APP_KEY": "",//不要填写
"OPPO_APP_KEY": "oppo key",
"OPPO_APP_SECRET": "oppo secret",
"MEIZU_APP_ID": "meizu appid",
"MEIZU_APP_KEY": "meizu appkey"
};
_brand = await PushMessageRegister.registerApi(apikey);
}
if(Platform.isIOS || _brand == "other"){
//_registerFcmOrApns(connector);
}
配置
- uses-permission
<uses-permission android:name="com.huawei.android.launcher.permission.CHANGE_BADGE" /> <!-- 华为图标 -->
<uses-permission android:name="com.vivo.notification.permission.BADGE_ICON" /> <!-- VIVO图标 -->
<uses-permission android:name="android.permission.VIBRATE" /> <!-- 小米 -->
<uses-permission android:name="android.permission.WAKE_LOCK" /> <!-- 允许程序在手机屏幕关闭后仍然运行后台进程,保持长链接 -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" /> <!-- 允许应用程序访问手机状态 -->
<uses-permission android:name="android.permission.RECEIVE_USER_PRESENT" /> <!-- 允许应用程序接收点亮屏幕或解锁广播 -->
<uses-permission android:name="android.permission.RESTART_PACKAGES" /> <!-- 允许程序结束任务,用户关闭推送服务时,推送服务退出 -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> <!-- 允许程序写入外部存储以保存SDK运行日志 -->
<uses-permission android:name="android.permission.GET_TASKS" /> <!-- 允许程序获取任务信息 -->
<uses-permission android:name="com.heytap.mcs.permission.RECIEVE_MCS_MESSAGE" /> <!-- OPPO推送 -->
<uses-permission android:name="com.coloros.mcs.permission.RECIEVE_MCS_MESSAGE" /> <!-- OPPO推送 -->
<!-- 兼容Flyme5权限配置 -->
<uses-permission android:name="com.meizu.flyme.push.permission.RECEIVE" />
<permission android:name="com.jiandanyidian.flutter_mycommunity_app.push.permission.MESSAGE"
android:protectionLevel="signature"/>
<uses-permission android:name="com.jiandanyidian.flutter_mycommunity_app.push.permission.MESSAGE" />
<!-- 兼容Flyme3权限配置 -->
<uses-permission android:name="com.meizu.c2dm.permission.RECEIVE" />
<permission android:name="com.jiandanyidian.flutter_mycommunity_app.permission.C2D_MESSAGE" android:protectionLevel="signature"/>
<uses-permission android:name="com.jiandanyidian.flutter_mycommunity_app.permission.C2D_MESSAGE"/>
<permission
android:name="com.mycommunity_app.flutter_mycommunity_app.permission.MIPUSH_RECEIVE"
android:protectionLevel="signature" /> <!-- 小米推送 -->
<uses-permission android:name="com.mycommunity_app.flutter_mycommunity_app.permission.MIPUSH_RECEIVE" /> <!-- 小米推送 -->
- 华为手机
在android/app/build.gradle
中添加以下依赖:
dependencies {
classpath 'com.huawei.agconnect:agcp:1.6.0.300'
}
在android/app/build.gradle
中添加以下依赖:
dependencies {
implementation 'com.huawei.hms:push:6.1.0.300'
}
apply plugin: 'com.android.application'
apply plugin: 'com.huawei.agconnect'
在AndroidManifest.xml
中添加以下服务:
<service
android:name="com.jiandanyidian.push_message_register.HuaWeiReceiver" android:exported="false">
<intent-filter>
<action android:name="com.huawei.push.action.MESSAGING_EVENT" />
</intent-filter>
</service>
- 小米手机
在AndroidManifest.xml
中添加以下服务:
<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
android:name="com.xiaomi.push.service.XMPushService"
android:enabled="true"
android:process=":pushservice" />
<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" />
<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.jiandanyidian.push_message_register.XiaoMiReceiver" android:exported="true">
<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>
- OPPO手机
在AndroidManifest.xml
中添加以下服务:
<service android:name="com.jiandanyidian.push_message_register.OppoCompatibleDataMessageCallbackService" 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.jiandanyidian.push_message_register.OppoDataMessageCallbackService" android:permission="com.heytap.mcs.permission.SEND_PUSH_MESSAGE">
<intent-filter>
<action android:name="com.heytap.mcs.action.RECEIVE_MCS_MESSAGE"/>
<action android:name="com.heytap.msp.push.RECEIVE_MCS_MESSAGE"/>
</intent-filter>
</service>
- VIVO手机
在AndroidManifest.xml
中添加以下元数据和接收器:
<meta-data android:name="sdk_version_vivo"
android:value="484"/>
<meta-data
android:name="com.vivo.push.api_key"
android:value="api_key"/>
<meta-data
android:name="com.vivo.push.app_id"
android:value="app_id"/>
<receiver android:name="com.jiandanyidian.push_message_register.VivoReceiver"
android:exported="false">
<intent-filter>
<action android:name="com.vivo.pushclient.action.RECEIVE"/>
</intent-filter>
</receiver>
- 魅族手机
(魅族手机的具体配置步骤未提供)
SDK
- 华为:HMS Core SDK
- 小米:小米 Android SDK
- VIVO:VIVO Android SDK
- OPPO:OPPO Android SDK
- 魅族:魅族 Android SDK
iOS 和 FCM
- iOS:flutter_apns
- FCM:firebase_messaging
完整示例Demo
import 'package:flutter/material.dart';
import 'dart:async';
import 'package:flutter/services.dart';
import 'package:push_message_register/push_message_register.dart';
void main() {
runApp(const MyApp());
}
class MyApp extends StatefulWidget {
const MyApp({Key? key}) : super(key: key);
[@override](/user/override)
State<MyApp> createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
PushMessageRegister _pushMessageRegister = PushMessageRegister();
String _brand = "other";
[@override](/user/override)
void dispose() {
// TODO: implement dispose
super.dispose();
_pushMessageRegister.destroy();
}
[@override](/user/override)
void initState() {
super.initState();
initPlatformState();
}
Future<void> initPlatformState() async {
// Platform messages may fail, so we use a try/catch PlatformException.
// We also handle the message potentially returning null.
try {
_pushMessageRegister.onReceiveMessage().listen((event) {
print(event);
});
//vivo配置在AndroidManifest.xml
Map apikey = {
"XIAOMI_APP_ID": "xiaomi appid",
"XIAOMI_APP_KEY": "xiaomi key",
"HUAWEI_APP_ID": "huawei appid",
"HUAWEI_APP_KEY": "", // 不要填写
"OPPO_APP_KEY": "oppo key",
"OPPO_APP_SECRET": "oppo secret",
"MEIZU_APP_ID": "meizu appid",
"MEIZU_APP_KEY": "meizu appkey"
};
_brand = await PushMessageRegister.registerApi(apikey);
if (_brand == "other") {
// 非以上品牌手机使用fcm或apns
}
} on PlatformException {
_brand = 'Failed ';
}
// 如果在异步平台消息还在飞行时小部件从树中移除,我们希望丢弃回复而不是调用
// setState 更新我们的不存在的外观。
if (!mounted) return;
setState(() {});
}
[@override](/user/override)
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('插件示例应用'),
),
body: Center(
child: Text('运行于: $_brand\n'),
),
),
);
}
}
更多关于Flutter消息推送注册插件push_message_register的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html
更多关于Flutter消息推送注册插件push_message_register的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html
push_message_register
是一个用于在 Flutter 应用中注册消息推送的插件。它通常用于处理推送通知的注册、接收和处理。以下是如何使用 push_message_register
插件的基本步骤:
1. 添加依赖
首先,你需要在 pubspec.yaml
文件中添加 push_message_register
插件的依赖:
dependencies:
flutter:
sdk: flutter
push_message_register: ^1.0.0 # 请使用最新版本
然后运行 flutter pub get
来获取依赖。
2. 导入插件
在你的 Dart 文件中导入 push_message_register
插件:
import 'package:push_message_register/push_message_register.dart';
3. 初始化插件
在应用的 main
函数中初始化插件:
void main() async {
WidgetsFlutterBinding.ensureInitialized();
await PushMessageRegister.initialize();
runApp(MyApp());
}
4. 注册推送服务
在需要注册推送服务的地方调用 register
方法:
Future<void> registerForPushNotifications() async {
try {
String token = await PushMessageRegister.register();
print("Push Token: $token");
// 你可以将 token 发送到你的服务器
} catch (e) {
print("Failed to register for push notifications: $e");
}
}
5. 处理推送消息
你可以通过监听 onMessageReceived
来处理接收到的推送消息:
PushMessageRegister.onMessageReceived.listen((message) {
print("Received message: $message");
// 在这里处理推送消息
});
6. 处理后台消息
如果需要在后台处理推送消息,你可以使用 onBackgroundMessage
:
Future<void> _backgroundMessageHandler(Map<String, dynamic> message) async {
print("Background message received: $message");
// 在这里处理后台推送消息
}
void main() async {
WidgetsFlutterBinding.ensureInitialized();
PushMessageRegister.setBackgroundMessageHandler(_backgroundMessageHandler);
await PushMessageRegister.initialize();
runApp(MyApp());
}
7. 取消注册
如果你想取消推送注册,可以调用 unregister
方法:
Future<void> unregisterPushNotifications() async {
try {
await PushMessageRegister.unregister();
print("Push notifications unregistered");
} catch (e) {
print("Failed to unregister push notifications: $e");
}
}
8. 处理权限
在某些平台上,你可能需要请求推送通知的权限:
Future<void> requestNotificationPermission() async {
bool granted = await PushMessageRegister.requestPermission();
if (granted) {
print("Notification permission granted");
} else {
print("Notification permission denied");
}
}
9. 处理平台特定配置
对于不同的平台(如 iOS 和 Android),你可能需要进行一些额外的配置。例如,在 iOS 上,你需要在 Info.plist
文件中添加推送通知权限:
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>
<key>NSLocalNotificationUsageDescription</key>
<string>We need to send you notifications</string>