溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
前言
在Springboot的項目中使用Servlet的Filter來實現方法簽名時，發現請求的body不支持多次讀取。我是通過getInputStream()來獲取流，然后通過讀取流來獲取請求的body。
雖然網上有很多解決方案的例子，但是我發現沒有一篇文章解釋為什么會這樣的文章，所以決定自己去研究源碼。
問題表現
Content-Type為application/json的POST請求時，會返回狀態碼為400的響應，響應的body如下：
{
"timestamp": "2019-12-27T02:48:50.544+0000",
"status": 400,
"error": "Bad Request",
"message": "Required request body is missing: ...省略非關鍵信息...",
"path": "/"
}
而在日志中則有以下關鍵日志
2019-12-27 10:48:50.543 WARN 18352 --- [nio-8080-exec-2] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.http.converter.HttpMessageNotReadableException:...省略非關鍵信息...
初步分析
根據提示信息可以得知，由于請求的body沒有了，所以才會拋出這個異常。但是為什么body會沒有了呢？是否因為通過getInputStream()獲取到的流被讀取了所以引起這個問題呢？
復盤代碼
于是我編寫了一個復盤的示例，就是一個在日志中打印請求body的Filter，關鍵代碼如下：
@Slf4j
@WebFilter
public class InputStreamFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws ServletException, IOException {
ServletInputStream inputStream=servletRequest.getInputStream();
String charSetStr = servletRequest.getCharacterEncoding();
if (charSetStr == null) {
charSetStr = "UTF-8";
}
Charset charSet = Charset.forName(charSetStr);
log.info("請求的body為:\n{}",StreamUtils.copyToString(inputStream,charSet));
filterChain.doFilter(servletRequest,servletResponse);
}
RequestResponseBodyMethodProcessor
首先是找出拋出HttpMessageNotReadableException的方法和對應的類，關鍵類為RequestResponseBodyMethodProcessor的readWithMessageConverters()方法：
@Override
protected <T> Object readWithMessageConverters(NativeWebRequest webRequest, MethodParameter parameter,
Type paramType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {
...省略非關鍵代碼...
// 關鍵代碼
Object arg = readWithMessageConverters(inputMessage, parameter, paramType);
if (arg == null && checkRequired(parameter)) {
throw new HttpMessageNotReadableException("Required request body is missing: " +
parameter.getExecutable().toGenericString(), inputMessage);
}
return arg;
}
從上面的代碼可以得知，異常是由于readWithMessageConverters()方法返回null且這個參數是必填引起，現在主要關注為什么返回null。所以查看readWithMessageConverters()方法
AbstractMessageConverterMethodArgumentResolver
而實際上其實是調用了AbstractMessageConverterMethodArgumentResolver的readWithMessageConverters()方法，而在這個方法中其實是通過調用AbstractMessageConverterMethodArgumentResolver的內部類EmptyBodyCheckingHttpInputMessage的構造方法來獲取流。
readWithMessageConverters()關鍵代碼如下：
@Nullable
protected <T> Object readWithMessageConverters(HttpInputMessage inputMessage, MethodParameter parameter,
Type targetType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {
...省略非關鍵代碼...
EmptyBodyCheckingHttpInputMessage message;
try {
// 此處調用構造方法時進行了流的讀取
message = new EmptyBodyCheckingHttpInputMessage(inputMessage);
for (HttpMessageConverter<?> converter : this.messageConverters) {
Class<HttpMessageConverter<?>> converterType = (Class<HttpMessageConverter<?>>) converter.getClass();
GenericHttpMessageConverter<?> genericConverter =
(converter instanceof GenericHttpMessageConverter ? (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 (IOException ex) {
throw new HttpMessageNotReadableException("I/O error while reading input message", ex, inputMessage);
}
...省略非關鍵代碼...
MediaType selectedContentType = contentType;
Object theBody = body;
LogFormatUtils.traceDebug(logger, traceOn -> {
String formatted = LogFormatUtils.formatValue(theBody, !traceOn);
return "Read \"" + selectedContentType + "\" to [" + formatted + "]";
});
return body;
}
EmptyBodyCheckingHttpInputMessage關鍵構造方法如下：
// 從請求中獲取到的InputStream對象
@Nullable
private final InputStream body;
public EmptyBodyCheckingHttpInputMessage(HttpInputMessage inputMessage) throws IOException {
this.headers = inputMessage.getHeaders();
InputStream inputStream = inputMessage.getBody();
// 判斷InputStream是否支持mark
if (inputStream.markSupported()) {
// 標記流的起始位置
inputStream.mark(1);
// 讀取流
this.body = (inputStream.read() != -1 ? inputStream : null);
// 重置流，下次讀取會從起始位置重新開始讀取
inputStream.reset();
}
else {
// 回退輸入流，支持重復讀取的InputStream
PushbackInputStream pushbackInputStream = new PushbackInputStream(inputStream);
// 讀取流
int b = 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引起的。這里不做展開，有興趣的朋友可以自行跟蹤源碼的運行
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
