Flutter Firebase Cloud Messaging 隔离插件 fcm_shared_isolate 的使用

fcm_shared_isolate 是一个支持共享隔离的 Flutter Firebase 云消息传递插件。以下是如何在 Flutter 应用中配置和使用该插件的详细步骤。

安装库

首先，在你的 pubspec.yaml 文件中添加 fcm_shared_isolate 依赖项，然后执行 flutter pub get 命令以安装它。

1. 修改 Android 端的主活动

通常在 android/app/src/main/kotlin/your/app/id/MainActivity.kt 文件中进行修改：

package your.app.id

import io.flutter.embedding.android.FlutterActivity
import io.flutter.embedding.engine.FlutterEngine

import android.content.Context
import android.os.Bundle
import android.util.Log
import android.view.WindowManager

class MainActivity : FlutterActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
    };

    override fun provideFlutterEngine(context: Context): FlutterEngine? {
        return provideEngine(this)
    }

    override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
        // do nothing, 因为引擎已经在 provideEngine 中配置好了
    }

    companion object {
        var engine: FlutterEngine? = null
        fun provideEngine(context: Context): FlutterEngine {
            var eng = engine ?: FlutterEngine(context, emptyArray(), true, false)
            engine = eng
            return eng
        }
    }
}

2. 添加 FcmPushService

通常在 android/app/src/main/kotlin/your/app/id/FcmPushService.kt 文件中进行添加：

package your.app.id

import com.famedly.fcm_shared_isolate.FcmSharedIsolateService

import your.app.id.MainActivity

import io.flutter.embedding.android.FlutterActivity
import io.flutter.embedding.engine.FlutterEngine
import io.flutter.view.FlutterMain
import io.flutter.embedding.engine.dart.DartExecutor.DartEntrypoint

import android.content.Context
import android.os.Bundle
import android.util.Log
import android.view.WindowManager

class FcmPushService : FcmSharedIsolateService() {
    override fun getEngine(): FlutterEngine {
        return provideEngine(getApplicationContext())
    }

    companion object {
        fun provideEngine(context: Context): FlutterEngine {
            var engine = MainActivity.engine
            if (engine == null) {
                engine = MainActivity.provideEngine(context)
                engine.getLocalizationPlugin().sendLocalesToFlutter(
                    context.getResources().getConfiguration())
                engine.getDartExecutor().executeDartEntrypoint(
                    DartEntrypoint.createDefault())
            }
            return engine
        }
    }
}

3. 修改 AndroidManifest.xml

通常在 android/app/src/main/AndroidManifest.xml 文件中进行修改：

<service android:name=".FcmPushService"
  android:exported="false">
  <intent-filter>
    <action android:name="com.google.firebase.MESSAGING_EVENT"/>
  </intent-filter>
</service>

注意：FcmPushService 必须与上述文件中定义的类名匹配。

使用

初始化插件并设置监听器

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

void main() {
  FcmSharedIsolate(); // 初始化插件
  runApp(MyApp());
}

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

class _MyAppState extends State<MyApp> {
  final fcm = FcmSharedIsolate();

  [@override](/user/override)
  void initState() {
    super.initState();
    
    // 仅在 iOS 上请求权限
    if (defaultTargetPlatform == TargetPlatform.iOS) {
      fcm.requestPermission();
    }

    // 获取推送令牌
    fcm.getToken().then((token) {
      print("Received token: $token");
    });

    // 设置监听器
    fcm.setListeners(
      onMessage: onMessage,
      onNewToken: onNewToken,
    );
  }

  Future<void> onMessage(Map<dynamic, dynamic> message) async {
    print('Got a new message from Firebase Cloud Messaging: $message');
  }

  Future<void> onNewToken(String token) async {
    print('Received a new token: $token');
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Text('Hello World\n'),
        ),
      ),
    );
  }
}