spring mvc中@RequestBody注解的作用说明

2024-08-01 22:18:23

@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 {
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。

SpringMVC @RequestBody的使用解析

目录 SpringMVC @RequestBody的使用 @RequestBody使用的一些注意事项 SpringMVC @RequestBody的使用 Spring mvc是一个非常轻量的mvc框架,注解可以大大减少配置,让请求的拦截变得比较简单.这次记录下@RequestBody 注解接收参数尤其是数组参数的用法. 关于容器的配置不再多说,这里写出spring-servlet.xml的sechme: <?xml version="1.0" encoding="UTF
SpringMVC结构简介及常用注解汇总

MVC结构简介 Model(模型):数据模型,提供要展示的数据,因此包含数据和行为.现在一般分离为数据层Dao和服务层Service,提供了模型数据查询和模型数据的状态更新等功能. View(视图):负责进行模型的展示,一般指用户界面. Controller(控制器):接受用户请求,并委托模型进行处理(状态改变),处理完返回模型数据给视图,交由视图进行展示. SpringMVC简介 SpringMVC是SpringFramework的一部分,是Java实现MVC的轻量级Web框架. Spring
springmvc @RequestBody String类型参数的使用

目录 springmvc @RequestBody String类型参数 springmvc用Map接收请求参数分析第一种情况,什么也不设置,无参数传递第二种情况,加个参数试试 => .../testmap?test1=2342 第三种情况,给Map参数添加@RequestParam注解小结一下吧 springmvc @RequestBody String类型参数通过如下配置: <bean id="mappingJacksonHttpMessageConverter"
springMvc注解之@ResponseBody和@RequestBody详解

简介 springmvc对json的前后台传输做了很好封装,避免了重复编码的过程,下面来看看常用的@ResponseBody和@RequestBody注解添加依赖 springmvc对json的处理依赖jackson <dependency> <groupId>org.codehaus.jackson</groupId> <artifactId>jackson-core-asl</artifactId> <version>1.9.1
spring mvc中@RequestBody注解的作用说明

目录 @RequestBody的作用实现案例 1. jsp页面 2. controller 3. spring-mvc 配置文件 4. 页面访问 @RequestBody原理 1. 执行流程 2. 注册流程 3. 设计优点附:常见的MVC参数注解 @RequestBody的作用 @RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的),所以只能发送POST请求. GET方式无请求体,所以使用@RequestBody接收数据时,前端不能使用GET方式提交
详解在Spring MVC中使用注解的方式校验RequestParams

概述 Spring MVC支持Bean Validation,通过这个验证技术,可以通过注解方式,很方便的对输入参数进行验证,之前使用的校验方式,都是基于Bean对象的,但是在@RequestParam中,没有Bean对象,这样使得校验无法进行,可以通过使用@Validated注解,使得校验可以进行. 校验bean对象一般校验bean对象,为了可以自动的校验属性,可以通过两步解决: 一.声明对象 package com.github.yongzhizhan.draftbox.model; im
spring mvc中注解@ModelAttribute的妙用分享

前言本文主要给大家介绍了关于spring mvc注解@ModelAttribute妙用的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧. 在Spring mvc中,注解@ModelAttribute是一个非常常用的注解,其功能主要在两方面: 运用在参数上,会将客户端传递过来的参数按名称注入到指定对象中,并且会将这个对象自动加入ModelMap中,便于View层使用: 运用在方法上,会在每一个@RequestMapping标注的方法前执行,如果有返回值,则自动将该返回值
spring mvc中的@ModelAttribute注解示例介绍

前言本文介绍在spring mvc中非常重要的注解@ModelAttribute.这个注解可以用在方法参数上,或是方法声明上.这个注解的主要作用是绑定request或是form参数到模型对象.可以使用保存在request或session中的对象来组装模型对象.注意,被@ModelAttribute注解的方法会在controller方法(@RequestMapping注解的)之前执行.因为模型对象要先于controller方法之前创建. 请看下面的例子 ModelAttributeExample
浅谈Spring中@Import注解的作用和使用

@Import用来导入@Configuration注解的配置类.声明@Bean注解的bean方法.导入ImportSelector的实现类或导入ImportBeanDefinitionRegistrar的实现类. @Import注解的作用查看Import注解源码 /** * Indicates one or more {@link Configuration @Configuration} classes to import. * * <p>Provides functionality eq
Spring中@DependsOn注解的作用及实现原理解析

本文给大家讲解Spring中@DependsOn注解的作用及实现原理! 官方文档解释 Beans on which the current bean depends. Any beans specified are guaranteed to be created by the container before this bean. Used infrequently in cases where a bean does not explicitly depend on another thro
spring mvc4中相关注解的详细讲解教程

前言在开始本文之前要说明以下,首先我是一个初学springmvc,抱着去加深印象的目的去整理相关springmvc4的相关注解,同时也希望给需要相关查阅的读者带来帮助,好了,下面话就不多说了,一起来看看详细的介绍吧. 1.@Controller Controller控制器是通过服务接口定义的提供访问应用程序的一种行为,它解释用户的输入,将其转换成一个模型然后将试图呈献给用户.Spring MVC 使用 @Controller 定义控制器,它还允许自动检测定义在类路径下的组件并自动注册.如想自动
详解Http请求中Content-Type讲解以及在Spring MVC中的应用

详解Http请求中Content-Type讲解以及在Spring MVC中的应用引言: 在Http请求中,我们每天都在使用Content-type来指定不同格式的请求信息,但是却很少有人去全面了解content-type中允许的值有多少,这里将讲解Content-Type的可用值,以及在spring MVC中如何使用它们来映射请求信息. 1. Content-Type MediaType,即是Internet Media Type,互联网媒体类型:也叫做MIME类型,在Http协议消息头中,
spring mvc中的@PathVariable动态参数详解

目录 spring mvc @PathVariable动态参数 spring mvc是如何做到根据参数名动态绑定参数的? 反射获取参数名 -parameters参数 -g参数 ASM SpringMVC的处理方式总结 spring mvc @PathVariable动态参数 spring mvc中的@PathVariable是用来获得请求url中的动态参数的,十分方便 @Controller public class TestController { @RequestMapping(value
Spring Mvc中传递参数方法之url/requestMapping详解

前言相信大家在使用spring的项目中,前台传递参数到后台是经常遇到的事, 我们必须熟练掌握一些常用的参数传递方式和注解的使用,本文将给大家介绍关于Spring Mvc中传递参数方法之url/requestMapping的相关内容,分享出来供大家参考学习,话不多说,直接上正文. 方法如下 1. @requestMapping: 类级别和方法级别的注解, 指明前后台解析的路径. 有value属性(一个参数时默认)指定url路径解析,method属性指定提交方式(默认为get提交) @Reques