Flutter事件监听插件rocket_listenable的使用

一个包提供了用于在Dart中实现可监听对象的混合类RocketListenable。

可监听对象允许其他对象注册和注销监听器，并且可以在更改发生时通知其监听器。

使用

要使用RocketListenable类，只需将其扩展到您的类中，并调用registerListener方法来注册监听器。当发生更改时，调用callListener方法以通知监听器。

import 'package:rocket_listenable/rocket_listenable.dart';

class MyModel with RocketListenable {
  String _data = '';

  String get data => _data;

  set data(String value) {
    _data = value;
    callListener('data');
  }
}

final myModel = MyModel();

myModel.registerListener('data', () {
  print('Data changed: ${myModel.data}');
});

myModel.data = 'Hello, world!';

方法

registerListener(String key, VoidCallback listener)

注册具有指定key的新监听器。

registerListeners(Map<String, List<VoidCallback>> listeners)

注册具有指定keys的多个监听器。

callListener(String key)

通知具有指定key的监听器。

callListeners(List<String> keys)

通知具有任何指定keys的监听器。

removeListener(String key, [VoidCallback? listener])

移除具有指定key的指定listener（如果未指定监听器，则移除所有监听器）。

removeListeners(List<String> keys, [List<VoidCallback>? listeners])

移除具有指定keys的指定listeners（如果未指定监听器，则移除所有监听器）。

hasListeners

如果此对象有任何监听器，则返回true。

keyHasListeners(String key)

如果具有指定key的监听器已注册，则返回true。

getListenersKeys

返回所有已注册监听器的键列表。

dispose()

处理此对象并移除所有监听器。

完整示例

以下是一个完整的示例，展示了如何使用RocketListenable插件。

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

// 创建一个可监听模型
class MyModel with RocketListenable {
  String _data = '';

  String get data => _data;

  set data(String value) {
    _data = value;
    callListener('data');
  }
}

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Rocket Listenable Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

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

class _MyHomePageState extends State<MyHomePage> {
  final MyModel _model = MyModel();

  [@override](/user/override)
  void initState() {
    super.initState();
    // 注册监听器
    _model.registerListener('data', () {
      setState(() {
        print('Data changed: ${_model.data}');
      });
    });
  }

  [@override](/user/override)
  void dispose() {
    // 移除监听器
    _model.removeListener('data', () {});
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Rocket Listenable Example'),
      ),
      body: Center(
        child: Text(
          'Current Data: ${_model.data}',
          style: TextStyle(fontSize: 20),
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          // 更新数据并触发监听器
          _model.data = DateTime.now().toString();
        },
        child: Icon(Icons.update),
      ),
    );
  }
}