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

前言

在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,Type targetType) throws IOException,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,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引起的。这里不做展开,有兴趣的朋友可以自行跟踪源码的运行

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

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


开发过程中是不可避免地会出现各种异常情况的,例如网络连接异常、数据格式异常、空指针异常等等。异常的出现可能导致程序的运行出现问题,甚至直接导致程序崩溃。因此,在开发过程中,合理处理异常、避免异常产生、以及对异常进行有效的调试是非常重要的。 对于异常的处理,一般分为两种方式: 编程式异常处理:是指在代
说明:使用注解方式实现AOP切面。 什么是AOP? 面向切面编程,利用AOP可以对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。 通俗描述:不通过修改源代码方式,在主干功能里面添加新功能。 AOP底层使用动态代理。 AOP术语 连接点
Spring MVC中的拦截器是一种可以在请求处理过程中对请求进行拦截和处理的机制。 拦截器可以用于执行一些公共的操作,例如日志记录、权限验证、数据转换等。在Spring MVC中,可以通过实现HandlerInterceptor接口来创建自定义的拦截器,并通过配置来指定拦截器的应用范围和顺序。 S
在 JavaWeb 中,共享域指的是在 Servlet 中存储数据,以便在同一 Web 应用程序的多个组件中进行共享和访问。常见的共享域有四种:ServletContext、HttpSession、HttpServletRequest、PageContext。 ServletContext 共享域:
文件上传 说明: 使用maven构建web工程。 使用Thymeleaf技术进行服务器页面渲染。 使用ResponseEntity实现下载文件的功能。 @Controller public class FileDownloadAndUpload { @GetMapping(&quot;/file/d
创建初始化类,替换web.xml 在Servlet3.0环境中,Web容器(Tomcat)会在类路径中查找实现javax.servlet.ServletContainerInitializer接口的类,如果找到的话就用它来配置Servlet容器。 Spring提供了这个接口的实现,名为SpringS
在 Web 应用的三层架构中,确保在表述层(Presentation Layer)对数据进行检查和校验是非常重要的。正确的数据校验可以确保业务逻辑层(Business Logic Layer)基于有效和合法的数据进行处理,同时将错误的数据隔离在业务逻辑层之外。这有助于提高系统的健壮性、安全性和可维护
什么是事务? 事务(Transaction)是数据库操作最基本单元,逻辑上一组操作,要么都成功,要么都失败,如果操作之间有一个失败所有操作都失败 。 事务四个特性(ACID) 原子性 一组操作要么都成功,要么都失败。 一致性 一组数据从事务1合法状态转为事务2的另一种合法状态,就是一致。 隔离性 事
什么是JdbcTemplate? Spring 框架对 JDBC 进行封装,使用 JdbcTemplate 方便实现对数据库操作。 准备工作 引入jdbcTemplate的相关依赖: 案例实操 创建jdbc.properties文件,配置数据库信息 jdbc.driver=com.mysql.cj.
SpringMVC1.MVC架构MVC是模型(Model)、视图(View)、控制器(Controller)的简写,是一种软件设计规范是将业务逻辑、数据、显示分离的方法来写代码MVC主要作用是:降低了视图和业务逻辑之间的双向耦合MVC是一个架构模型,不是一种设计模式。1.model(模型)数据模型,提供要展示的数据,因此包
SpringMVC学习笔记1.SpringMVC应用1.1SpringMVC简介​SpringMVC全名叫SpringWebMVC,是⼀种基于Java的实现MVC设计模型的请求驱动类型的轻量级Web框架,属于SpringFrameWork的后续产品。​MVC全名是ModelViewController,是模型(model)-视图(view)-控制器(co
11.1数据回显基本用法数据回显就是当用户数据提交失败时,自动填充好已经输入的数据。一般来说,如果使用Ajax来做数据提交,基本上是没有数据回显这个需求的,但是如果是通过表单做数据提交,那么数据回显就非常有必要了。11.1.1简单数据类型简单数据类型,实际上框架在这里没有
一、SpringMVC简介1、SpringMVC中重要组件DispatcherServlet:前端控制器,接收所有请求(如果配置/不包含jsp)HandlerMapping:解析请求格式的.判断希望要执行哪个具体的方法.HandlerAdapter:负责调用具体的方法.ViewResovler:视图解析器.解析结果,准备跳转到具体的物
1.它们主要负责的模块Spring主要应用于业务逻辑层。SpringMVC主要应用于表现层。MyBatis主要应用于持久层。2.它们的核心Spring有三大核心,分别是IOC(控制反转),DI(依赖注入)和AOP(面向切面编程)。SpringMVC的核心是DispatcherServlet(前端控制器)。MyBatis的核心是ORM(对
3.注解开发Springmvc1.使用注解开发要注意开启注解支持,2.注解简化了,处理映射器和处理适配器,只用去管视图解析器即可案例代码:1.web.xml,基本不变可以直接拿去用<!--调用DispatcherServlet--><servlet><servlet-name>springmvc</servlet-name>
拦截器概述SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。开发者可以自己定义一些拦截器来实现特定的功能。**过滤器与拦截器的区别:**拦截器是AOP思想的具体应用。过滤器servlet规范中的一部分,任何javaweb工程都可以使用
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:context="http://www.springframework.org/schema/context"xmlns:mvc="http://www.springframework.org/schema/mvc"xmlns:xsi="
学习内容:1、SSH&SSM2、Spring3、Struts2&SpringMVC4、Hibernate&MyBatis学习产出:1.SSH和SSM都是有Spring框架的,他们两个差不多。2.Spring分为四个模块,持久层,表示层,检测层,还有核心层,核心层分为2个关键核心功能。分别为,控制反转(IOC),依赖注入(DI),和面向切面编程
一、SpringMVC项目无法引入js,css的问题具体原因是css和js等被SpringMVC拦截了:解决方案:在spring-mvc.xml中配置<mvc:default-servlet-handler/><?xmlversion="1.0"encoding="UTF-8"?><beansxmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
开发环境:Eclipse/MyEclipse、Tomcat8、Jdk1.8数据库:MySQL前端:JavaScript、jQuery、bootstrap4、particles.js后端:maven、SpringMVC、MyBatis、ajax、mysql读写分离、mybatis分页适用于:课程设计,毕业设计,学习等等系统介绍