关于SpringMvc中的@RequestBody和@RequestParam到底有什么用

傷城~ 2022-02-27 08:58 241阅读 0赞

# 缘起 #

在此之前，我一直搞不清楚`@RequestBody`和`@RequestParam`到底有什么作用，在很多时候我发现即使我在controller中设置`@RequestBody`和`@RequestParam`或者不设置这些，依然能够接收到请求参数，但在某些情况下他们又行不通。所以本文旨在深入讲解我们到底在什么情况下使用`@RequestBody`和`@RequestParam`，什么情况下不能使用`@RequestBody`和`@RequestParam`

# 关于http #

在说上面问题之前，你需要了解HTTP的基本信息。用户的浏览器访问网站以及我们通过ajax请求的时候都是HTTP请求。http分为请求头和请求体，在http请求头里面有个参数叫`Content-Type`  
`Content-Type`有以下三种取值情况

1.  `application/json`
2.  `application/x-www-form-urlencoded`
3.  `multipart/form-data`

关于这三种情况的详细解释可以参考我的[另一篇文章][Link 1]  
关于HTTP的其他参数的详细解释也可以参考我的[另一篇文章][Link 2]

如果你只是要了解spring mvc中的@RequestBody和@RequestParam到底怎么用，那么你无需详细看我们的那两篇文章，看本文就可以

# 关于Content-Type与@RequestBody的故事 #

content-type实际上是代表了你要给服务器发送的数据格式是什么

## application/json ##

比如的你的`content-type`为`application/json`。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70]  
那么你给后台的请求就必须是一个`JSON`字符串，注意是**字符串**，不是`JSON`对象，这一点在JS中要尤其注意，通过如下方法可以`JSON`对象和字符串互转。

//创建一个JSON对象
    let temp = { };
    temp.friendId = 111;
    temp.userId = 222;
    temp.type = 333;
    
    var tempStr = JSON.stringify(temp);			//JSON对象转字符串
    var tempJson = JSON.parse(tempStr);			//字符串转JSON对象

此时JAVA后台接收地方必须使用@RequestBody。否则你将无法接收数据。同时你可能需要在你的spring mvc中配置json解析器。但一般情况下你公司的大牛已经帮你配置好，你无需配置。你的controller类似如下这样

public Result updateAuditComment(@RequestBody GetChatLogVo getChatLogVo) { 
    }

@Data
    public class GetChatLogVo { 
        private String userId;
        private String friendId;
        private String type;
    }

## x-www-form-urlencoded ##

当不设置`content-type`时默认为`x-www-form-urlencoded`。  
这个适用于我们传输的数据格式为key=value&key=value，或者为Json对象的的情况

### 传输key=value数据 ###

$.ajax({ 
        url:'http://xxxx.xxx.xx.xx:xx/xxxx?userId = 张三 & friendId = 22 & type = 1',
        method:'POST',
        dataType:'json',
        success:function(res){ 
            console.log(res)
            if (res.code == 0) { 
                console.log(res.data)
            }
        }
    });

而这种情况你的方法的接收地方就不能使用`@RequestBody`。因为这个注解的作用是把得到的报文转换成`json`.而你发送的并非`json`格式。所有不能使用这个注解，否则可能报错`Content type 'application/x-www-form-urlencoded;charset=UTF-8' not supported`。你的`controller`类似如下这样

public Result updateAuditComment(GetChatLogVo getChatLogVo) { 
    }

你也可以不通过JavaBean接收，那么你可以在你的controller中定义你需要的参数，你可以使用@RequestParam,也可以不使用，例如对于如上请求你可以这么写你的controlle

public Result updateAuditComment(String userId,String friendId,String type) { 
    }

也可以这么写

public Result updateAuditComment(@RequestParam String userId,@RequestParam String friendId,@RequestParam String type) { 
    }

### 传输JSON对象 ###

$.ajax({ 
       type: "POST",
       url: "http://xxxx.xxx.xx.xx:xx/xxxx",
       contentType: "application/x-www-form-urlencoded", 
       dataType: "json", //表示返回值类型，不必须
       data: { friendId: "1110832847868485634", userId: "1", type: "friend"},
       success: function (jsonResult) { 
           alert(jsonResult);
       }
    });

后台

public Result updateAuditComment(String userId,String friendId,String type) { 
    }

# 关于@RequestParam作用 #

通过上诉可以看出实际上@RequestParam并不会影响到参数的接收，它存在的意义仅仅是你可以通过它来设置默认值，设置别名，设置是否必须。关于@RequestParam加与不加的区别可以参考[这篇文章][Link 3]

# 说说ajax中提交json对象和提交json字符串有什么区别 #

提交json对象默认采用`x-www-form-urlencoded`方式提交，即使你设置了`content-type`为`application/json`.  
所以如果你后台是用javaBean接收的，你最好采用`JSON.stringify(sendData)`把json对象转成json字符串然后提交，类似如下

$.ajax({ 
        url:'http://xxxx.xxx.xx.xx:xx/xxxx',
        method:'POST',
        data: JSON.stringify(sendData),
        contentType:'application/json;charset=UTF-8',
        dataType:'json',
        success:function(res){ 
            console.log(res)
            if (res.code == 0) { 
                console.log(res.data)
            }
        }
    });

[Link 1]: https://blog.csdn.net/qq32933432/article/details/80817250
[Link 2]: https://blog.csdn.net/qq32933432/article/details/52203618
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70]: /images/20220227/76cafdfe1b204aedab83b5bc69d5cd0e.png
[Link 3]: https://blog.csdn.net/a447332241/article/details/76714148