Flutter推送服务插件appmetrica_push的使用

Flutter AppMetrica Push 使用指南

SDK 功能

• 接收和显示推送通知
• 接收静默推送通知
• 处理通知中的负载数据
• 在通知中显示图片
• 支持通过打开通知触发深链接（Deep Link）操作
• 支持通过打开通知触发 URL 操作

设置

1. 添加依赖项
   在 pubspec.yaml 文件中添加以下依赖项：

   dependencies:
     firebase_core: ^latest_version
     firebase_analytics: ^latest_version
     appmetrica_plugin: ^latest_version
     appmetrica_push: ^latest_version
   

2. 创建项目

   • 在 AppMetrica 中创建一个项目。
   • 在 Firebase Console 中创建一个项目，添加 Android 应用并上传 google-services.json 配置文件。
   • 在 AppMetrica 项目设置中获取 API key。
   • 在 Firebase Console 的 Cloud Messaging API (Legacy) 中获取 Server key。
   • 配置 AppMetrica 以与 FCM 和 APNs 一起工作。

3. 启用推送令牌更新（可选） FCM 服务可能会撤回设备的推送令牌，例如当用户长时间未启动应用时。AppMetrica 在服务器上存储推送令牌，并且无法向具有过期令牌的设备发送推送通知。为了自动收集当前的推送令牌，可以在 AppMetrica 界面的应用设置中启用“使用静默推送通知更新令牌”选项。

连接 AppMetrica Push SDK

Android

1. 在 build.gradle 文件中设置 minSdkVersion 19

2. 使用 Google Services Plugin

   • 将 google-services.json 文件放置在项目的模块目录中。

   • 在 build.gradle 文件中添加以下内容：

     buildscript {
       dependencies {
         classpath 'com.google.gms:google-services:4.3.13'
       }
     }
     

   • 在 build.gradle 文件中添加以下内容：

     apply plugin: 'com.google.gms.google-services'
     

3. 不使用插件

   • 修改 AndroidManifest.xml 文件中的 application 元素：

     <meta-data android:name="ymp_firebase_default_app_id" android:value="APP_ID"/>
     <meta-data android:name="ymp_gcm_default_sender_id" android:value="number:SENDER_ID"/>
     <meta-data android:name="ymp_firebase_default_api_key" android:value="API_KEY"/>
     <meta-data android:name="ymp_firebase_default_project_id" android:value="PROJECT_ID"/>
     

   • APP_ID：Firebase 中应用的 ID。可以在 Firebase 控制台的“项目设置”中找到。

   • SENDER_ID：Firebase 中发送者的唯一 ID。可以在 Firebase 控制台的“项目设置”→“Cloud Messaging”中找到。

   • API_KEY：Firebase 中应用的 API 密钥。可以在 google-services.json 文件的 current_key 字段中找到。

   • PROJECT_ID：Firebase 中应用的项目 ID。可以在 google-services.json 文件的 project_id 字段中找到。

iOS

1. 将 GoogleService-Info.plist 文件放置在 <project>/ios/Runner/ 目录中。

2. 创建通知服务扩展

   • 在 Xcode 中选择 File → New → Target。
   • 在 iOS Extensions 部分，选择 Notification Service Extension 并点击 Next。
   • 在 Product Name 字段中输入扩展名称，然后点击 Finish。

3. 创建共享 App Groups

   • 在 Xcode 项目设置中，进入 Capabilities 标签页。
   • 为创建的扩展和应用启用 App Groups 选项。
   • 在 App Groups 部分使用 + 按钮创建一个组。您需要在后续配置中使用该组名称。
   • 为应用和扩展选择您创建的组。

4. 修改 Notification Service Extension 中的代码

   import UserNotifications
   import YandexMobileMetricaPush
   
   class YourNotificationServiceName: UNNotificationServiceExtension {
       
       private var contentHandler: ((UNNotificationContent) -> Void)?
       private var bestAttemptContent: UNMutableNotificationContent?
       private let syncQueue = DispatchQueue(label: "YourNotificationServiceName.syncQueue")
       
       override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
           self.contentHandler = contentHandler
           bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
           
           if bestAttemptContent != nil {
               // 修改通知内容
               YMPYandexMetricaPush.setExtensionAppGroup("your.app.group.name")
               YMPYandexMetricaPush.handleDidReceive(request)
           }
           
           YMPYandexMetricaPush.downloadAttachments(for: request) { [weak self] attachments, error in
               if let error = error {
                   print("Error: \(error)")
               }
               
               self?.completeWithBestAttempt(attachments: attachments)
           }
       }
       
       override func serviceExtensionTimeWillExpire() {
           completeWithBestAttempt(attachments: nil)
       }
       
       func completeWithBestAttempt(attachments: [UNNotificationAttachment]?) {
           syncQueue.sync { [weak self] in
               if let contentHandler = contentHandler, let bestAttemptContent = bestAttemptContent {
                   if let attachments = attachments {
                       bestAttemptContent.attachments = attachments
                   }
                   
                   contentHandler(bestAttemptContent)
                   self?.bestAttemptContent = nil
                   self?.contentHandler = nil
               }
           }
       }
   }
   

5. 在 AppDelegate.swift 中添加以下代码

   YMPYandexMetricaPush.setExtensionAppGroup("your.app.group.name")
   

6. 修改 Podfile 文件

   platform :ios, '10.0'
   
   target 'YourNotificationServiceName' do
     use_frameworks!
     
     pod 'YandexMobileMetricaPush'
   end
   
   post_install do |installer|
     installer.pods_project.targets.each do |target|
       if target.name == 'YandexMobileMetrica-Static_Core'
         target.remove_from_project
       end
       flutter_additional_ios_build_settings(target)
     end
   end
   

初始化 AppMetrica Push SDK

await Firebase.initializeApp();
await FirebaseAnalytics.instance.setAnalyticsCollectionEnabled(true);

// AppMetrica.activate 必须在 AppmetricaPush.activate 之前调用
await AppMetrica.activate(AppMetricaConfig('<AppMetrica API key>'));
await AppmetricaPush.instance.activate();
await AppmetricaPush.instance.requestPermission(PermissionOptions(
    alert: true,
    badge: true,
    sound: true,
));

使用 AppMetrica Push SDK

// 获取 PUSH 服务令牌
await AppmetricaPush.instance.getTokens();

// 监听 PUSH 服务令牌变化
// 注意这是一个广播流
AppmetricaPush.instance.tokenStream.listen((Map<String, String?> data) => print('token: $data'));

// 监听静默推送，接收 payload 数据
// 注意这是一个广播流
AppmetricaPush.instance.onMessage.listen((String data) => print('onMessage: $data'));

// 监听推送，接收 payload 数据
// 注意这是一个广播流
AppmetricaPush.instance.onMessageOpenedApp.listen((String data) => print('onMessageOpenedApp: $data'));

示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 项目中使用 AppMetrica Push SDK。

import 'package:flutter/material.dart';
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_analytics/firebase_analytics.dart';
import 'package:appmetrica_plugin/appmetrica_plugin.dart';
import 'package:appmetrica_push/appmetrica_push.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();
  await FirebaseAnalytics.instance.setAnalyticsCollectionEnabled(true);

  // AppMetrica.activate 必须在 AppmetricaPush.activate 之前调用
  await AppMetrica.activate(AppMetricaConfig('<AppMetrica API key>'));
  await AppmetricaPush.instance.activate();
  await AppmetricaPush.instance.requestPermission(PermissionOptions(
    alert: true,
    badge: true,
    sound: true,
  ));

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'AppMetrica Push Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  void initState() {
    super.initState();

    // 监听 PUSH 服务令牌变化
    AppmetricaPush.instance.tokenStream.listen((Map<String, String?> data) {
      print('token: $data');
    });

    // 监听静默推送
    AppmetricaPush.instance.onMessage.listen((String data) {
      print('onMessage: $data');
    });

    // 监听推送打开应用
    AppmetricaPush.instance.onMessageOpenedApp.listen((String data) {
      print('onMessageOpenedApp: $data');
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('AppMetrica Push Demo'),
      ),
      body: Center(
        child: Text('等待推送通知...'),
      ),
    );
  }
}