Flutter推送通知插件jpush_flutter的使用

JPush Flutter Plugin

flutter 3.0 请切换至 dev-3.x 分支。

安装

在工程 pubspec.yaml 中加入 dependencies

//github  集成
dependencies:
  jpush_flutter:
    git:
      url: git://github.com/jpush/jpush-flutter-plugin.git
      ref: dev-3.x
      
// pub 集成
dependencies:
  jpush_flutter: 3.1.9

配置

Android:

在 /android/app/build.gradle 中添加下列代码：

android: {
  ....
  defaultConfig {
    applicationId "替换成自己应用 ID"
    ...
    manifestPlaceholders = [
        JPUSH_PKGNAME : applicationId,
        JPUSH_APPKEY : "appkey", // NOTE: JPush 上注册的包名对应的 Appkey.
        JPUSH_CHANNEL : "developer-default", //暂时填写默认值即可.
    ]
  }    
}

iOS:

• 在 xcode8 之后需要点开推送选项： TARGETS -> Capabilities -> Push Notification 设为 on 状态

使用

import 'package:jpush_flutter/jpush_flutter.dart';

示例Demo

下面是一个完整的示例demo，展示了如何使用jpush_flutter插件来接收和处理推送通知。

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

import 'package:flutter/services.dart';
import 'package:jpush_flutter/jpush_flutter.dart';

void main() => runApp(new MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String? debugLable = 'Unknown';
  final JPush jpush = new JPush();

  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    String? platformVersion;

    try {
      jpush.addEventHandler(
          onReceiveNotification: (Map<String, dynamic> message) async {
            print("flutter onReceiveNotification: $message");
            setState(() {
              debugLable = "flutter onReceiveNotification: $message";
            });
          }, 
          onOpenNotification: (Map<String, dynamic> message) async {
            print("flutter onOpenNotification: $message");
            setState(() {
              debugLable = "flutter onOpenNotification: $message";
            });
          }, 
          onReceiveMessage: (Map<String, dynamic> message) async {
            print("flutter onReceiveMessage: $message");
            setState(() {
              debugLable = "flutter onReceiveMessage: $message";
            });
          }, 
          onReceiveNotificationAuthorization:
              (Map<String, dynamic> message) async {
            print("flutter onReceiveNotificationAuthorization: $message");
            setState(() {
              debugLable = "flutter onReceiveNotificationAuthorization: $message";
            });
          }, 
          onNotifyMessageUnShow: (Map<String, dynamic> message) async {
            print("flutter onNotifyMessageUnShow: $message");
            setState(() {
              debugLable = "flutter onNotifyMessageUnShow: $message";
            });
          }, 
          onInAppMessageShow: (Map<String, dynamic> message) async {
            print("flutter onInAppMessageShow: $message");
            setState(() {
              debugLable = "flutter onInAppMessageShow: $message";
            });
          }, 
          onCommandResult: (Map<String, dynamic> message) async {
            print("flutter onCommandResult: $message");
            setState(() {
              debugLable = "flutter onCommandResult: $message";
            });
          }, 
          onInAppMessageClick: (Map<String, dynamic> message) async {
            print("flutter onInAppMessageClick: $message");
            setState(() {
              debugLable = "flutter onInAppMessageClick: $message";
            });
          }, 
          onConnected: (Map<String, dynamic> message) async {
            print("flutter onConnected: $message");
            setState(() {
              debugLable = "flutter onConnected: $message";
            });
          }
      );
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    jpush.setAuth(enable: true);
    jpush.setup(
      appKey: "xxxxx", //你自己应用的 AppKey
      channel: "theChannel",
      production: false,
      debug: true,
    );
    jpush.applyPushAuthority(
        new NotificationSettingsIOS(sound: true, alert: true, badge: true));

    // Platform messages may fail, so we use a try/catch PlatformException.
    jpush.getRegistrationID().then((rid) {
      print("flutter get registration id : $rid");
      setState(() {
        debugLable = "flutter getRegistrationID: $rid";
      });
    });

    // iOS要是使用应用内消息，请在页面进入离开的时候配置pageEnterTo 和  pageLeave 函数，参数为页面名。
    jpush.pageEnterTo("HomePage"); // 在离开页面的时候请调用 jpush.pageLeave("HomePage");

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      debugLable = platformVersion;
    });
  }

  // 编写视图
  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new Scaffold(
        appBar: new AppBar(
          title: const Text('Plugin example app'),
        ),
        body: new Center(
          child: new Column(children: [
            Container(
              margin: EdgeInsets.fromLTRB(10, 10, 10, 10),
              color: Colors.brown,
              child: Text(debugLable ?? "Unknown"),
              width: 350,
              height: 100,
            ),
            new Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: <Widget>[
                new Text(" "),
                new CustomButton(
                  title: "发本地推送",
                  onPressed: () {
                    // 三秒后出发本地推送
                    var fireDate = DateTime.fromMillisecondsSinceEpoch(
                        DateTime.now().millisecondsSinceEpoch + 3000);
                    var localNotification = LocalNotification(
                        id: 234,
                        title: 'fadsfa',
                        buildId: 1,
                        content: 'fdas',
                        fireTime: fireDate,
                        subtitle: 'fasf',
                        badge: 5,
                        extra: {"fa": "0"});
                    jpush.sendLocalNotification(localNotification).then((res) {
                      setState(() {
                        debugLable = res;
                      });
                    });
                  }),
                new Text(" "),
                new CustomButton(
                  title: "getLaunchAppNotification",
                  onPressed: () {
                    jpush.getLaunchAppNotification().then((map) {
                      print("flutter getLaunchAppNotification:$map");
                      setState(() {
                        debugLable = "getLaunchAppNotification success: $map";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "getLaunchAppNotification error: $error";
                      });
                    });
                  }),
              ]),
            new Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: <Widget>[
                new Text(" "),
                new CustomButton(
                  title: "setTags",
                  onPressed: () {
                    jpush.setTags(["lala", "haha"]).then((map) {
                      var tags = map['tags'];
                      setState(() {
                        debugLable = "set tags success: $map $tags";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "set tags error: $error";
                      });
                    });
                  }),
                new Text(" "),
                new CustomButton(
                  title: "addTags",
                  onPressed: () {
                    jpush.addTags(["lala", "haha"]).then((map) {
                      var tags = map['tags'];
                      setState(() {
                        debugLable = "addTags success: $map $tags";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "addTags error: $error";
                      });
                    });
                  }),
                new Text(" "),
                new CustomButton(
                  title: "deleteTags",
                  onPressed: () {
                    jpush.deleteTags(["lala", "haha"]).then((map) {
                      var tags = map['tags'];
                      setState(() {
                        debugLable = "deleteTags success: $map $tags";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "deleteTags error: $error";
                      });
                    });
                  }),
              ]),
            new Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: <Widget>[
                new Text(" "),
                new CustomButton(
                  title: "getAllTags",
                  onPressed: () {
                    jpush.getAllTags().then((map) {
                      setState(() {
                        debugLable = "getAllTags success: $map";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "getAllTags error: $error";
                      });
                    });
                  }),
                new Text(" "),
                new CustomButton(
                  title: "cleanTags",
                  onPressed: () {
                    jpush.cleanTags().then((map) {
                      var tags = map['tags'];
                      setState(() {
                        debugLable = "cleanTags success: $map $tags";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "cleanTags error: $error";
                      });
                    });
                  }),
              ]),
            new Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: <Widget>[
                new Text(" "),
                new CustomButton(
                  title: "setAlias",
                  onPressed: () {
                    jpush.setAlias("thealias11").then((map) {
                      setState(() {
                        debugLable = "setAlias success: $map";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "setAlias error: $error";
                      });
                    });
                  }),
                new Text(" "),
                new CustomButton(
                  title: "deleteAlias",
                  onPressed: () {
                    jpush.deleteAlias().then((map) {
                      setState(() {
                        debugLable = "deleteAlias success: $map";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "deleteAlias error: $error";
                      });
                    });
                  }),
                new Text(" "),
                new CustomButton(
                  title: "getAlias",
                  onPressed: () {
                    jpush.getAlias().then((map) {
                      setState(() {
                        debugLable = "getAlias success: $map";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "getAlias error: $error";
                      });
                    });
                  }),
              ]),
            new Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: <Widget>[
                new Text(" "),
                new CustomButton(
                  title: "stopPush",
                  onPressed: () {
                    jpush.stopPush();
                  }),
                new Text(" "),
                new CustomButton(
                  title: "resumePush",
                  onPressed: () {
                    jpush.resumePush();
                  }),
              ],
            ),
            new Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: <Widget>[
                new Text(" "),
                new CustomButton(
                  title: "clearAllNotifications",
                  onPressed: () {
                    jpush.clearAllNotifications();
                  }),
                new Text(" "),
                new CustomButton(
                  title: "setBadge",
                  onPressed: () {
                    jpush.setBadge(66).then((map) {
                      setState(() {
                        debugLable = "setBadge success: $map";
                      });
                    }).catchError((error) {
                      setState(() {
                        debugLable = "setBadge error: $error";
                      });
                    });
                  }),
              ],
            ),
            new Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: <Widget>[
                new Text(" "),
                new CustomButton(
                  title: "通知授权是否打开",
                  onPressed: () {
                    jpush.isNotificationEnabled().then((bool value) {
                      setState(() {
                        debugLable = "通知授权是否打开: $value";
                      });
                    }).catchError((onError) {
                      setState(() {
                        debugLable = "通知授权是否打开: ${onError.toString()}";
                      });
                    });
                  }),
                new Text(" "),
                new CustomButton(
                  title: "打开系统设置",
                  onPressed: () {
                    jpush.openSettingsForNotification();
                  }),
              ],
            ),
          ]),
        ),
      ),
    );
  }
}

/// 封装控件
class CustomButton extends StatelessWidget {
  final VoidCallback? onPressed;
  final String? title;

  const CustomButton({@required this.onPressed, @required this.title});

  @override
  Widget build(BuildContext context) {
    return new TextButton(
      onPressed: onPressed,
      child: new Text("$title"),
      style: new ButtonStyle(
        foregroundColor: MaterialStateProperty.all(Colors.white),
        overlayColor: MaterialStateProperty.all(Color(0xff888888)),
        backgroundColor: MaterialStateProperty.all(Color(0xff585858)),
        padding: MaterialStateProperty.all(EdgeInsets.fromLTRB(10, 5, 10, 5)),
      ),
    );
  }
}

以上是jpush_flutter插件的使用方法及一个完整的示例demo。通过这个例子，您可以了解如何初始化JPush、处理各种推送事件以及执行相关操作如设置标签、别名等。希望这对您有所帮助！