Flutter推送通知插件pushy_flutter的使用

pushy-flutter 是官方为Flutter应用程序提供的Pushy SDK。Pushy是最可靠的推送通知网关，非常适合实时、关键任务的应用程序。

使用方法

以下是使用pushy-flutter插件的完整示例demo，包括如何集成和配置推送通知功能。

1. 添加依赖

首先，在pubspec.yaml文件中添加pushy_flutter依赖：

dependencies:
  flutter:
    sdk: flutter
  pushy_flutter: ^latest_version  # 请替换为最新版本

2. 初始化Pushy

在main.dart文件中，添加以下代码来初始化Pushy并注册设备以接收推送通知。

import 'package:flutter/material.dart';
import 'dart:io' show Platform;
import 'dart:async';

import 'package:pushy_flutter/pushy_flutter.dart';

void main() => runApp(Main());

// 背景通知监听器
@pragma('vm:entry-point')
void backgroundNotificationListener(Map<String, dynamic> data) {
  // 打印通知负载数据
  print('Received notification: $data');

  // 通知标题
  String notificationTitle = 'MyApp';

  // 尝试从负载中提取 "message" 属性: {"message":"Hello World!"}
  String notificationText = data['message'] ?? 'Hello World!';

  // Android: 显示系统通知
  // iOS: 显示警告对话框
  Pushy.notify(notificationTitle, notificationText, data);

  // 清除iOS应用图标上的徽章数量
  Pushy.clearBadge();
}

class Main extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Pushy',
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        // 光明主题，深色操作栏
        brightness: Brightness.light,
        primaryColor: Colors.grey[900],
        secondaryHeaderColor: Colors.redAccent,
      ),
      home: PushyDemo(),
    );
  }
}

class PushyDemo extends StatefulWidget {
  @override
  _PushyDemoState createState() => _PushyDemoState();
}

class _PushyDemoState extends State<PushyDemo> {
  String _deviceToken = 'Loading...';
  String _instruction = '(please wait)';

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

  // 平台消息是异步的，因此我们在异步方法中初始化
  Future<void> initPlatformState() async {
    // 启动Pushy服务
    Pushy.listen();

    // 设置Pushy应用ID（Web Push所需）
    Pushy.setAppId('550ee57c5b5d72117f51e801');  // 请替换为您的应用ID

    try {
      // 注册设备以接收推送通知
      String deviceToken = await Pushy.register();

      // 打印token到控制台/日志
      print('Device token: $deviceToken');

      // 将token发送到您的后端服务器
      // ...

      // 更新UI显示token
      setState(() {
        _deviceToken = deviceToken;
        _instruction =
            isAndroid() ? '(copy from logcat)' : '(copy from console)';
      });
    } catch (error) {
      // 打印错误信息
      print('Error: ${error.toString()}');

      // 显示错误
      setState(() {
        _deviceToken = 'Registration failed';
        _instruction = '(restart app to try again)';
      });
    }

    // 启用应用内通知横幅（iOS 10+）
    Pushy.toggleInAppBanner(false);

    // 监听接收到的推送通知
    Pushy.setNotificationListener(backgroundNotificationListener);

    // 监听点击的推送通知
    Pushy.setNotificationClickListener((Map<String, dynamic> data) {
      // 打印通知负载数据
      print('Notification clicked: $data');

      // 提取消息内容
      String message = data['message'] ?? 'Hello World!';

      // 显示一个带有消息内容的警告对话框
      showDialog(
        context: context,
        builder: (BuildContext context) {
          return AlertDialog(
              title: Text('Notification clicked'),
              content: Text(message),
              actions: [
                ElevatedButton(
                  child: Text('OK'),
                  onPressed: () {
                    Navigator.of(context, rootNavigator: true).pop('dialog');
                  },
                )
              ]);
        },
      );

      // 清除iOS应用图标上的徽章数量
      Pushy.clearBadge();
    });
  }

  @override
  Widget build(BuildContext context) {
    // 示例应用UI
    return Scaffold(
      appBar: AppBar(
        title: const Text('Pushy'),
        foregroundColor: Colors.white,
        backgroundColor: Colors.grey[900]
      ),
      body: Builder(
        builder: (context) => Center(
            child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                crossAxisAlignment: CrossAxisAlignment.center,
                children: <Widget>[
              Image.asset('assets/ic_logo.png', width: 90),  // 请确保您有此图片资源
              Padding(
                padding: const EdgeInsets.all(10),
                child: Text(_deviceToken,
                    style: TextStyle(
                        fontWeight: FontWeight.bold,
                        fontSize: 18,
                        color: Colors.grey[700])),
              ),
              Text(_instruction,
                  style: TextStyle(fontSize: 13, color: Colors.grey[600])),
            ])),
      ),
    );
  }
}

bool isAndroid() {
  try {
    // 返回设备是否运行在Android上
    return Platform.isAndroid;
  } catch (e) {
    // 如果失败，我们是在Web上
    return false;
  }
}

3. 配置推送通知

Android配置

在android/app/build.gradle文件中，确保添加了以下依赖项：

dependencies {
    implementation 'me.pushy:sdk:1.0.48'
}

在AndroidManifest.xml文件中，添加以下权限和广播接收器：

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />

<application>
    <!-- ... -->
    <receiver
        android:name="me.pushy.sdk.receivers.PushReceiver"
        android:exported="true">
        <intent-filter>
            <action android:name="com.google.android.c2dm.intent.RECEIVE" />
            <category android:name="${applicationId}" />
        </intent-filter>
    </receiver>
</application>

iOS配置

在ios/Runner/AppDelegate.swift文件中，添加以下代码：

import UIKit
import Flutter
import Pushy

[@UIApplicationMain](/user/UIApplicationMain)
[@objc](/user/objc) class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)

    // Start the Pushy SDK
    Pushy.start(onSuccess: { deviceToken in
        print("Pushy device token: \(deviceToken)")
    }, onFailure: { error in
        print("Failed to register for push notifications: \(error.localizedDescription)")
    })

    // Request push notification permissions on iOS 10+
    UNUserNotificationCenter.current().requestAuthorization(options: [.alert, .badge, .sound]) { granted, error in
        if let error = error {
            print("Failed to request push notification permissions: \(error.localizedDescription)")
        }
    }

    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }

  override func application(
    _ application: UIApplication,
    didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data
  ) {
    // Forward APNs token to Pushy
    Pushy.setApnsToken(deviceToken)
  }

  override func application(
    _ application: UIApplication,
    didFailToRegisterForRemoteNotificationsWithError error: Error
  ) {
    print("Failed to register for remote notifications: \(error.localizedDescription)")
  }

  override func userNotificationCenter(
    _ center: UNUserNotificationCenter,
    willPresent notification: UNNotification,
    withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void
  ) {
    // Display an alert when a push notification is received in the foreground
    completionHandler([.alert, .badge, .sound])
  }
}