这篇文章主要介绍“spring mvc中@RequestBody注解的作用是什么”，在日常操作中，相信很多人在spring mvc中@RequestBody注解的作用是什么问题上存在疑惑，小编查阅了各式资料，整理出简单好用的操作方法，希望对大家解答”spring mvc中@RequestBody注解的作用是什么”的疑惑有所帮助！接下来，请跟着小编一起来学习吧！
@RequestBody的作用
@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)，所以只能发送POST请求。
GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST方式进行提交。
在后端的同一个接收方法里，@RequestBody与@RequestParam()可以同时使用，@RequestBody最多只能有一个，而@RequestParam()可以有多个。
注：一个请求，只有一个RequestBody；一个请求，可以有多个RequestParam。
jQuery中，$.ajax()默认发送的参数类型及编码为：application/x-www-form-urlcoded，而@RequestBody处理的参数类型及编码为：aplication/json或者是application/xml，通过contentType属性来指定
在传递之前，对JSON对象要使用JSON.stringify()，JSON.stringify() 方法将一个 JavaScript 值(对象或者数组)转换为一个 JSON 字符串
后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即:@RequestBody后面的类)时，会根据json字符串中的key来匹配对应实体类的属性，如果匹配一致且json中的该key对应的值符合(或可转换为)实体类的对应属性的类型要求时，会调用实体类的setter方法将值赋给该属性。
注：当同时使用@RequestParam（）和@RequestBody时，@RequestParam（）指定的参数可以是普通元素、数组、集合、对象等等
(即：当，@RequestBody 与@RequestParam()可以同时使用时，原SpringMVC接收参数的机制不变，只不过RequestBody 接收的是请求体里面的数据；而RequestParam接收的是key-value里面的参数，所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)
实现案例
1. jsp页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
<script src="${pageContext.request.contextPath}/js/jquery.min.js"></script>
<script>
var userList=new Array();
userList.push({userName:"beijing",age:34});
userList.push({userName:"shanghai",age:89});
$.ajax({
type:"post",
url:"${pageContext.request.contextPath}/bike7",
data:JSON.stringify(userList),
contentType:"application/json;charset=utf-8",
success:function(result){
alert(result);
}
})
</script>
</head>
<body>
</body>
</html>
2. controller
/**
* @author liujianfu
* @description controller中业务方法的集合参数获取，要将集合参数封装到一个pojo中才可以
* 参数属性名与请求参数名称一致，参数值会自动映射匹配
* @date 2021/1/10 22:14
* @param
* @return
*/
@RequestMapping("/bike6")
public String bike6(){
System.out.println("controller6:");
return "ajax";
}
/**
* @author liujianfu
* @description controller中业务方法的集合参数获取，要将集合参数封装到一个pojo中才可以
* 参数属性名与请求参数名称一致，参数值会自动映射匹配
* @date 2021/1/10 22:14
* @param
* @return
*/
@RequestMapping("/bike7")
@ResponseBody
public String bike7(@RequestBody List<User> userList){
for(User u:userList){
System.out.println("user:"+u.getUserName());
}
return "ok";
}
3. spring-mvc 配置文件
4. 页面访问
@RequestBody原理
通过Http传递参数一般有两种方式，一种是通过url解析参数，一种是通过body来解决，那么我们本次说的RequestBody就是去解析请求体然后映射到我们的参数，那它该如何解析body呢？这就是本篇博客诞生的目的。
这个其实是SpringMVC中做的一个处理机制，在整个SpringMVC的处理流程中，会通过HandlerMethod来代理每个Map后的controller和method，在通过反射invoke method的过程中，会解析request来获得arguments，而@RequestBody就是在解析参数的这个过程中起作用的
1. 执行流程
在InvocableHandlerMethod#getMethodArgumentValues中，它会遍历当前HandlerMethod的参数，对于每一个参数，它都会通过HandlerMethodArgumentResolverComposite#supportsParameter来判断是否可以被解析器解析，如果可以被解析，则通过HandlerMethodArgumentResolverComposite#resolveArguement进行解析
对于@RequestBody来说，它对应的解析器是RequestResponseBodyMethodProcessor，那么，我们就深入到它的源码中来一探究竟:
public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor {
// 是否可以解析当前参数
@Override
public boolean supportsParameter(MethodParameter parameter) {
return parameter.hasParameterAnnotation(RequestBody.class);
}
// 是否可以解析当前返回值
@Override
public boolean supportsReturnType(MethodParameter returnType) {
return (AnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(), ResponseBody.class) ||
returnType.hasMethodAnnotation(ResponseBody.class));
}
@Override
public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
parameter = parameter.nestedIfOptional();
// 解析handlerMethod中的参数
Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
// 获取变量名
String name = Conventions.getVariableNameForParameter(parameter);
if (binderFactory != null) {
WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);
if (arg != null) {
// 通过binder校验@Validated注解的字段
validateIfApplicable(binder, parameter);
if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());
}
}
if (mavContainer != null) {
mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
}
}
// 如果方法是Optional参数，则代理
return adaptArgumentIfNecessary(arg, parameter);
}
@Override
protected <T> Object readWithMessageConverters(NativeWebRequest webRequest, MethodParameter parameter,
Type paramType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {
HttpServletRequest servletRequest = webRequest.getNativeRequest(HttpServletRequest.class);
Assert.state(servletRequest != null, "No HttpServletRequest");
ServletServerHttpRequest inputMessage = new ServletServerHttpRequest(servletRequest);
// 解析http请求中的body并映射到对应的parameter上
Object arg = readWithMessageConverters(inputMessage, parameter, paramType);
if (arg == null && checkRequired(parameter)) {
throw new HttpMessageNotReadableException("Required request body is missing: " +
parameter.getExecutable().toGenericString());
}
return arg;
}
protected boolean checkRequired(MethodParameter parameter) {
RequestBody requestBody = parameter.getParameterAnnotation(RequestBody.class);
return (requestBody != null && requestBody.required() && !parameter.isOptional());
}
}
2. 注册流程
那么RequestResponseBodyMethodProcessor是如何被注册到resolver中呢？主要是在RequestMappingHandlerAdapter中：
-
RequestMappingHandlerAdapter实现了HandlerAdapter这个接口，这个接口是MVC框架的SPI，DispatcherServlet通过此接口访问所有已安装的处理程序。
-
HandlerAdapter主要是路由之后方法的适配器，DispatcherServlet在路由之后通过HandlerAdapter来执行真实的操作（handlerAdapter是通过HandlerMethod来执行的）
对于RequestResponseBodyMethodProcessor来说，它实现了InitializingBean，在bean初始化之后会添加参数处理器和返回值处理器，对于参数处理器来说，内容如下：
从图中我们可以看到，RequestMappingHandlerAdapter在初始化的时候会把系统给定的，自定义的参数解析器加载到内存中。
加入说，我们要自定义一个参数解析器，系统会在什么时候加载进入内存呢？
我们发现RequestMappingHandlerAdapter#setCustomArgumentResolvers这个方法就是要去设置自定义参数解析器的，那么我们只需要找到它的调用方即可。
我们只需要实现WebMvcConfigurer即可（这点关系到Spring的自动装配，暂时没有看到，先鸽一下）
3. 设计优点
设计模式
采用策略模式＋工厂模式 + 组合模式：
对于HandlerMethod的参数和返回值处理来说，对应着不同的处理方式，即对应着不同的策略，所以此处用的策略模式来处理的。至于HandlerMethodArgumentResolverComposite它则对应着策略工厂，同时，因为这个类实现了HandlerMethodArgumentResolver，所以它也是组合模式的变形，具体的策略类是HandlerMethodArgumentResolver
类图如下：
缓存处理
在参数解析工厂中，刚开始的参数解析器是在刚启动时注册到list中，但是如果之后被使用的时候就会存放到map中，可以直接获得(key是MethodParam)，提高路由效率
附：常见的MVC参数注解
对于url解析参数来说，有两个注解，分别是pathVariable（指一种占位符）和requestParam,对于body来说，有requestBody。不加注解，也可以直接把url转为对应参数或者实体类
1.@PathVariable: www.666.com/web/6
@GetMapping("/web/{node}")
public ReturnType listEmployeeInNode(@PathVariable String node) throws BusinessException {
}
2.@ReqeustParam: www.666.com/web?user=1
@GetMapping("/web")
public ReturnType listEmployeeInNode(@RequestParam("user") String node) throws BusinessException {
}
3.@RequestBody: www.666.com/web body中是json
@GetMapping("/web")
public ReturnType listEmployeeInNode(@RequestBody UserDTO userDto) throws BusinessException {
}
4.无注解：www.666.com/web?userId=1&pwd=2
@PostMapping("/web")
public ReturnType listEmployeeInNode(UserDTO userDto) throws BusinessException {
}
到此，关于“spring mvc中@RequestBody注解的作用是什么”的学习就结束了，希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习，快去试试吧！若想继续学习更多相关知识，请继续关注本站网站，小编会继续努力为大家带来更多实用的文章！
