为什么SpringMVC中请求的body不支持多次读取

2023-08-03 16:43:04 70

前言

在Springboot的项目中使用Servlet的Filter来实现方法签名时，发现请求的body不支持多次读取。我是通过getInputStream()来获取流，然后通过读取流来获取请求的body。

虽然网上有很多解决方案的例子，但是我发现没有一篇文章解释为什么会这样的文章，所以决定自己去研究源码。

问题表现

Content-Type为application/json的POST请求时，会返回状态码为400的响应，响应的body如下：

{
"timestamp":"2019-12-27T02:48:50.544+0000",
"status":400,
"error":"BadRequest",
"message":"Requiredrequestbodyismissing:...省略非关键信息...",
"path":"/"
}

而在日志中则有以下关键日志

2019-12-2710:48:50.543 WARN18352---[nio-8080-exec-2].w.s.m.s.DefaultHandlerExceptionResolver:Resolved[org.springframework.http.converter.HttpMessageNotReadableException:...省略非关键信息...

初步分析

根据提示信息可以得知，由于请求的body没有了，所以才会抛出这个异常。但是为什么body会没有了呢？是否因为通过getInputStream()获取到的流被读取了所以引起这个问题呢？

复盘代码

于是我编写了一个复盘的示例，就是一个在日志中打印请求body的Filter，关键代码如下：

@Slf4j
@WebFilter
publicclassInputStreamFilterimplementsFilter{

@Override
publicvoiddoFilter(ServletRequestservletRequest,ServletResponseservletResponse,FilterChainfilterChain)throwsServletException,IOException{
ServletInputStreaminputStream=servletRequest.getInputStream();
StringcharSetStr=servletRequest.getCharacterEncoding();
if(charSetStr==null){
charSetStr="UTF-8";
}
CharsetcharSet=Charset.forName(charSetStr);
log.info("请求的body为:\n{}",StreamUtils.copyToString(inputStream,charSet));
filterChain.doFilter(servletRequest,servletResponse);
}

RequestResponseBodyMethodProcessor

首先是找出抛出HttpMessageNotReadableException的方法和对应的类，关键类为RequestResponseBodyMethodProcessor的readWithMessageConverters()方法：

@Override
protectedObjectreadWithMessageConverters(NativeWebRequestwebRequest,MethodParameterparameter,
TypeparamType)throwsIOException,HttpMediaTypeNotSupportedException,HttpMessageNotReadableException{
...省略非关键代码...
//关键代码
Objectarg=readWithMessageConverters(inputMessage,parameter,paramType);
if(arg==null&&checkRequired(parameter)){
thrownewHttpMessageNotReadableException("Requiredrequestbodyismissing:"+
parameter.getExecutable().toGenericString(),inputMessage);
}
returnarg;
}

从上面的代码可以得知，异常是由于readWithMessageConverters()方法返回null且这个参数是必填引起，现在主要关注为什么返回null。所以查看readWithMessageConverters()方法

AbstractMessageConverterMethodArgumentResolver

而实际上其实是调用了AbstractMessageConverterMethodArgumentResolver的readWithMessageConverters()方法，而在这个方法中其实是通过调用AbstractMessageConverterMethodArgumentResolver的内部类EmptyBodyCheckingHttpInputMessage的构造方法来获取流。

readWithMessageConverters()关键代码如下：

@Nullable
protectedObjectreadWithMessageConverters(HttpInputMessageinputMessage,MethodParameterparameter,
TypetargetType)throwsIOException,HttpMediaTypeNotSupportedException,HttpMessageNotReadableException{
...省略非关键代码...
EmptyBodyCheckingHttpInputMessagemessage;
try{
//此处调用构造方法时进行了流的读取
message=newEmptyBodyCheckingHttpInputMessage(inputMessage);
for(HttpMessageConverterconverter:this.messageConverters){
Class>converterType=(Class>)converter.getClass();
GenericHttpMessageConvertergenericConverter=
(converterinstanceofGenericHttpMessageConverter?(GenericHttpMessageConverter)converter:null);
if(genericConverter!=null?genericConverter.canRead(targetType,contextClass,contentType):
(targetClass!=null&&converter.canRead(targetClass,contentType))){
if(message.hasBody()){
...省略非关键代码...
}
else{
//此处是处理流读取返回null的情况
body=getAdvice().handleEmptyBody(null,message,parameter,targetType,converterType);
}
break;
}
}
}
catch(IOExceptionex){
thrownewHttpMessageNotReadableException("I/Oerrorwhilereadinginputmessage",ex,inputMessage);
}

...省略非关键代码...

MediaTypeselectedContentType=contentType;
ObjecttheBody=body;
LogFormatUtils.traceDebug(logger,traceOn->{
Stringformatted=LogFormatUtils.formatValue(theBody,!traceOn);
return"Read\""+selectedContentType+"\"to["+formatted+"]";
});

returnbody;
}

EmptyBodyCheckingHttpInputMessage关键构造方法如下：

//从请求中获取到的InputStream对象
@Nullable
privatefinalInputStreambody;

publicEmptyBodyCheckingHttpInputMessage(HttpInputMessageinputMessage)throwsIOException{
this.headers=inputMessage.getHeaders();
InputStreaminputStream=inputMessage.getBody();
//判断InputStream是否支持mark
if(inputStream.markSupported()){
//标记流的起始位置
inputStream.mark(1);
//读取流
this.body=(inputStream.read()!=-1?inputStream:null);
//重置流，下次读取会从起始位置重新开始读取
inputStream.reset();
}
else{
//回退输入流，支持重复读取的InputStream
PushbackInputStreampushbackInputStream=newPushbackInputStream(inputStream);
//读取流
intb=pushbackInputStream.read();
if(b==-1){
//返回-1表示流无数据存在
this.body=null;
}
else{
//流存在数据，直接赋值
this.body=pushbackInputStream;
//回退流到起始位置，等价于reset()方法
pushbackInputStream.unread(b);
}
}
}

从上面的代码可以得知，起始SpringMVC是支持对请求的InputStream进行多次读取的以及InputStream其实可以支持流重复读取。但是实际上却出现不支持流重复读取的情况，这是为什么呢？

下面会通过分析Jetty应用服务器对InputStream的实现来进行分析。

HttpInput

Jetty中继承InputStrean的类是org.eclipse.jetty.server.HttpInputOverHTTP，而关键的代码在其父类HttpInput上。

首先HttpInput继承了ServletInputStream（这个抽象类继承了·InputStream抽象类），且并未重写markSupported()方法（这个方法默认实现为返回false）。所以问题应该是由于HttpInput流重复读取会直接返回-1引起的。这里不做展开，有兴趣的朋友可以自行跟踪源码的运行

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

为什么SpringMVC中请求的body不支持多次读取

热门推荐

随机推荐