Flutter无法接收Server-Sent Events(SSE)服务器数据的问题排查

已实现代码 #

Stream<dynamic> fetchRoutingStream() async* {
    // Fetch the token asynchronously
    SharedPrefsRepository sharedPrefsRepository =
        SharedPrefsRepository(provider: SharedPrefsProvider());
    String token = await sharedPrefsRepository.getAccessToken();

    final url = 'https://example.com/api/v1/web/route/';

    // Subscribe to SSE
    SSEClient.subscribeToSSE(
        method: SSERequestType.GET,
        url: url,
        header: {'Authorization': 'Bearer $token'}
    ).listen(
        (event) {
            // Log the event details
            print('Id: ' + (event.id ?? ''));
            print('Event: ' + (event.event ?? ''));
            print('Data: ' + (event.data ?? ''));
        },
    );
}

问题现象 #

代码从未进入.listen()回调，打印语句无输出；已通过浏览器开发者工具确认API每5秒推送数据，推测连接未建立或SSE配置异常。

疑问解答与调试方案 #

1. 监听器无响应的核心原因 #

• Stream未被正确持有：函数声明返回Stream<dynamic>但未将SSE的stream返回，也未保留订阅引用。若调用fetchRoutingStream()后未正确订阅或订阅被提前回收，监听器会失效。
• 请求头不完整：缺少SSE标准要求的Accept: text/event-stream头，部分服务器会拒绝此类请求；或Authorization头格式错误（比如Bearer后缺空格）、token失效。
• SSE响应不符合标准：服务器未返回Content-Type: text/event-stream或Cache-Control: no-cache头，导致客户端无法识别为SSE流。
• 异步逻辑隐患：虽然用await获取token，但需确认getAccessToken()是否真的返回有效、格式正确的token。

2. 具体调试与修复步骤 #

• 修正Stream返回逻辑：保留SSE流的订阅并返回Stream，避免被垃圾回收：

  Stream<dynamic> fetchRoutingStream() async* {
    SharedPrefsRepository sharedPrefsRepository =
        SharedPrefsRepository(provider: SharedPrefsProvider());
    String token = await sharedPrefsRepository.getAccessToken();
  
    final url = 'https://example.com/api/v1/web/route/';
  
    // 显式添加SSE标准请求头
    final sseStream = SSEClient.subscribeToSSE(
        method: SSERequestType.GET,
        url: url,
        header: {
          'Authorization': 'Bearer $token',
          'Accept': 'text/event-stream',
          'Cache-Control': 'no-cache'
        });
    
    // 监听并转发事件
    await for (var event in sseStream) {
      print('Id: ' + (event.id ?? ''));
      print('Event: ' + (event.event ?? ''));
      print('Data: ' + (event.data ?? ''));
      yield event;
    }
  }
  

  调用时需持有订阅引用：

  // 保存订阅，避免被回收
  final subscription = fetchRoutingStream().listen((event) {
    // 业务逻辑处理
  });
  // 不需要时再取消订阅：subscription.cancel();
  

• 添加错误监听：捕获连接或数据异常，定位问题：

  SSEClient.subscribeToSSE(...)
    .listen(...)
    .onError((error) {
      print('SSE连接/数据错误: $error');
    });
  

• 验证token有效性：打印token值确认格式正确，用Postman直接调用API测试该token是否能获取正常的SSE流。
• 检查服务器响应头：确认服务器返回的响应包含Content-Type: text/event-stream和Cache-Control: no-cache，且数据格式符合SSE规范（每行以data:开头，空行分隔事件）。
• 排查HTTPS证书问题：若为HTTPS连接，可临时改用HTTP测试（仅调试用），或确认flutter_client_sse是否支持当前服务器的SSL证书配置。

内容的提问来源于stack exchange，提问作者Saeed