Flutter自定义事件处理插件custom_events的使用

Custom Events

该插件提供了在应用程序中管理自定义事件的有效方式。

使用方法

以下是一个完整的示例，展示如何使用 custom_events 插件来处理自定义事件。

完整示例代码

示例代码：main.dart

// 导入必要的包
import 'package:flutter/material.dart';
import 'package:custom_events/custom_events.dart'; // 引入自定义事件插件

// 主应用入口
void main() {
  runApp(const MyApp());
}

// 定义主应用类
class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: '自定义事件示例',
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: '自定义事件示例'),
    );
  }
}

// 定义主页面状态类
class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

// 定义主页面状态
class _MyHomePageState extends State<MyHomePage> {

  // 创建一个事件总线实例
  final eventBus = EventBus();

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

    // 订阅事件
    eventBus.on('my_event', (args) {
      print('接收到自定义事件: $args');
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: () {
                // 触发自定义事件
                eventBus.fire(Event('my_event', {'message': 'Hello, world!'}));
              },
              child: Text('触发事件'),
            ),
          ],
        ),
      ),
    );
  }
}

代码说明

1. 引入插件： 在 import 部分，我们引入了 custom_events 插件。该插件的核心是 EventBus 类，用于管理事件的订阅和触发。

2. 创建事件总线： 在 _MyHomePageState 中，通过 final eventBus = EventBus(); 创建了一个事件总线实例。

3. 订阅事件： 在 initState 方法中，通过 eventBus.on('my_event', callback) 订阅名为 'my_event' 的事件，并在回调函数中处理事件数据。

4. 触发事件： 在按钮的 onPressed 回调中，通过 eventBus.fire(Event('my_event', data)) 触发名为 'my_event' 的事件，并传递事件数据。

5. 事件数据格式： 事件数据以键值对的形式传递，例如 {'message': 'Hello, world!'}。

运行效果

运行上述代码后，点击按钮会触发自定义事件 'my_event'，并在控制台打印出事件数据：

接收到自定义事件: {message: Hello, world!}