Spring Rest接口返回InputStreamResource无法实时刷新流问题排查

问题根本原因 #

• 你在PipedOutputStream调用的flush仅能将数据从管道输出端刷到输入端，还停留在应用内存中，没有进入Servlet的响应输出链路
• Spring Web MVC默认对返回的InputStreamResource会启用响应内容缓冲，目的是提前计算Content-Length响应头，就算数据进入响应链路也会先存在Spring的缓冲中，不会直接发给客户端
• 内置Servlet容器（Tomcat、Jetty等）默认存在8KB左右的响应缓冲区，数据量没达到阈值也不会自动刷给客户端
• 如果你的服务前有Nginx等反向代理，默认开启的响应缓冲也会攒够数据块才向浏览器转发，导致实时性失效

修复方案 #

方案1：改用StreamingResponseBody（推荐） #

Spring的StreamingResponseBody是专门设计用来处理异步流输出的场景，会跳过默认的缓冲逻辑，直接把写入的内容向下传递，同时不需要再用管道流做中转，减少不必要的IO开销：

@GetMapping("/session")
public ResponseEntity<StreamingResponseBody> openSession(){
    return ResponseEntity.ok()
        .contentType(MediaType.TEXT_PLAIN)
        // 禁用缓存，防止代理/浏览器缓存内容
        .header("Cache-Control", "no-cache, no-store, must-revalidate")
        .header("Pragma", "no-cache")
        .header("Expires", "0")
        // 明确指定分块传输，不需要提前计算Content-Length
        .header("Transfer-Encoding", "chunked")
        .body(outputStream -> {
            // 直接把输出流传给你的推送逻辑即可
            spawnThreadAndPushMessages(outputStream);
        });
}

方案2：如果要继续用InputStreamResource，需要手动关闭响应缓冲 #

在接口方法注入HttpServletResponse，关闭Servlet层的缓冲：

@GetMapping("/session")
public ResponseEntity<InputStreamResource> openSession(HttpServletResponse response){
    // 关闭Servlet层的响应缓冲
    response.setBufferSize(0);
    var inLog = new PipedInputStream();
    var logWritable = new PipedOutputStream(inLog);
    spawnThreadAndPushMessages(logWritable);

    return ResponseEntity.ok()
        .contentType(MediaType.TEXT_PLAIN)
        .header("Cache-Control", "no-cache, no-store, must-revalidate")
        .header("Pragma", "no-cache")
        .header("Expires", "0")
        .header("Transfer-Encoding", "chunked")
        .body(new InputStreamResource(inLog));
}

额外检查项 #

• 如果使用了Tomcat作为内置容器，可在配置文件中添加配置：server.servlet.response-buffer-size=0，彻底关闭容器层的响应缓冲
• 如果服务前部署了Nginx反向代理，需要在对应的location配置中添加proxy_buffering off;关闭代理缓冲，否则Nginx还是会攒够数据再转发

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