Flutter功能未知插件rationalowl_flutter的探索使用

Flutter功能未知插件rationalowl_flutter的探索使用

一个用于使用RationalOwl API的Flutter插件。

使用

要使用此插件，在你的pubspec.yaml文件中添加rationalowl_flutter作为依赖项。

入门指南

1. 在你的RationalOwl服务中集成Firebase Cloud Messaging (FCM) 和 Apple Push Notification服务 (APNs)。
   • FCM集成
   • 使用.p8证书的APNs集成（推荐）
   • 使用.p12证书的APNs集成

Android

1. 下载rationalowl-android-1.4.1.aar文件。
2. 在android/app目录下创建libs文件夹，并将rationalowl-android-1.4.1.aar文件复制到该文件夹内。

1. 在android/app/build.gradle文件中设置dependencies：

dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    implementation files('libs/rationalowl-android-1.4.1.aar')
}

1. 使用Firebase Messaging来处理后台消息。

iOS

1. 打开你的项目工作区文件ios/Runner.xcworkspace。
2. 下载RationalOwl.framework目录。
3. 将RationalOwl.framework目录拖放到Runner项目中。
4. 选择Copy items if needed复选框，然后点击Finish。

1. 选择Runner项目，然后选择Runner目标。
2. 打开Frameworks, Libraries, and Embedded Content部分，然后点击+按钮。
3. 点击Add Files...菜单项，然后选择RationalOwl.framework目录。

1. 选择Signing & Capabilities选项卡，然后点击+ Capability按钮。
2. 添加Push Notifications和Background Modes功能。
3. 在Background Modes功能中启用Background fetch和Remote notifications模式。

1. 选择Build Phases选项卡，然后打开Link Binary With Libraries部分。
2. 点击+按钮。
3. 选择UserNotifications.framework，然后点击Add。

1. 打开Embed Frameworks部分，选择Copy only when installing复选框。

1. 点击左下角的+按钮。
2. 选择Notification Service Extension模板，然后点击Next。

1. 添加Product Name，然后点击Finish。

示例用法

const iOSAppGroup = 'group.com.rationalowl.flutterexample';

Future<void> _initialize() async {
  if (Platform.isAndroid) {
    await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);
    FirebaseMessaging.onBackgroundMessage(handleMessage);
  }

  await initializeNotification();

  final MinervaManager minMgr = MinervaManager.getInstance();

  if (Platform.isIOS) {
    await minMgr.setAppGroup(iOSAppGroup);
  }

  await minMgr.setMsgListener(RoMessageListener());
}

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await _initialize();

  runApp(const Application());
}

class Application extends StatefulWidget {
  const Application({super.key});

  @override
  State<StatefulWidget> createState() => _ApplicationState();
}

class _ApplicationState extends State<Application> with WidgetsBindingObserver {
  late final MinervaAppLifecycleObserver _observer;

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

    if (Platform.isIOS) {
      _observer = MinervaAppLifecycleObserver();
      WidgetsBinding.instance.addObserver(_observer);
    } else {
      FirebaseMessaging.instance.onTokenRefresh.listen(handleTokenRefresh);
    }
  }

  @override
  void dispose() {
    if (Platform.isIOS) {
      WidgetsBinding.instance.removeObserver(_observer);
    }

    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: Scaffold(
        body: SafeArea(
          child: MainPage(),
        ),
      ),
    );
  }
}

在你的Dart代码中实现MessageListener以接收Android和iOS上的前台消息。

class RoMessageListener implements MessageListener {
  @override
  void onDownstreamMsgReceived(List<Map<String, dynamic>> msgList) {}

  @override
  void onP2PMsgReceived(List<Map<String, dynamic>> msgList) {
    if (msgList.isNotEmpty) {
      final latestMessage = Map<String, dynamic>.from(msgList[0]['data']);
      showNotification(latestMessage);
    }
  }

  @override
  void onPushMsgReceived(List<Map<String, dynamic>> msgList) {
    if (msgList.isNotEmpty) {
      final latestMessage = Map<String, dynamic>.from(msgList[0]['data']);
      showNotification(latestMessage);
    }
  }

  @override
  void onSendUpstreamMsgResult(int resultCode, String? resultMsg, String? msgId) {}

  @override
  void onSendP2PMsgResult(int resultCode, String? resultMsg, String? msgId) {}
}

在你的Dart代码中实现处理器以接收Android上的令牌和后台消息。

Future<void> handleTokenRefresh(String token) async {
  final MinervaManager minMgr = MinervaManager.getInstance();
  minMgr.setDeviceToken(token);
}

@pragma('vm:entry-point')
Future<void> handleMessage(RemoteMessage message) async {
  final Map<String, dynamic> data = message.data;

  final MinervaManager minMgr = MinervaManager.getInstance();
  minMgr.enableNotificationTracking(data: data);

  if (!data.containsKey('silent')) {
    showNotification(data);
  }
}

在你的Swift代码ios/{Product Name}/NotificationService.swift中实现UNNotificationServiceExtension以接收iOS上的后台消息。

class NotificationService: UNNotificationServiceExtension {
    private static let appGroup = "group.com.rationalowl.flutterexample"

    var contentHandler: ((UNNotificationContent) -> Void)?
    var bestAttemptContent: UNMutableNotificationContent?

    override func didReceive(_ request: UNNotificationRequest,
                             withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
        self.contentHandler = contentHandler
        bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
        
        if let bestAttemptContent = bestAttemptContent {
            let userInfo = bestAttemptContent.userInfo

            let minMgr = MinervaManager.getInstance()!
            minMgr.enableNotificationTracking(userInfo, appGroup: Self.appGroup)

            if userInfo["notiTitle"] != nil {
                bestAttemptContent.title = userInfo["notiTitle"] as! String
            }
            if userInfo["notiBody"] != nil {
                bestAttemptContent.body = userInfo["notiBody"] as! String
            }

            contentHandler(bestAttemptContent)
        }
    }
    
    override func serviceExtensionTimeWillExpire() {
        if let contentHandler = contentHandler, let bestAttemptContent = bestAttemptContent {
            contentHandler(bestAttemptContent)
        }
    }
}