flutter集成极光推送

一、简述

极光推送，英文简称 JPush，免费的第三方消息推送服务，官方也推出众多平台的SDK以及插件。

参考链接

名称	地址
客户端集成插件	客户端集成插件 - 极光文档

二、操作步骤

2.1 添加插件

flutter项目中集成官方提供的极光推送flutter插件

在根目录执行以下命令

|---------------------------------------|
| flutter pub add jpush_flutter |

2.2 初始化极光推送

在项目启动入口增加以下代码块

|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| import 'package:flutter/material.dart'; import 'package:jpush_flutter/jpush_flutter.dart'; import 'index_page.dart'; ///程序入口 void main() => runApp(RootApp()); class RootApp extends StatefulWidget{ @override State<StatefulWidget> createState() { return RottAppState(); } } class RottAppState extends State<RootApp>{ ///根布局的初始化 @override void initState() { super.initState(); ///创建 JPush JPush jpush = new JPush(); ///配置应用 Key jpush.setup( appKey: "替换成你自己的 appKey", channel: "theChannel", production: false, /// 设置是否打印 debug 日志 debug: true, ); } @override Widget build(BuildContext context) { ///来构建 return MaterialApp( ///应用程序默认显示的页面 home: IndexPage(), ); } } |

2.3 配置 flutter

2.3.1 Android项目

在 android 目录下配置 build.gradle

2.3.2 IOS项目

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

2.4 创建应用程序

在极光开发者平台中创建你的应用程序

极光开发者平台主页：portal

推送证书生成：证书设置指南 - 极光文档

2.5 常见错误

android ios 平台无法接收到推送消息

在注册推送的时候，可以先添加上接收通知消息的权限申请，申请成功权限后再进行注册。

三、JPush主要API

参考链接：https://github.com/jpush/jpush-flutter-plugin/blob/master/documents/APIs.md

3.1 初始化

添加初始化方法，调用 setup 方法会执行两个操作：

初始化 JPush SDK
将缓存的事件下发到 dart 环境中。

注意： 插件版本 >= 0.0.8 android 端支持在 setup 方法中动态设置 channel，动态设置的 channel 优先级比 manifestPlaceholders 中的 JPUSH_CHANNEL 优先级要高。

|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| JPush jpush = new JPush(); jpush.setup( appKey: "替换成你自己的 appKey", channel: "theChannel", production: false, debug: false, // 设置是否打印 debug 日志 ); |

3.2 事件监听

添加事件监听方法。

**注意：**addEventHandler 方法建议放到 setup 之前，其他方法需要在 setup 方法之后调用。

3.3 推送通知

|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| JPush jpush = new JPush(); //获取 registrationId，这个 JPush 运行通过 registrationId 来进行推送. jpush.getRegistrationID().then((rid) { }); //停止推送功能，调用该方法将不会接收到通知。 jpush.stopPush(); //调用 stopPush 后，可以通过 resumePush 方法恢复推送。 jpush.resumePush(); //指定触发时间，添加本地推送通知。 // 延时 3 秒后触发本地通知。 var fireDate = DateTime.fromMillisecondsSinceEpoch(DateTime.now().millisecondsSinceEpoch + 3000); var localNotification = LocalNotification( id: 234, title: 'notification title', buildId: 1, content: 'notification content', fireTime: fireDate, subtitle: 'notification subtitle', // 该参数只有在 iOS 有效 badge: 5, // 该参数只有在 iOS 有效 extras: {"fa": "0"} // 设置 extras ，extras 需要是 Map<String, String> ); jpush.sendLocalNotification(localNotification).then((res) {}); //清楚通知栏上所有通知。 jpush.clearAllNotifications(); |