Flutter通知管理插件notification_centre的使用

Flutter通知管理插件notification_centre的使用

NotificationCenter 是一个轻量级的消息发布/订阅库，用于在整个 Flutter 应用程序中传递消息。它受到 iOS 中的 NotificationCenter 和 Android 中的 EventBus 的启发。

开始使用

在 Flutter 中，NotificationCentre 受到 iOS 中的 NotificationCenter 和 Android 中的 EventBus 的启发。由于它可以在 iOS（Swift/Objective-C）代码库中的任何地方使用，我们非常熟悉发布者-观察者模型。对于 Android 开发者来说，如果你已经熟悉 EventBus，那么你将很容易上手。

特性

• 观察者：如果接收到消息，则观察事件。
• 发布者：将事件发布给所有观察者。

使用方法

添加观察者

建议你在 initState() 方法中添加观察者，但你也可以在其他地方添加观察者。

[@override](/user/override)
void initState() { 
    super.initState(); 
    NotificationCenter().addObserver(NOTIFICATION_NAME_USER_SIGNED_IN, this, () {
        // 用户登录后执行的操作。
    });
}

移除观察者

建议你在 dispose() 方法中移除观察者，但你也可以在其他地方移除观察者。

[@override](/user/override)
void dispose() { 
    NotificationCenter().removeObserver(NOTIFICATION_NAME_USER_SIGNED_IN, this);
    super.dispose();
}

发布消息

你可以通过以下代码轻松地在整个应用程序中发布消息。

NotificationCenter().postNotification(
    NOTIFICATION_NAME_PURCHASE_COMPLETED, 
    data: {"data": YOUR_DATA, "type": "completed"},
);

注意事项

NotificationName 只是一个普通的字符串值，可以是任何字符串。请记住，在调用 addObserver()、removeObserver() 和 postNotification() 这三个方法时，传递的 NotificationName 必须一致。

完整示例代码

以下是一个完整的示例代码，展示了如何使用 NotificationCenter 来处理用户登录状态的变化。

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

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});
    
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(    
      onGenerateRoute: (RouteSettings routeSettings) {
        return MaterialPageRoute<void>(
          settings: routeSettings,
          builder: (BuildContext context) {
            switch (routeSettings.name) {
              case LoginPage.routeName: return LoginPage(); 
              default: return MainPage();
            }
          }
        );
      }
    ); 
  }
}

class MainPage extends StatefulWidget {

  [@override](/user/override)
  State<StatefulWidget> createState() => _MainPageState();

}

class _MainPageState extends State<MainPage> {

  String loginState = "Not Sign In";

  [@override](/user/override)
  void initState() { 
    super.initState();
    NotificationCenter().addObserver(NOTIFICATION_NAME_USER_SIGNED_IN, this, () {
      // 更新 UI，一旦用户已登录。
      setState(() {
        loginState = "You signed in!";
      });
    });
  }
  
  [@override](/user/override)
  void dispose() {
    NotificationCenter().removeObserver(NOTIFICATION_NAME_USER_SIGNED_IN, this);
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Text(loginState),
      ),
    );
  }

}

class LoginPage extends StatelessWidget {

  static const routeName = "/login";

  String notificationName = "";

  LoginPage({super.key}) {
    // 对于 NotificationName，它只是一个字符串值，可以是任何字符串。 
    // 请记住，你定义或自定义的 NotificationName 必须与观察者和发布者一致。
    notificationName = NOTIFICATION_NAME_USER_SIGNED_IN;
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: TextButton(
          onPressed: () {
            NotificationCenter().postNotification(
              notificationName, 
              data: {"userId": 123456789, "type": "normal"},
            );
          },
          child: Text("Go to Sign In"),
        ),
      ),
    );
  }

}