Spring MVC参数接收详解：RequestParam、RequestBody与PathVariable

66 浏览量更新于2024-09-01 收藏 307KB PDF 举报

"这篇教程全面总结了Spring MVC中如何接收请求参数，涵盖了@RequestParam、@RequestBody、@PathVariable等注解的使用，并深入解析了SpringMVC处理请求参数的机制，包括HandlerMethodArgumentResolver接口及其子类，以及HttpMessageConverter的作用。" 在Spring MVC框架中，处理HTTP请求参数是一项关键任务。本教程主要讲解了Spring MVC如何处理和接收这些参数，特别是关注于控制器方法的参数绑定。首先，我们来看一下`RequestParam`，`RequestBody`和`PathVariable`这三种主要的注解。 1. RequestParam注解：用于处理请求URL中查询参数或表单数据中的参数。例如，如果我们有一个GET请求`/users?id=123`，可以在控制器方法中使用`@RequestParam("id") Long id`来接收参数。同时，RequestParam也支持处理基本类型如long、int等，以及MultipartFile类型，用于上传文件。 2. RequestBody注解：当需要从请求体中读取JSON或其他格式的数据时，可以使用`@RequestBody`。它会使用合适的HttpMessageConverter（如MappingJackson2HttpMessageConverter）将请求体转换为Java对象。这通常发生在POST、PUT等请求中，且Content-Type为application/json等。 3. PathVariable注解：用于接收URL模板变量的值。例如，在路径`/users/{userId}`中，我们可以使用`@PathVariable("userId") String userId`来获取该值。 Spring MVC的请求参数处理机制基于`HandlerMethodArgumentResolver`接口。这个接口的实现类负责解析控制器方法的参数，如`RequestParamMethodArgumentResolver`、`RequestResponseBodyMethodProcessor`和`PathVariableMapMethodArgumentResolver`。实际应用中，Spring MVC使用`HandlerMethodArgumentResolverComposite`聚合多个解析器，根据不同的注解和参数类型选择合适的处理策略。在处理参数时，`HttpMessageConverter`起着至关重要的作用。它能够将HTTP消息体转换为Java对象，或者将Java对象转换为HTTP消息体。例如，`MappingJackson2HttpMessageConverter`负责处理JSON数据。具体哪个`HttpMessageConverter`被使用，取决于请求头中的`Content-Type`（在Spring MVC中称为`MediaType`）。理解这些核心概念有助于我们更有效地设计和实现Spring MVC的控制器，以正确地接收和处理来自客户端的各种请求参数。通过深入学习这些内容，开发者能够更好地掌握Spring MVC的请求处理机制，从而提高Web应用的开发效率和质量。

Spring MVC请求参数接收的全面总结教程请求参数接收的全面总结教程

主要给大家总结介绍了关于Spring MVC请求参数接收的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小

编来一起学习学习吧

前提前提

在日常使用SpringMVC进行开发的时候，有可能遇到前端各种类型的请求参数，这里做一次相对全面的总结。SpringMVC中处理控制器参数的接口是HandlerMethodArgumentResolver，此接口有众多子

类，分别处理不同(注解类型)的参数，下面只列举几个子类：

RequestParamMethodArgumentResolver：解析处理使用了@RequestParam注解的参数、MultipartFile类型参数和Simple类型(如long、int)参数。

RequestResponseBodyMethodProcessor：解析处理@RequestBody注解的参数。

PathVariableMapMethodArgumentResolver：解析处理@PathVariable注解的参数。

实际上，一般在解析一个控制器的请求参数的时候，用到的是HandlerMethodArgumentResolverComposite，里面装载了所有启用的HandlerMethodArgumentResolver子类。而

HandlerMethodArgumentResolver子类在解析参数的时候使用到HttpMessageConverter(实际上也是一个列表，进行遍历匹配解析)子类进行匹配解析，常见的如

MappingJackson2HttpMessageConverter。而HandlerMethodArgumentResolver子类到底依赖什么HttpMessageConverter实例实际上是由请求头中的ContentType(在SpringMVC中统一命名为

MediaType，见org.springframework.http.MediaType)决定的，因此我们在处理控制器的请求参数之前必须要明确外部请求的ContentType到底是什么。上面的逻辑可以直接看源码

AbstractMessageConverterMethodArgumentResolver#readWithMessageConverters，思路是比较清晰的。在@RequestMapping注解中，produces和consumes就是和请求或者响应的ContentType相关

的：

consumes：指定处理请求的提交内容类型(ContentType)，例如application/json, text/html，只有命中了才会接受该请求。

produces：指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回，如果返回的是JSON数据一般使用application/json;charset=UTF-8。

另外提一点，SpringMVC中默认使用Jackson作为JSON的工具包，如果不是完全理解透整套源码的运作，一般不是十分建议修改默认使用的MappingJackson2HttpMessageConverter(例如有些人喜欢使

用FastJson，实现HttpMessageConverter引入FastJson做转换器)。

SpringMVC请求参数接收请求参数接收

其实一般的表单或者JSON数据的请求都是相对简单的，一些复杂的处理主要包括URL路径参数、文件上传、数组或者列表类型数据等。另外，关于参数类型中存在日期类型属性(例如java.util.Date、

java.sql.Date、java.time.LocalDate、java.time.LocalDateTime)，解析的时候一般需要自定义实现的逻辑实现String->日期类型的转换。其实道理很简单，日期相关的类型对于每个国家、每个时区甚至每

个使用者来说认知都不一定相同。在演示一些例子主要用到下面的模特类：

@Data

public class User {

private String name;

private Integer age;

private List<Contact> contacts;

}

@Data

public class Contact {

private String name;

private String phone;

}

表单参数表单参数

非对象类型单个参数接收：

这种是最常用的表单参数提交，ContentType指定为application/x-www-form-urlencoded，也就是会进行URL编码。

对应的控制器如下：

@PostMapping(value = "/post")

public String post(@RequestParam(name = "name") String name,

@RequestParam(name = "age") Integer age) {

String content = String.format("name = %s,age = %d", name, age);

log.info(content);

return content;

}

说实话，如果有毅力的话，所有的复杂参数的提交最终都可以转化为多个单参数接收，不过这样做会产生十分多冗余的代码，而且可维护性比较低。这种情况下，用到的参数处理器是

RequestParamMapMethodArgumentResolver。

对象类型参数接收：对象类型参数接收：

我们接着写一个接口用于提交用户信息，用到的是上面提到的模特类，主要包括用户姓名、年龄和联系人信息列表，这个时候，我们目标的控制器最终编码如下：

@PostMapping(value = "/user")

public User saveUser(User user) {

log.info(user.toString());

return user;

}

我们还是指定ContentType为application/x-www-form-urlencoded，接着我们需要构造请求参数：

因为没有使用注解，最终的参数处理器为ServletModelAttributeMethodProcessor，主要是把HttpServletRequest中的表单参数封装到MutablePropertyValues实例中，再通过参数类型实例化(通过构造反

射创建User实例)，反射匹配属性进行值的填充。另外，请求复杂参数里面的列表属性请求参数看起来比较奇葩，实际上和在.properties文件中添加最终映射到Map类型的参数的写法是一致的。那么，能

不能把整个请求参数塞在一个字段中提交呢？

下载后可阅读完整内容，剩余7页未读，立即下载

weixin_38675232

粉丝: 3
资源: 970

Spring MVC参数接收详解：RequestParam、RequestBody与PathVariable

Spring Mvc中传递参数方法之url/requestMapping详解

Spring MVC请求参数与响应结果全局加密和解密详解

Spring MVC实战系列教程（2）--常用请求参数接收方式

Spring MVC常用客户端参数接收方式详解

SPRING MVC 的请求参数获取的几种方法

Spring MVC常用参数的使用

Spring MVC--3.请求参数

基于Spring MVC接收并处理HTTP请求

Spring MVC 请求参数与头限制详解

Spring MVC教程：请求参数与头限制详解

最新资源