SpringMVC注解 @RequestBody使用注意事项

已于 2023-04-09 21:29:25 修改
阅读量2.3k 收藏 2
点赞数 1
CC 4.0 BY-SA版权
分类专栏： SpringMVC 文章标签： SpringMVC注解@RequestBody
于 2020-01-20 11:39:41 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_40436854/article/details/104049751
本文详细解释了SpringMVC中@RequestBody注解的作用和使用注意事项，包括其如何将请求体中的JSON/XML数据转换为JavaBean对象，适用的HTTP方法，以及前后端数据匹配的要求。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1. @RequestBody作用：

@RequestBody 用在方法参数上面，用来将请求参数绑定到request body中，通过HttpMessageConverter封装为具体的JavaBean。通俗点讲就是你在一个参数上加上该注解，spring就会将request body中的json/xml对象解析成该参数类型的Javabean对象。

2. 使用@RequestBody注意点：

（1）@RequestBody一般适用于POST请求，GET请求由于没有HttpEntity对象，所以不会使用@RequestBody注解。

（2）POST请求中，通过HttpEntity传递的参数，必须要在请求头中声明数据的类型Content-Type，SpringMVC通过使用HandlerAdapter 配置的HttpMessageConverters来解析HttpEntity中的数据，然后绑定到相应的bean上。

（3） 使用@RequestBody 前后端参数要匹配，个数不能少。字段名字要一致。

（4） 前端JSON数据和后端JSON数据 首字母不要大写，首字母大写映射不上，以驼峰格式命名。

@RequestBody与@ResponseBody：Web开发的双子星
xycxycooo的博客
08-16 1169
和注解在Spring MVC中扮演着至关重要的角色，它们使得处理HTTP请求和响应变得更加简单和高效。通过合理利用这两个注解，你可以构建出结构清晰、易于维护的RESTful API。掌握和的原理和使用方法，将使你在面对复杂Web开发任务时更加从容不迫。希望本文能为你提供有价值的参考，激发你对Spring MVC的兴趣和热情。让我们一起探索Web开发的无限可能，构建更高效、更优秀的应用！
@RequestBody和@ResponseBody注解的作用是什么
北执南念的博客
06-12 968
@RequestBody和@ResponseBody注解的作用是什么
springmvc 的@RequestBody的使用
weixin_30947043的博客
06-21 170
@RequestBody 作用： i) 该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上； ii) 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。 使用时机： A) GET、POST方...
springMVC的@RequestBody注解使用
weixin_33743703的博客
01-30 201
如果没有特殊的设置，无论用什么样的http请求方法，只要携带body参数，用@RequestBody都是可以获取到body的内容的 参数是json字符串格式，使用方式有两种 @RequestBody只有一个属性，required默认等于true，如果不设置required属性，就默认必须传body体，否则会报400错误，如果注解了对象（注解字符串变量不会），设置了body体，但是没有设置...
@RequestBody的注意点
benyuanone的专栏
01-31 1246
今天从某一硬件参数中接收http请求，如上图，看图感觉参数是body里的东西，前台用的是SpringMvc，搞了两小时拿不到参数{"sn","terminalno"},用了@RequestBody和@RequestParam(虽然觉得这个不靠谱)，结果确实还是拿不到参数。然后只能分析request去了。查看了header,param(空的一匹),Content等，发现图中的Content-Leng
@RequestBody注意事项
xiangchaoming的博客
06-16 480
这个注解用来修饰变量，不能用于GET请求，一般用于POST请求来解释收JSON格式的数据 @RequestBody(required = false)： require表示参数可有可无
@RequestBody在实际运用中需要注意的地方
sinat_39084029的博客
04-06 1088
@RequestBody的介绍： @RequestBody主要用来接收前端传递给后端的json字符串中的数据的（前端传值的json是字符串，不是json对象） 在使用@RequestBody接收数据时，GET方式无请求体，前端不能使用GET方式提交数据，需要使用POST方式进行提交。 在后端的接受方法中，@RequestBody最多只能有一个，而@RequestParam()可以有多个，他们可以同...
快速解决SpringMVC @RequestBody 用map接收请求参数的问题
08-27
快速解决SpringMVC @...使用 @RequestBody 注解可以快速解决 SpringMVC 中的请求参数接收问题，但是需要注意一些细节，如使用 @RequestParam 注解，使用 getParameterMap() 方法，使用 JSON.stringify() 方法等。
在 Spring Boot 中，@RequestBody 注解​​无法直接处理 application/x-www-form-urlencoded 格式的表单数据
weixin_43833540的博客
06-12 988
1.接收方式适用场景：传输简单键值对（如表单提交，无文件上传）。接收方式（单个参数）) {（动态参数）（绑定实体类）注意事项参数编码：确保请求与响应编码一致（通常为 UTF-8）。PUT 请求支持：需添加过滤器（Tomcat 默认不解析 PUT 表单数据）。参数重复只保留最后一个值，需用获取全部值。2.接收方式适用场景：传输文件或混合文本与二进制数据（如表单上传）。接收方式（单个文件）) {实体类 +（混合数据）@Data多文件上传Element UI 多文件上传。
ResponseEntity<String> erpCallBack(@RequestBody HttpEntity<String> requestBody); 这样的写法有问题吗
06-25
现在用户提出了一个具体的方法定义：`RequestEntity<String>erpCallBack(@RequestBodyHttpEntity<String>requestBody)`，并询问其正确性及注意事项。首先，我们需要明确：在FeignClient的接口方法中，直接使用`@...
Spring mvc POST/GET请求中RequestBody和RequestParam的应用场景
lhyxcxy的博客
01-27 1589
POST请求时 @RequestBody --&gt; JSON字符串部分 @RequestParam --&gt; 请求参数部分 application/json格局图 图一.png form-data、x-www-form-urlencoded格局图 图二.png   1、从content-type方面总结： ① form-data、x-www-form-urlencode...
@RequestBody的详解和使用
mh17680313750的博客
10-17 2045
RequestBody的详解和使用提示：建议一定要看后面的@RequestBody的核心逻辑源码以及六个重要结论！本文前半部分的内容都是一些基-本知识常识，可选择性跳过。声明：本文是基于SpringBoot，进行的演示说明。基础知识介绍：-@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)；而最常用的使用请求体传参的无疑是POST请求了，所以使用@RequestBody接收数据时，一般都用POST方式进行提交。
SpringMVC @RequestBody使用
超威半导体
11-14 2万+
Spring mvc是一个非常轻量的mvc框架，注解可以大大减少配置，让请求的拦截变得比较简单。这次记录下@RequestBody 注解接收参数尤其是数组参数的用法。 关于容器的配置不再多说，这里写出spring-servlet.xml的sechme:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt; &lt;beans xmlns=&quot;http://ww
SpringBoot@RequestBody无法获取页面传递的参数，属性名命名规范问题
lee_prometheus的博客
08-01 2396
最近在springboot项目中，发现controller中定义了User对象，其中有一个属性uId，前台页面怎么传递数值，后台也无法接收到，解决方法如下： package com.user.bean; import lombok.Data; @Data public class BoilerBean { private String userName; @JsonProp...
GET请求可以使用@RequestBody来接收参数吗
热门推荐
qq_28411869的博客
07-30 6万+
答案是可以的。 为什么会这样呢？感觉要怀疑人生了，GET与@RequestParam，POST与@RequestBody才是我们映像中的绝配。有关于GET与POST，@RequestParam与@RequestBody的区别可以参照这篇博文 其实在一般的情况下，GET请求是不可以用@RequestBody来接收参数的。一般情况指的是请求由浏览器或者类似于POSTMAN这样的测试工具发出，我们都...
SpringMVC-@RequestBody注解
好记性不如烂笔头
02-14 1046
处理HttpEntity传递过来的数据，一般用来将JSON格式的字符串直接转为对象 在GET请求中，因为没有HttpEntity，不能使用@RequestBody。 在POST请求，可以使用@RequestBody和@RequestParam，如果使用@RequestBody，对于参数转化的配置必须统一。 @RequestBody 将 HTTP 请求正文插入方法中，使用适合的 HttpMessa...
SpringMVC @RequestBody 参数映射不上，@RequestBody 报错
liuzhenteng521的博客
09-10 2万+
最近代码遇见了一个springmvc中的小问题，算是很基础的东西，同事问我后我有有些迷惑上网找了一些资料后弄清楚了。特此记录一下springmvc注解@requestbody来传递参数映射一个对象。 言归正传问题是这样的： 使用postMan 发送httppost 请求： 最后报错。   报错原因： 在使用postMan发送post请求的时候没有选择如下:     也就是...
服务端动态修改springmvc请求参数，处理GET,POST @RequestBody参数的请求
bobozai86的博客
12-15 969
背景:每一次请求都用记录请求的用户和IP等业务信息，在rest方法中写代码及其冗余，特使用动态处理的方式。 楼主赋值的是：ip和user 处理： 使用Filter和HttpServletRequestWrapper的方法进行动态赋值 1.创建参数过滤器 package com.bxm.sentinel.web.resolver; import org.springframework.beans.factory.annotation.Autowired; import org.springfr
SpringMVC的@RequestParam和@RequestBody
brantykl的博客
02-18 830
1.在使用SpringMVC时通常需要接收参数.而接收参数通常有多种情况 　1)拼接在url上 　2)存在于请求体中(存在于请求头中暂不说明) 　3)参数的数据格式 　4)接收多个参数 　5)接收数组参数 　6)接收单个参数 　7)接收Bean 2.在使用vue的异步请求发送参数,参数类型默认application/json 　1)单个参数,存在于路径中,可直接使用@RequestParam获取 　2)单个参数,存在于请求体中. { param: "参数" } //@RequestBody 参数使用Ma
springboot怎么支持用@RequestBody来接收application/x-www-form-urlencoded类型参数
最新发布
07-03
<think>我们正在处理一个关于Spring Boot中@RequestBody接收application/x-www-form-urlencoded类型参数的问题。根据引用[1]，我们知道默认情况下，当使用@RequestBody注解时，RequestResponseBodyMethodProcessor解析器要求Content-Type必须是application/json，否则会报Unsupported MediaType错误。用户的需求是：如何配置才能使@RequestBody能够接收application/x-www-form-urlencoded类型的数据。解决方案思路：1.自定义一个参数解析器，使其能够处理Content-Type为application/x-www-form-urlencoded的请求，并将请求体解析为对象。2.由于Spring Boot默认不支持使用@RequestBody接收application/x-www-form-urlencoded数据，我们需要覆盖默认行为。步骤：我们可以通过实现HandlerMethodArgumentResolver接口来创建自定义参数解析器，并在该解析器中处理application/x-www-form-urlencoded类型的数据，将其转换为目标对象。具体实现：1.创建一个自定义解析器，例如FormUrlEncodedArgumentResolver。2.在解析器中，检查请求的Content-Type是否为application/x-www-form-urlencoded，并且参数上是否有@RequestBody注解（或者我们也可以自定义一个注解，但这里为了保持使用习惯，我们可以继续使用@RequestBody，但需要调整解析器条件）。3.读取请求体，将application/x-www-form-urlencoded格式的字符串解析为键值对，然后通过反射将值设置到目标对象中。但是注意：SpringMVC默认已经有一个解析器可以处理application/x-www-form-urlencoded，即ServletModelAttributeMethodProcessor，但它要求使用@ModelAttribute（或不使用任何注解）。而@RequestBody对应的解析器RequestResponseBodyMethodProcessor只支持可以转换的媒体类型（如application/json）。因此，我们也可以考虑另一种方法：不使用@RequestBody，而是使用@RequestParam或@ModelAttribute。但是用户明确要求使用@RequestBody。所以，我们选择自定义解析器，并替换掉默认的RequestResponseBodyMethodProcessor对于application/x-www-form-urlencoded的处理。然而，直接替换可能比较复杂，我们可以通过添加一个自定义解析器，并设置较高的优先级，使其在默认解析器之前执行。实现步骤：1.创建自定义参数解析器类，实现HandlerMethodArgumentResolver接口。2.在supportsParameter方法中，判断参数是否被@RequestBody注解，并且请求的Content-Type为application/x-www-form-urlencoded。3.在resolveArgument方法中，解析请求体，并绑定到目标对象。4.注册这个自定义解析器，并设置其顺序在RequestResponseBodyMethodProcessor之前。但是，请注意：SpringMVC的解析器是有顺序的，我们可以通过实现Ordered接口来设置优先级。具体代码实现：步骤1：创建自定义解析器```javaimport org.springframework.core.MethodParameter; importorg.springframework.core.Ordered;import org.springframework.http.MediaType; importorg.springframework.util.StringUtils;import org.springframework.web.bind.support.WebDataBinderFactory;import org.springframework.web.context.request.NativeWebRequest; importorg.springframework.web.method.support.HandlerMethodArgumentResolver; importorg.springframework.web.method.support.ModelAndViewContainer;import javax.servlet.http.HttpServletRequest; importjava.io.BufferedReader;import java.util.HashMap; importjava.util.Map;public classFormUrlEncodedArgumentResolverimplements HandlerMethodArgumentResolver,Ordered {@Overridepublicboolean supportsParameter(MethodParameterparameter){//检查参数是否有@RequestBody注解，并且请求的Content-Type是application/x-www-form-urlencodedbooleanhasRequestBody= parameter.hasParameterAnnotation(RequestBody.class);HttpServletRequestrequest =(HttpServletRequest)((NativeWebRequest) parameter.getParameter()).getNativeRequest();StringcontentType =request.getContentType();return hasRequestBody &&contentType !=null &&contentType.equals(MediaType.APPLICATION_FORM_URLENCODED_VALUE);}@Overridepublic ObjectresolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,NativeWebRequest webRequest,WebDataBinderFactory binderFactory)throws Exception{HttpServletRequestrequest =webRequest.getNativeRequest(HttpServletRequest.class);//读取请求体StringBuilderstringBuilder =new StringBuilder();try (BufferedReaderreader =request.getReader()){String line;while ((line =reader.readLine()) !=null){stringBuilder.append(line);}}String body= stringBuilder.toString();//解析application/x-www-form-urlencoded格式的字符串Map<String, String> formData =parseFormData(body);//创建目标对象实例Objecttarget =parameter.getParameterType().newInstance();//使用WebDataBinder来绑定数据WebDataBinder binder= binderFactory.createBinder(webRequest,target,parameter.getParameterName());binder.bind(newMutablePropertyValues(formData));return binder.getTarget();}private Map<String,String>parseFormData(Stringbody){Map<String, String> result= newHashMap<>();if(StringUtils.hasText(body)) {String[] pairs= body.split("&");for(Stringpair :pairs){int idx= pair.indexOf('=');if(idx!=-1) {Stringkey =pair.substring(0, idx);String value= pair.substring(idx+1);//URL解码key= URLDecoder.decode(key,StandardCharsets.UTF_8);value= URLDecoder.decode(value,StandardCharsets.UTF_8);result.put(key, value);}}}return result;}@Overridepublic intgetOrder() {//设置一个高优先级（低数值），使其在默认解析器之前执行returnOrdered.HIGHEST_PRECEDENCE;} }```步骤2：注册自定义解析器我们需要在配置类中注册这个解析器。```javaimportorg.springframework.context.annotation.Configuration;import org.springframework.web.method.support.HandlerMethodArgumentResolver;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; importjava.util.List;@Configurationpublicclass WebConfig implementsWebMvcConfigurer {@Overridepublicvoid addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers){resolvers.add(newFormUrlEncodedArgumentResolver());} }```注意：这样配置后，当请求的Content-Type为application/x-www-form-urlencoded且参数有@RequestBody注解时，就会使用我们的解析器。但是，这种方法需要自己处理数据绑定，并且可能不够完善（例如嵌套对象、数组等）。对于复杂绑定，可以考虑使用Spring的WebDataBinder，但需要确保参数类型有相应的setter方法或字段是public的。另外，还有一种更简单的方法：使用一个转换器，将application/x-www-form-urlencoded的请求体转换为一个MultiValueMap，然后在方法参数中使用@RequestBodyMultiValueMap<String,String>formData。但是这样就不是直接绑定到对象了。如果用户希望直接绑定到对象，那么上面的自定义解析器是一种方式。但是，我们也要考虑到，SpringBoot中默认的FormHttpMessageConverter可以处理MultiValueMap，但它不支持任意对象。因此，我们可以尝试另一种方式：配置HttpMessageConverters，添加一个能够将application/x-www-form-urlencoded转换为对象的转换器。但是Spring MVC并没有提供这样的转换器。因此，自定义参数解析器可能是比较直接的方法。注意事项：1.上面的自定义解析器没有处理复杂对象（如嵌套对象、数组、集合等）的能力，对于简单对象（属性为基本类型或字符串）是有效的。2.如果需要处理复杂对象，可能需要更复杂的解析逻辑，或者考虑使用现有的库（如org.springframework.util.MultiValueMap）来解析，然后通过反射设置属性。替代方案：如果不想自定义解析器，也可以使用@RequestParam逐个接收参数，或者使用@ModelAttribute，但这样就不能使用@RequestBody了。总结：自定义参数解析器是一种解决方案，但需要根据实际需求调整解析逻辑。如果对象结构简单，上述解析器可以工作；如果对象结构复杂，可能需要更高级的绑定逻辑。相关问题：1.如何在Spring Boot中接收application/x-www-form-urlencoded类型的请求？2.Spring Boot中@RequestBody和@ModelAttribute的区别是什么？3.如何扩展Spring MVC的参数解析器？4.除了自定义解析器，还有其他方法能让@RequestBody支持application/x-www-form-urlencoded吗？</think>### Spring Boot @RequestBody 接收 application/x-www-form-urlencoded 数据配置方法 在 Spring Boot 中，默认情况下 `@RequestBody` 无法直接接收 `application/x-www-form-urlencoded` 类型的数据（会返回 `415 Unsupported Media Type` 错误）。以下是两种解决方案： --- #### ✅ 方案一：自定义参数解析器（推荐） 通过实现 `HandlerMethodArgumentResolver` 接口覆盖默认行为： ```java import org.springframework.core.MethodParameter; import org.springframework.web.bind.support.WebDataBinderFactory; import org.springframework.web.context.request.NativeWebRequest; import org.springframework.web.method.support.HandlerMethodArgumentResolver; import org.springframework.web.method.support.ModelAndViewContainer; import javax.servlet.http.HttpServletRequest; import java.util.Map; public class FormUrlEncodedArgumentResolver implements HandlerMethodArgumentResolver { @Override public boolean supportsParameter(MethodParameter parameter) { // 仅处理带@RequestBody注解的application/x-www-form-urlencoded请求 return parameter.hasParameterAnnotation(RequestBody.class) && isFormUrlEncoded(parameter.getNestedParameterType()); } @Override public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception { HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest(); // 获取表单数据并转换为Map Map<String, String[]> parameterMap = request.getParameterMap(); // 通过反射创建目标对象 Object target = parameter.getParameterType().getDeclaredConstructor().newInstance(); // 使用Spring数据绑定（需对象有setter方法） binderFactory.createBinder(webRequest, target, "target") .bind(new MutablePropertyValues(parameterMap)); return target; } private boolean isFormUrlEncoded(Class<?> targetClass) { // 这里可添加自定义逻辑判断目标类型 return !Map.class.isAssignableFrom(targetClass); } } ``` 注册解析器： ```java import org.springframework.context.annotation.Configuration; import org.springframework.web.method.support.HandlerMethodArgumentResolver; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import java.util.List; @Configuration public class WebConfig implements WebMvcConfigurer { @Override public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) { resolvers.add(new FormUrlEncodedArgumentResolver()); } } ``` 控制器使用： ```java @PostMapping("/submit") public ResponseEntity<String> handleForm(@RequestBody UserForm form) { // 直接接收绑定后的对象 System.out.println("Received: " + form.getUsername()); return ResponseEntity.ok("Success"); } ``` > **优势**：保持 `@RequestBody` 注解的语义一致性，无需修改现有代码逻辑[^1]。 --- #### ✅ 方案二：使用 `HttpServletRequest` 手动解析 适用于简单场景： ```java import org.springframework.util.MultiValueMap; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestParam; import javax.servlet.http.HttpServletRequest; @PostMapping(value = "/submit", consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE) public String handleForm(HttpServletRequest request) { MultiValueMap<String, String> params = ServletServerHttpRequest .convert(request) .getBody() .toMultiValueMap(); String username = params.getFirst("username"); String password = params.getFirst("password"); // ...处理数据 } ``` 或使用 `@RequestParam`： ```java @PostMapping("/login") public String login(@RequestParam String username, @RequestParam String password) { // 直接获取参数值 return "redirect:/dashboard"; } ``` > **适用场景**：参数较少时更简洁，但需手动映射字段[^2]。 --- #### 📌 关键注意事项 1. **Content-Type 验证**： 确保请求头包含 `Content-Type: application/x-www-form-urlencoded` 2. **数据绑定限制**： 方案一要求目标对象有无参构造函数和 setter 方法 3. **嵌套对象支持**： 复杂嵌套对象需扩展解析器的数据绑定逻辑（如使用 `BeanWrapper`） 4. **文件上传**： `application/x-www-form-urlencoded` 不支持文件上传，需改用 `multipart/form-data` > **性能提示**：自定义解析器方案在首次请求时会有反射开销，但后续可通过缓存优化。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值