Flutter消息处理插件message_handler的使用

Flutter消息处理插件message_handler的使用

在本教程中，我们将学习如何使用 message_handler 插件来处理 Flutter 应用程序中的消息。该插件允许你自定义消息的设计，并添加中间件来处理消息。

开始

首先，你需要将 MessageManager 类添加到你的应用的顶层小部件树中。这允许你编辑标准消息的设计，发送消息并添加中间件。以下是一个示例：

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MessageManager(
        middlewares: const [TestMiddleware()], // 添加中间件列表，中间件必须继承自 MessageHandlerMiddleware。在显示消息之前调用 [可选，默认 => null]
        alertDialog: , // 更改由消息处理器生成的警告对话框的基本设计 [可选，默认 => null]
        bottomSheet: , // 更改由消息处理器生成的底部菜单的基本设计 [可选，默认 => null]
        persistentSnackBar: , // 更改由消息处理器生成的持久性通知栏的基本设计 [可选，默认 => null]
        snackBar: , // 更改由消息处理器生成的通知栏的基本设计 [可选，默认 => null]
        child: const MyHomePage(title: 'Flutter Demo Home Page'), // [必需]
      ),
    );
  }
}

要发送消息，只需使用 sendMessage 函数并传递一个 NotificationMessage 对象。

messageHandler.sendMessage(
    message: NotificationMessage(
        level: NotificationMessageLevel.error, // 声明消息级别，这些级别包括：info, warning, error。必须通过 NotificationMessageLevel 枚举访问 [可选，默认 => error]
        title: "测试消息", // 消息标题 [可选，默认 => null]
        type: NotificationMessageType.alertDialog, // 声明消息类型，这些类型包括：alertDialog, snackBar, bottomSheet, persistentSnackBar。必须通过 NotificationMessageType 枚举访问 [可选，默认 => null]
        content: "测试消息内容", // 消息内容 [必需]
        onDismiss: () {} // 当消息被忽略时调用 [可选，默认 => null]
    ),
);

我们还可以在不触发用户消息的情况下调用中间件，只需调用 sendMessageToMiddlewares 方法：

messageHandler.sendMessageToMiddlewares(
    level: NotificationMessageLevel.error, // 声明消息级别，这些级别包括：info, warning, error。必须通过 NotificationMessageLevel 枚举访问 [必需]
    message: "测试中间件消息", // [可选，默认 => null]
    throwable: null, // 抛出的异常 [可选，默认 => null]
);

示例代码

下面是一个完整的示例代码，展示了如何使用 message_handler 插件。

import 'package:flutter/material.dart';
import 'package:message_handler/message_handler.dart';
import 'package:message_handler/models/notification_message.dart';

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

// 定义一个中间件类，实现 MessageHandlerMiddleware 接口
class TestMiddleware implements MessageHandlerMiddleware {
  const TestMiddleware();

  [@override](/user/override)
  void didShowMessage({
    required NotificationMessageLevel level,
    String? message,
    Object? throwable,
  }) {
    debugPrint({
      'level': level,
      'message': message,
      'throwable': throwable,
    }.toString());
  }
}

// 主应用类
class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MessageManager(
        middlewares: const [TestMiddleware()], // 添加中间件列表
        child: const MyHomePage(title: 'Flutter Demo Home Page'),
      ),
    );
  }
}

// 主页面类
class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      // 发送不同的消息类型
      messageHandler.sendMessage(
        message: NotificationMessage(
            content: "测试对话框", onDismiss: () {}),
      );
      messageHandler.sendMessage(
        message: NotificationMessage(
            title: "标题",
            content: "测试通知栏",
            type: NotificationMessageType.snackBar,
            onDismiss: () {}),
      );
      messageHandler.sendMessage(
        message: NotificationMessage(
            title: "标题",
            content: "测试底部菜单",
            type: NotificationMessageType.bottomSheet,
            level: NotificationMessageLevel.info,
            onDismiss: () {}),
      );
      messageHandler.sendMessage(
        message: NotificationMessage(
            title: "标题",
            content: "测试持久性通知栏",
            type: NotificationMessageType.persistentSnackBar,
            level: NotificationMessageLevel.warning,
            onDismiss: () {}),
      );
      // 调用中间件
      messageHandler.sendMessageToMiddlewares(
          level: NotificationMessageLevel.error,
          message: "测试中间件消息");
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              '你已经点击了按钮多少次:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: '增加',
        child: const Icon(Icons.add),
      ),
    );
  }
}