Flutter事件流监听插件eventsource3的使用

Flutter事件流监听插件eventsource3的使用

Client usage（客户端使用）

创建一个新的EventSource客户端非常简单，只需要一次调用。此库在底层使用了http包，因此只要该包可用，此库也会正常工作。浏览器中的使用略有不同。

EventSource eventSource = await EventSource.connect("http://example.com/events");
// 在浏览器中，你需要传递一个http.BrowserClient：
EventSource eventSource = await EventSource.connect("http://example.com/events", 
    client: new http.BrowserClient());

Server usage（服务器端使用）

我们推荐使用shelf_eventsource来处理Server-Sent Events。此库提供了EventSourcePublisher，用于管理订阅、通道和编码。更多详细信息可以参考shelf_eventsource包中的文档。

此库还包含了一个针对dart:io的HttpServer的服务器提供者，在io_server.dart文件中。然而，它在数据刷新方面存在一些尚未解决的问题，所以我们建议使用shelf。

Licensing（许可证）

本项目采用MIT许可证，详情可以在LICENSE文件中找到。

完整示例Demo

客户端示例

首先确保你已经安装了eventsource3和http库。你可以通过以下命令添加到你的pubspec.yaml文件：

dependencies:
  eventsource3: ^x.x.x
  http: ^0.13.4

然后创建一个简单的Flutter应用来连接并监听事件流。

import 'dart:async';
import 'package:eventsource3/eventsource3.dart' as es;
import 'package:http/http.dart' as http;

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('EventSource Demo'),
        ),
        body: Center(
          child: Text('Listening to events...'),
        ),
      ),
    );
  }
}

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

class _EventSourcePageState extends State<EventSourcePage> {
  final String eventUrl = "http://example.com/events";
  StreamSubscription<String> _subscription;

  [@override](/user/override)
  void initState() {
    super.initState();
    listenToEvents();
  }

  void listenToEvents() async {
    try {
      // 创建一个EventSource实例
      EventSource eventSource = await es.EventSource.connect(eventUrl, client: http.BrowserClient());

      // 添加事件监听器
      _subscription = eventSource.onData.listen((data) {
        print('Received event: $data');
        setState(() {
          // 更新UI
          ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text(data)));
        });
      });

      // 添加错误监听器
      eventSource.onError.listen((error) {
        print('Error occurred: $error');
        setState(() {
          ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Error: $error')));
        });
      });

      // 添加关闭监听器
      eventSource.onClose.listen((_) {
        print('Connection closed');
        setState(() {
          ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Connection closed')));
        });
      });
    } catch (e) {
      print('Failed to connect: $e');
      setState(() {
        ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Failed to connect: $e')));
      });
    }
  }

  [@override](/user/override)
  void dispose() {
    if (_subscription != null) {
      _subscription.cancel(); // 取消订阅
    }
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Container();
  }
}