spring boot 全局异常处理捕获 sse 推送异常的核心在于使用 @exceptionhandler 拦截 sseemitter 抛出的 ioexception,并在方法签名中显式声明该异常类型。当服务端向客户端推送数据时,如果连接断开或写入失败,会触发此异常,通过自定义的处理器可以优雅地清理资源并记录日志,避免应用崩溃。

SseEmitter 抛出 IOException 的具体场景有哪些
在 Spring Boot 中,SseEmitter 基于 Servlet 3.0 的异步 IO 实现,其底层依赖 HttpServletResponse 的输出流。当客户端主动关闭浏览器标签、网络中断或服务器端尝试写入已关闭的连接时,底层流会抛出 java.io.IOException。这是最常见的 SSE 异常场景,通常表现为“Broken pipe”或“Connection reset”。

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
@Controller
public class SseController {
@GetMapping(value = "/stream", produces = "text/event-stream")
public SseEmitter stream() {
SseEmitter emitter = new SseEmitter();
// 模拟后台任务推送
new Thread(() -> {
try {
for (int i = 0; i < 5; i++) {
emitter.send(SseEmitter.event().name("data").data(i));
Thread.sleep(1000);
}
} catch (Exception e) {
// 这里会捕获到 IOException
emitter.completeWithError(e);
}
}).start();
return emitter;
}
}
上述代码展示了基本的 SSE 推送逻辑。当循环中的 emitter.send() 执行时,如果此时客户端已断开,send 方法内部会调用底层的 BufferedWriter.write,进而抛出 IOException。这个异常会被 try-catch 块捕获,并通过 completeWithError 通知全局异常处理器。开发者需要注意,SseEmitter 本身不会自动重试,一旦抛出异常,连接即告终止。
如何配置全局异常处理器来统一处理这些异常
要实现全局捕获,需要创建一个标记为 @RestControllerAdvice 或 @ControllerAdvice 的配置类,并定义一个带有 @ExceptionHandler(IOException.class) 的方法。关键在于该方法必须接收 SseEmitter 作为参数,以便获取当前的发射器实例进行清理操作。这样,无论哪个 Controller 中的 SSE 连接出错,都会路由到这个统一的处理逻辑中。

import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
import java.io.IOException;
@RestControllerAdvice
public class GlobalSseExceptionHandler {
@ExceptionHandler(IOException.class)
public void handleSseIOException(SseEmitter emitter, IOException ex) {
// 1. 记录日志
System.out.println("SSE connection lost: " + ex.getMessage());
// 2. 清理资源,完成发射器
emitter.complete();
}
}
在这个全局处理器中,handleSseIOException 方法接收两个参数:SseEmitter 和 IOException。Spring 会自动将当前出错的 SseEmitter 注入到第一个参数中。方法体中首先打印错误信息,然后调用 emitter.complete() 来正常关闭连接,释放相关的线程和内存资源。这种处理方式确保了即使发生异常,也不会导致 Tomcat 线程池耗尽或内存泄漏。对于其他类型的异常(如 TimeoutException),可以单独添加对应的 @ExceptionHandler 方法进行差异化处理。
当 SseEmitter 超时后,全局异常如何处理
SseEmitter 默认超时时间为 30 秒,如果超过这个时间没有发送任何数据,它会抛出 java.util.concurrent.TimeoutException。这与 IOException 不同,因此不能仅靠捕获 IOException 来处理所有情况。需要在创建 SseEmitter 时设置更长的超时时间,或者在全局异常处理器中额外添加对 TimeoutException 的捕获逻辑,以确保超时的连接也能被正确清理。


















