Flutter事件监听插件event_listener的使用

EventListener

类似于NodeJS的事件监听库，用于Dart！

使用方法

监听事件

import 'package:event_listener/event_listener.dart';

void main() {
  var eventListener = new EventListener();

  // 注册一个事件监听器
  eventListener.on('log', (String message) {
    print("A log: " + message); // 打印日志消息
  });

  // 触发事件
  eventListener.emit('log', 'from me'); // 输出 "A log: from me"
}

一次性触发事件

import 'package:event_listener/event_listener.dart';

void main() {
  var eventListener = new EventListener();

  // 监听新的事件
  eventListener.on('newListener', (MapEntry<String, Event> deletedEvent) {
    print("New event name: " + deletedEvent.key);
    print("New event caller: " + deletedEvent.value.caller);
  });
  /*
    New event name: log
    New event caller: closure (String message) =>
  */

  // 只触发一次的事件监听器
  eventListener.once('log', (String message) {
    print("A last log: " + message); // 输出 "A last log: from me"
  });
  eventListener.emit('log', 'from me');
}

移除事件监听器

import 'package:event_listener/event_listener.dart';

void main() {
  var eventListener = new EventListener();

  // 监听移除事件
  eventListener.on('removeListener', (MapEntry<String, Event> deletedEvent) {
    print("Deleted event name: " + deletedEvent.key);
    print("Deleted event caller: " + deletedEvent.value.caller);
  });
  /*
    Deleted event name: log
    Deleted event caller: closure (String message) =>
  */

  // 创建一个事件监听器
  var logMe = (message) {
    print("A last log: " + message);
  };
  // A last log: from me

  // 添加事件监听器并触发事件
  eventListener.once('log', logMe);
  eventListener.emit('log', 'from me');

  // 移除事件监听器
  eventListener.removeEventListener('log', logMe);
}

移除所有事件监听器

import 'package:event_listener/event_listener.dart';

void main() {
  var eventListener = new EventListener();

  // 创建一个事件监听器
  var logMe = (String message) {
    print("A last log: " + message);
  };

  // 添加多个事件监听器
  eventListener.once('log', logMe);
  eventListener.on('log', logMe);
  eventListener.emit('log', 'from me');

  // 移除所有事件监听器
  eventListener.removeAllListeners('log');
}

贡献指南

这个包模仿了NodeJS的事件监听模块，你可以自由地修改包，只要它看起来与Node包相似即可。

完整示例Demo

以下是一个完整的示例，展示了如何在下载文件时使用事件监听插件：

import 'package:event_listener/event_listener.dart';
import 'package:http/http.dart' as http;

Future<void> main() async {
  var downloadEmitter = EventListener();
  var fileToDownload = 'http://ipv4.download.thinkbroadband.com/5MB.zip'; // 测试文件

  final client = http.Client();
  var response = client.send(http.Request('GET', Uri.parse(fileToDownload)));
  var downloaded = 0;

  // 创建一个事件监听器，用于打印下载进度
  var logger = (percent) {
    print('Percent: $percent%');
  };

  // 添加事件监听器
  downloadEmitter.on('download', logger);

  // 监听HTTP响应流
  response.asStream().listen((http.StreamedResponse r) {
    r.stream.listen((List<int> chunk) {
      // 计算并触发下载进度事件
      downloadEmitter.emit(
          'download', (downloaded / r.contentLength! * 100).floor());
      downloaded += chunk.length;
    }, onDone: () async {
      // 下载完成时触发事件
      downloadEmitter.emit(
          'download', (downloaded / r.contentLength! * 100).floor());
      downloadEmitter.removeEventListener('download', logger);
      print('Download complete removed listener');
      return;
    });
  });
}