解决：org.apache.catalina.connector.ClientAbortException: java.io.IOException: 断开的管道

项目场景

jdk11
Spring Boot 2.x 项目，Tomcat容器
Nginx

问题描述

系统日志中，时不时会出现下面的异常信息：

org.apache.catalina.connector.ClientAbortException: java.io.IOException: 断开的管道
    at org.apache.catalina.connector.OutputBuffer.doFlush(OutputBuffer.java:310)
    at org.apache.catalina.connector.OutputBuffer.flush(OutputBuffer.java:273)
    at org.apache.catalina.connector.CoyoteOutputStream.flush(CoyoteOutputStream.java:118)
    at sun.nio.cs.StreamEncoder.implFlush(StreamEncoder.java:318)
    at sun.nio.cs.StreamEncoder.flush(StreamEncoder.java:153)
    at java.io.OutputStreamWriter.flush(OutputStreamWriter.java:251)
    at org.springframework.util.StreamUtils.copy(StreamUtils.java:148)
    at org.springframework.http.converter.StringHttpMessageConverter.writeInternal(StringHttpMessageConverter.java:126)
    ...

断开的管道，英文为：Broken pipe

原因分析

首先，需要理解什么是 断开的管道？

简单来说，断开的管道意味着一台机器试图从管道中读取或写入数据，而管道另一端的机器已经死亡或终止。现在，由于连接已经关闭，应该建立新的连接以进一步传输数据，否则数据传输将停止。

它是如何发生的?
可能的原因有：

1. 由于客户端在发送请求后，还没等服务器响应就断开了连接（可能是因为连接超时、网络原因(突然网断了)、或其他原因），导致服务端无返回通道
2. 服务端配置导致：tomcat配置 或者 nginx配置的超时时间小了
3. 服务端nginx配置导致：连续两次过快的 post 请求就会出现 499 的情况，nginx 认为这是不安全的连接，主动断开了客户端的连接。参考如下：

nginx 中的 src/http/ngx_http_special_response.c 文件中对 499 状态码进行了定义：
ngx_string(ngx_http_error_494_page), /* 494, request header too large /
ngx_string(ngx_http_error_495_page), / 495, https certificate error /
ngx_string(ngx_http_error_496_page), / 496, https no certificate /
ngx_string(ngx_http_error_497_page), / 497, http to https /
ngx_string(ngx_http_error_404_page), / 498, canceled /
ngx_null_string, / 499, client has closed connection */

从注释上，我们可以看到 499 表示客户端主动断开连接。

解决方案

可能的优化方案有：

1. 要求用户不要意外关闭连接（等于没说，哈哈哈）
2. 优化后端，减少api的响应时间
3. 增加服务器超时时间

tomcat中配置了一个连接超时时间connectionTimeout，如果在这个时间之后，客户端还未得到服务器端的响应的话，就会主动断开连接，这样就会出现上述异常了。tomcat中默认的连接超时时间是20秒，我们一般最好设置为60秒，从而避免后台程序处理时间长导致连接断开。

Nginx有一个名为 proxy_read_timeout 的变量，它的默认值是60s，增加这个值也可以减少出现该问题的几率；

4. 通过SpringBoot全局异常处理来优雅的处理异常
5. 上面原因3对应的解决方案：

修改nginx 配置：proxy_ignore_client_abort on;
这个参数的意思是 proxy 忽略客户端的中断，一直等待着代理服务器的返回，如果没有执行错误，则记录的日志是 200 日志，如果执行超时，记录的日志是 504 日志。