Spring Boot+SSE场景下如何避免日志充斥Broken pipe异常？

我完全懂你的痛点——客户端正常关闭SSE连接，结果Tomcat疯狂输出ClientAbortException: Broken pipe的ERROR级堆栈日志，明明是预期行为却把日志搞得乱糟糟的。不用改Tomcat代码，有几个靠谱的解决方案：

方案1：用Spring全局异常处理器捕获并忽略 #

你可以创建一个全局异常处理类，专门拦截ClientAbortException，只做轻量处理（比如打个debug日志或者直接忽略），避免ERROR级别的堆栈刷屏。

代码示例：

import org.apache.catalina.connector.ClientAbortException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class SseClientAbortHandler {
    private static final Logger log = LoggerFactory.getLogger(SseClientAbortHandler.class);

    @ExceptionHandler(ClientAbortException.class)
    public void handleClientDisconnect(ClientAbortException ex) {
        // 可选：只打debug级别的日志，记录客户端断开事件
        log.debug("SSE客户端主动断开连接: {}", ex.getMessage());
        // 如果不需要日志，直接空实现即可
    }
}

这个方案的好处是能在代码层面精准控制异常处理逻辑，比如统计断开次数之类的额外操作。

方案2：通过日志配置过滤异常（最省心） #

如果不想写代码，直接调整日志框架的配置，把ClientAbortException的ERROR日志过滤掉就行。下面以常用的Logback和Log4j2为例：

Logback配置（logback-spring.xml） #

在你的日志appender里添加一个过滤器，拒绝输出该异常的日志：

<configuration>
    <!-- 其他基础配置... -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
            <evaluator>
                <!-- 匹配ClientAbortException及其子类 -->
                <expression>throwable != null && throwable instanceof org.apache.catalina.connector.ClientAbortException</expression>
            </evaluator>
            <onMatch>DENY</onMatch> <!-- 匹配到就拒绝输出 -->
            <onMismatch>NEUTRAL</onMatch> <!-- 不匹配就正常处理 -->
        </filter>
    </appender>
    <!-- 其他appender和logger配置... -->
</configuration>

Log4j2配置（log4j2-spring.xml） #

类似地，添加一个ScriptFilter来过滤：

<Configuration>
    <!-- 其他基础配置... -->
    <Appenders>
        <Console name="CONSOLE" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"/>
            <Filters>
                <ScriptFilter onMatch="DENY" onMisMatch="NEUTRAL">
                    <Script language="javascript">
                        throwable != null && throwable instanceof org.apache.catalina.connector.ClientAbortException
                    </Script>
                </ScriptFilter>
            </Filters>
        </Console>
    </Appenders>
    <!-- 其他logger配置... -->
</Configuration>

这个方案零代码侵入，只需要改配置文件，适合快速解决日志刷屏问题。

方案3：调整Spring Boot的Tomcat错误页面配置 #

你可以通过Spring Boot的配置项，让Tomcat不输出异常的堆栈信息。在application.properties里添加：

# 全局关闭错误页面的堆栈输出
server.error.include-stacktrace=never

不过要注意，这个配置是全局生效的，会影响所有异常的堆栈输出，如果你的项目需要保留其他异常的堆栈信息，这个方案就不太合适了。

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