Flutter消息推送插件flutter_emas_push的使用

如何使用

在build.gradle中配置推送密钥

在build.gradle文件中配置阿里云的appKey和appSecret，以及其他厂商的推送密钥。

defaultConfig {
    applicationId "com.kevin.emaspush.flutter_emas_push_example" // 申请key的包名
    ...
    manifestPlaceholders = [
            emasPushAppKey   : "", // 阿里云的appKey
            emasPushAppSecret: "", // 阿里云的appSecret
            huaweiAppId      : "", // 华为的一定要配置签名文件
            miAppId          : "",
            miAppKey         : "",
            oppoAppKey       : "",
            oppoAppSecret    : "",
            vivoAppKey       : "",
            vivoAppId        : "", // 数字的要用反斜杠\\123456
            meizuAppId       : "",
            meizuAppKey      : "",
            sendId           : "", // GCM
            applicatinoId    : "", // GCM
            projectId        : "", // GCM
            apiKey           : ""  // GCM
    ]
}

在build.gradle中配置签名信息（华为推送需要）

signingConfigs {
    debug {
        storeFile file('xxx') // 签名文件路径
        storePassword 'xxx' // 密码
        keyAlias 'xxx' // 别名
        keyPassword 'xxx' // 密钥密码
    }
    release {
        storeFile file('xxx') // 签名文件路径
        storePassword 'xxx' // 密码
        keyAlias 'xxx' // 别名
        keyPassword 'xxx' // 密钥密码
    }
}

在AndroidManifest.xml中添加必要的配置（VIVO推送需要）

如果发现离线时无法收到推送，请检查以下配置：

<activity android:name=".PopupPushActivity" android:exported="true">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <!-- VIVO一定要配置applicationId -->
        <data android:host="${applicationId}" android:path="/thirdpush" android:scheme="agoo" />
    </intent-filter>
</activity>

如果点击通知时需要跳转到MainActivity，可以使用以下代码替代PopupPushActivity：

PopupNotifyClick { title, summary, extMap ->
    Log.d("MainActivity", "Receive notification, title: $title, content: $summary, extraMap:$extMap")
}.onCreate(this, this.intent)

初始化推送服务

如果在manifestPlaceholders中已配置好密钥，可以直接使用registerWithMetaData方法进行初始化：

FlutterEmasPush.initPush();
// Android 8.0及以上需要设置通知渠道ID和名称
FlutterEmasPush.setNotificationChannelIdAndName("123456", "androidTest");
FlutterEmasPush.registerWithMetaData();

注册指定平台推送

支持注册华为、小米、OPPO、魅族、VIVO和GCM等推送服务：

FlutterEmasPush.registerOppo("", "");
FlutterEmasPush.registerXiaomi("", "");
FlutterEmasPush.registerHuawei();
FlutterEmasPush.registerMeizu();
FlutterEmasPush.registerGCM("", "", "", "");

绑定或解绑账号、标签和别名

绑定和解绑账号、标签和别名的操作：

FlutterEmasPush.bindAccount('testAccount');
FlutterEmasPush.unbindAccount();

FlutterEmasPush.bindTag(1, ['tags'], 'alias');
FlutterEmasPush.unbindTag(1, ['tags'], 'alias');

FlutterEmasPush.addAlias('alias');
FlutterEmasPush.removeAlias('alias');

接收在线通知

当应用处于在线状态时，可以通过监听onNotificationOpened事件接收推送通知：

_initPushMethodCallHandler() async {
  var channel = FlutterEmasPush.channel;
  channel.setMethodCallHandler((call) async {
    switch (call.method) {
      case 'onNotificationOpened':
        debugPrint('notificationOpened===========${call.arguments}');
        break;
    }
  });
}

显示日志或设置EMAS日志级别

显示日志并设置EMAS的日志级别：

FlutterEmasPush.showLog(kDebugMode);
FlutterEmasPush.showEMASLogLevel(2);

取消通知

取消所有通知或通过ID取消特定通知：

FlutterEmasPush.cancelNotification();
FlutterEmasPush.cancelNotificationById("10");

ProGuard规则配置

如果在发布带有混淆的版本时遇到崩溃问题，可以在proguard-rules.pro中添加以下规则：

-keepclasseswithmembernames class ** {
    native <methods>;
}
-keepattributes Signature
-keep class sun.misc.Unsafe { *; }
-keep class com.taobao.** { *; }
-keep class com.alibaba.** { *; }
-keep class com.alipay.** { *; }
-keep class com.ut.** { *; }
-keep class com.ta.** { *; }
-keep class anet.** { *; }
-keep class anetwork.** { *; }
-keep class org.android.spdy.** { *; }
-keep class org.android.agoo.** { *; }
-keep class android.os.** { *; }
-keep class org.json.** { *; }
-dontwarn com.taobao.**
-dontwarn com.alibaba.**
-dontwarn com.alipay.**
-dontwarn anet.**
-dontwarn org.android.spdy.**
-dontwarn org.android.agoo.**
-dontwarn anetwork.**
-dontwarn com.ut.**
-dontwarn com.ta.**

# 华为通道
-keep class com.huawei.** { *; }
-dontwarn com.huawei.**

# 小米通道
-keep class com.xiaomi.** { *; }
-dontwarn com.xiaomi.**

# OPPO通道
-keep public class * extends android.app.Service

# 魅族通道
-keep class com.meizu.cloud.** { *; }
-dontwarn com.meizu.cloud.**

# VIVO通道
-keep class com.vivo.** { *; }
-dontwarn com.vivo.**

# GCM/FCM通道
-keep class com.google.firebase.** { *; }
-dontwarn com.google.firebase.**

完整示例代码

以下是一个完整的示例代码，展示了如何使用flutter_emas_push插件：

import 'dart:math';

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:flutter_emas_push/flutter_emas_push.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> {
  String _platformVersion = 'Unknown';

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  Future<void> initPlatformState() async {
    String platformVersion;
    try {
      platformVersion =
          await FlutterEmasPush.platformVersion ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }
    if (!mounted) return;
    setState(() {
      _platformVersion = platformVersion;
    });
  }

  initPush() async {
    FlutterEmasPush.initPush();
    FlutterEmasPush.setNotificationChannelIdAndName("123456", "androidTest");
    FlutterEmasPush.registerWithMetaData();
  }

  registerOppo() async {
    FlutterEmasPush.registerOppo("", "");
  }

  bindAccount() async {
    FlutterEmasPush.bindAccount('testAccount');
  }

  unBindAccount() async {
    FlutterEmasPush.unbindAccount();
  }

  bindTag() async {
    FlutterEmasPush.bindTag(1, ['tags'], 'alias');
  }

  unbindTag() async {
    FlutterEmasPush.unbindTag(1, ['tags'], 'alias');
  }

  addAlias() async {
    FlutterEmasPush.addAlias('alias');
  }

  removeAlias() async {
    FlutterEmasPush.removeAlias('alias');
  }

  testPush() async {
    FlutterEmasPush.showLog(true);
    FlutterEmasPush.setNotificationChannelIdAndName("123456", "androidTest");
    var bool = await FlutterEmasPush.canShowNotification();
    print('hello===$bool');
    if (bool) {
      FlutterEmasPush.showNotification(
          "测试${Random().nextInt(100)}",
          "测试内容${Random().nextInt(100)}",
          "{\"_ALIYUN_NOTIFICATION_ID_\":\"542992\",\"mobileId\":\"27203753f1e1d4892143c6d8ce86867a\",\"_ALIYUN_NOTIFICATION_MSG_ID_\":\"8004229324234496\",\"id\":\"582\",\"businessType\":\"QEUBEELIVE\",\"_ALIYUN_NOTIFICATION_PRIORITY_\":\"1\"}",
          "${Random().nextInt(10000)}");
    } else {
      FlutterEmasPush.goSettingNotificationPage();
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Column(
          children: [
            Text('Running on: $_platformVersion\n'),
            ElevatedButton(
                onPressed: () {
                  initPush();
                },
                child: Text('initPush')),
            ElevatedButton(
                onPressed: () {
                  registerOppo();
                },
                child: Text('registerOppo')),
            ElevatedButton(
                onPressed: () {
                  testPush();
                },
                child: Text('testPush')),
            ElevatedButton(
                onPressed: () {
                  FlutterEmasPush.registerWithMetaData();
                },
                child: Text('registerWithMetaData')),
            ElevatedButton(
                onPressed: () {
                  FlutterEmasPush.cancelNotification();
                },
                child: Text('cancelNotification')),
            ElevatedButton(
                onPressed: () {
                  FlutterEmasPush.showNotification("测试指定Id", "id是10", "ext", "10");
                },
                child: Text('showSpecificNotificationById')),
            ElevatedButton(
                onPressed: () {
                  FlutterEmasPush.cancelNotificationById("10");
                },
                child: Text('cancelNotificationById')),
          ],
        ),
      ),
    );
  }
}