首页 > 其他分享> 文章详细

Spring 注解面面通之 @RequestBody

2020-12-05 18:33:17 阅读：311 来源： 互联网

标签：requestBodyMap Spring required value RequestBody 面面通 org import

@RequestBody用于将完整请求正文映射到控制器处理方法的参数中，请求正文通过HttpMessageConverter进行转换。

注解解析

① required:

请求正文是否必须有值，默认值为true。

required为true时，如果请求正文没有值，则会抛出异常。

required为false时，如果请求正文没有值，则会返回null。

注解示例

1) 建Controller，用来演示@RequestBody使用方法。

package com.arhorchin.securitit.webannotations;

import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

import com.alibaba.fastjson.JSON;

/**
 * @author Securitit.
 * @note 演示@RequestBody使用方法.
 */
@Controller
@RequestMapping("/WebAnnotations")
public class RequestBodyController {

    /**
     * logger.
     */
    private Logger logger = LoggerFactory.getLogger(RequestBodyController.class);

    /**
     * 从请求报文以Map解析方法参数.
     */
    @ResponseBody
    @RequestMapping(
            value = "/RequestBodyMap.do",
            method = RequestMethod.POST)
    public String requestParamMap(@RequestBody Map<String, String> requestBodyMap) throws Exception {
        logger.info("Current value of RequestBody is " + JSON.toJSONString(requestBodyMap));
        return "Current value of RequestBody is " + JSON.toJSONString(requestBodyMap);
    }

    /**
     * 从请求报文以Map解析方法参数.
     */
    @ResponseBody
    @RequestMapping(
            value = "/RequestBodyMapRequiredTrue.do",
            method = RequestMethod.POST)
    public String requestParamMapRequiredTrue(@RequestBody(
            required = true) Map<String, String> requestBodyMap) throws Exception {
        logger.info("Current value of RequestBody [required is true] is " + JSON.toJSONString(requestBodyMap));
        return "Current value of RequestBody [required is true] is " + JSON.toJSONString(requestBodyMap);
    }

    /**
     * 从请求报文以Map解析方法参数.
     */
    @ResponseBody
    @RequestMapping(
            value = "/RequestBodyMapRequiredFalse.do",
            method = RequestMethod.POST)
    public String requestParamMapRequiredFalse(@RequestBody(
            required = false) Map<String, String> requestBodyMap) throws Exception {
        logger.info("Current value of RequestBody [required is false] is " + JSON.toJSONString(requestBodyMap));
        return "Current value of RequestBody [required is false] is " + JSON.toJSONString(requestBodyMap);
    }

}

2) 使用《Spring 注解面面通之 Http测试工具》提供的Http测试工具进行测试。

① 测试http://localhost:9199/spring-annotations/WebAnnotations/RequestBodyMap.do。

在这里插入图片描述

② 测试http://localhost:9199/spring-annotations/WebAnnotations/RequestBodyMapRequiredTrue.do。

在这里插入图片描述

可以看到请求返回400和Bad Request，查看后端控制台可以看到：

2020-12-05 13:46:10 WARN [org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver] Failed to read HTTP message: org.springframework.http.converter.HttpMessageNotReadableException: Required request body is missing: public java.lang.String com.arhorchin.securitit.webannotations.RequestBodyController.requestParamMapRequiredTrue(java.util.Map<java.lang.String, java.lang.String>) throws java.lang.Exception

③ 测试http://localhost:9199/spring-annotations/WebAnnotations/RequestBodyMapRequiredFalse.do。

在这里插入图片描述

可以看到虽然和②中请求一直，但确正常返回数据，原因在于后端设置了@RequestBody(required = false)所致。

总结

@RequestBody注解在当下的应用开发中使用非常频繁，掌握它可以让我们开发更加顺畅。

若文中存在错误和不足，欢迎指正！

标签：requestBodyMap,Spring,required,value,RequestBody,面面通,org,import
来源： https://blog.csdn.net/securitit/article/details/110705279

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

Spring 注解面面通 之 @RequestBody

Spring 注解面面通之 @RequestBody