Flutter推送通知插件simple_push_notification的使用

simple_push_notification 是一个用于处理 Firebase 通知的简单包，支持通知导航。以下是该插件的主要功能和使用方法。

Features

• 显示推送通知
• 激活和停用推送通知服务
• 点击推送通知后导航到指定的屏幕、视图或页面

Getting Started

配置 Firebase

首先确保你的 Flutter 应用已经正确配置了 Firebase。推荐的方法是使用 Flutterfire CLI 来设置 Firebase 应用。可以参考官方文档进行配置。

在 pubspec.yaml 文件中添加依赖：

dependencies:
  simple_push_notification: latest_version_number

然后导入该包：

import 'package:simple_push_notification/simple_push_notification.dart';

Android 配置

完成 Firebase 配置后，在 lib 文件夹下会生成 firebase_options.dart 文件。接下来需要初始化 Firebase 并使用 SimplePushNotification 类：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp(
    name: 'NAME_OF_YOUR_FIREBASE_APP',
    options: DefaultFirebaseOptions.currentPlatform,
  );
  runApp(App());
}

初始化完成后，可以根据需求使用 SimplePushNotification 类。

Usage

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

import 'dart:developer';

import 'package:firebase_core/firebase_core.dart';
import 'package:flutter/material.dart';
import 'package:notification_demo/firebase_options.dart';
import 'package:notification_demo/payloads.dart';
import 'package:simple_push_notification/simple_push_notification.dart';

// Pass this navigatorKey using dependency Injection like get_it package.
final navigatorKey = GlobalKey<NavigatorState>();
late SimplePushNotification pushNotification;

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp(
    name: 'Notification_demo',
    options: DefaultFirebaseOptions.currentPlatform,
  );

  pushNotification = SimplePushNotification.initialize(
    navigatorKey: () => navigatorKey,
    getNotificationPayload: (map) => getPayload(map),
    config: NotificationConfig(
      appIcon: 'ic_launcher',
      notificationChannelDescription: 'this is a test description',
      notificationChannelId: 'testId',
      notificationChannelName: 'Test name',
    ),
  );

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: navigatorKey,
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: () async {
                await pushNotification.activate(
                  onActivated: (token) {
                    log('Notification activated!!!! token: $token');
                  },
                  onRead: (payload) {
                    log(payload.toString());
                  },
                );
              },
              child: const Text('Activate Push Notification'),
            ),
            ElevatedButton(
              onPressed: () async {
                await pushNotification.deactivate(
                  onDeactivated: (token) {
                    log('Notification deactivated!!!! token: $token');
                  },
                );
              },
              child: const Text('Deactivate Push Notification'),
            ),
          ],
        ),
      ),
    );
  }
}

NotificationPayload getPayload(Map<String, dynamic> data) {
  final type = data['notificationType'] as String;
  switch (type) {
    case 'cart':
      return CartPayload(data['cartId']);
    case 'payment':
      return PaymentPayload(data['paymentId']);
    case 'checkout':
      return CheckoutPayload();
    default:
      return DefaultPayload();
  }
}