遇到问题
起因是这样的:我在完成一个Excel导出的功能,写完代码之后Excel能够正常导出下载,但是却无法打开。
开发环境:
JDK 1.8
spring boot 1.5.6.RELEASE
easypoi 3.0.3
调试过程
- 首先我尝试将生成的Workbook接入本地File,能够生成Excel文件,并且能够正常打开,证明Excel生成的代码没有问题。
- 同样的生成Excel代码在另一个项目中能够正常生成并下载之后也能正常打开,排除是代码的问题。
- 既然生成文件没有问题,但是经过接口传输后的Excel却无法打开,查看Response的Header,同一个Excel多次请求接口Content-Length的值却不一样,因此怀疑是这个造成的。
- 对比两个项目的区别,正常的Response的Header中只有
transfer-encoding: chunked
,并没有Content-Length,而不正常的项目中有Content-Length但是没有transfer-encoding。
分析
Content-Length会影响Response body的接口:HTTP Content-Length深入实践 。
而Transfer-Encoding表示body的长度不确定:HTTP协议之Transfer-Encoding 。
因此怀疑是Content-Length的值不正确导致接收的Excel不完整,所以无法打开。而Transfer-Encoding则会完整地接收Excel,因此能够正常打开。
难点
找到了原因,但是我没有找到解决的办法,两个项目的环境版本都是一致的。而且也没有手动的设置Content-Length和Transfer-Encoding,这两个Header都是spring boot框架自动添加。我也没有找到更改输出的控制。最终转化成一个问题:在spring boot中如何控制返回的Response Header中Content-Length还是Transfer-Encoding?
另外基于HTTP的规则:如果存在Transfer-Encoding(重点是chunked),则在header中不能有Content-Length,有也会被忽视。我尝试手动添加Transfer-Encoding以覆盖Content-Length。但是当手动设置Transfer-Encoding之后,接口无法访问:swagger显示TypeError: Failed to fetch
。服务端日志中也没有报错信息。
解决
后来这篇文章:transfer-encoding和content-length的不同实现 给了我思路。Transfer-Encoding 是传输数据编码,Content-Encoding 是传输内容编码,却别在于传输的内容,于是我想到是否有可能是我改变了body中的内容才导致的。
然后我查找了项目,注意到自定了一个LogFilter,用于输出request和response的header,param,body的内容,实际上这里就吧response的body转换成了字符串进行输入,实际上就是改变了body中的数据。
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
String basePath = servletRequest.getScheme() + "://" + servletRequest.getServerName()
+ ":" + servletRequest.getServerPort() + request.getRequestURI();
log.info("request path: " + basePath);
if (!isSwaggerPath(request)) {
log.info("headers: {}", getHeaders(request));
ContentCachingRequestWrapper wrapperRequest = new ContentCachingRequestWrapper(request);
ContentCachingResponseWrapper wrapperResponse = new ContentCachingResponseWrapper((HttpServletResponse) servletResponse);
String urlParams = getRequestParams(request);
filterChain.doFilter(wrapperRequest, wrapperResponse);
String requestBodyStr = getRequestBody(wrapperRequest);
log.info("params[{}] | request body:{}", urlParams, requestBodyStr);
String responseBodyStr = getResponseBody(wrapperResponse);
log.info("response body:{}", responseBodyStr);
wrapperResponse.copyBodyToResponse();
} else {
filterChain.doFilter(servletRequest, servletResponse);
}
}
尝试去掉这个Filter,果然response的Header变成了Transfer-Encoding,Excel也能正常打开了。