@RequestParam、@ModelAttribute、@RequestBody的区别

谁践踏了优雅 2021-09-07 06:00 437阅读 0赞

## 一、@RequestParam ##

@PostMapping("/getUserLogin") 
    public String getUserLogin(@RequestParam("username") String username,
    @RequestParam("password") String password) { 
        selectByCond(username,password);
    }

注：如果参数前写了@RequestParam(xxx)，那么前端必须有对应的xxx名字才行(不管其是否有值，当然可以通过设置该注解的required属性来调节是否必须传)，如果没有xxx名的话，那么请求会出错，报400。

注：如果参数前不写@RequestParam(xxx)的话，那么就前端可以有可以没有对应的xxx名字才行，如果有xxx名的话，那么就会自动匹配；没有的话，请求也能正确发送。

追注：这里与feign消费服务时不同；feign消费服务时，如果参数前什么也不写，那么会被默认是@RequestBody的。

当同时使用@RequestParam（）和@RequestBody时，@RequestParam（）指定的参数可以是普通元素、数组、集合、对象等等

## 二、@ModelAttribute ##

@PostMapping("/getUserLogin") 
    public String getUserLogin(@ModelAttribute UserLogin userLogin) { 
        String username = userLogin.getUsername;
        String password = userLogin.getPassword;
        selectByCond(username,password);
    }

1、@ModelAttribute可以注释在方法上，在用@RequestMapping注解的控制器方法被调用之前调用@ModelAttribute方法。

2、当作为方法的参数使用，指示的参数应该从模型中检索。如果不存在，它应该首先实例化，然后添加到模型中，一旦出现在模型中，参数字段应该从具有匹配名称的所有请求参数中填充。

## 三、@RequestParam和@ModelAttribute的区别 ##

1.  @ModelAttribute：绑定整个Java对象（如Employee）。支持多个请求参数
2.  @RequestParam：结合一个单一的请求参数（像的firstName）
3.  @RequestParam是最适合读出一小则params的。
4.  @ModelAttribute用于具有大量字段的表单。
5.  @ModelAttribute为您提供了额外的功能，如数据绑定，验证和形式预先填充。
6.  当同时使用@RequestParam（）和@RequestBody时，@RequestParam（）指定的参数可以是普通元素、数组、集合、对象等等

## 四、@RequestBody ##

### 1、@RequestBody简介 ###

@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)；

@RequestBody用于post请求，不能用于get请求。

注：一个请求，只有一个RequestBody；一个请求，可以有多个RequestParam。

注：当同时使用@RequestParam（）和@RequestBody时，@RequestParam（）指定的参数可以是普通元素、数组、集合、对象等等(即:当，@RequestBody 与@RequestParam()可以同时使用时，原SpringMVC接收参数的机制不变，只不过RequestBody 接收的是请求体里面的数据；而RequestParam接收的是key-value里面的参数，所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。

即：如果参数时放在请求体中，application/json传入后台的话，那么后台要用@RequestBody才能接收到；

如果不是放在请求体中的话，那么后台接收前台传过来的参数时，要用@RequestParam来接收，或形参前什么也不写也能接收。

如果后端参数是一个对象，且该参数前是以@RequestBody修饰的，那么前端传递json参数时，必须满足以下要求：

1.  后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即：@RequestBody后面的类)时，会根据json字符串中的key来匹配对应实体类的属性，如果匹配一致且json中的该key对应的值符合(或可转换为)， 实体类的对应属性的类型要求时,会调用实体类的setter方法将值赋给该属性。
2.  json字符串中，如果value为""的话，后端对应属性如果是String类型的，那么接受到的就是""，如果是后端属性的类型是Integer、Double等类型，那么接收到的就是null。
3.  json字符串中，如果value为null的话，后端对应收到的就是null。
4.  如果某个参数没有value的话，在传json字符串给后端时，要么干脆就不把该字段写到json字符串中；要么写value时， 必须有值，null  或""都行。

### 2、传入list ###

@GetMapping("/getUserLogin")
    public String getUserLogin(@RequestBody UserLogin userLogin, 
    @RequestParam("arrays") List<String> arrays){
        StringBuilder sb = new StringBuilder();
        for(String array : arrays){
            sb.append(array);
            sb.append(",");
        }
        return sb + "," +  userLogin;
    }

### 3、核心逻辑分析 ###

@RequestBody接受json时，核心逻辑分析示例

假设前端传的json串是这样的： \{"name1":"素小暖","age":18\}** **后端的模型只有name和age属性，以及对应的setter/getter方法；给出一般用到的deserializeFromObject(JsonParser p, DeserializationContext ctxt)方法的核心逻辑：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b3J1aV9qYXZh_size_16_color_FFFFFF_t_70][]

//前提是前端传入的是json数据
    //@JsonAlias表示当进行前端接口调用的时候，user中username传入"userName","userName","UserName"都可接收
    //@JsonProperty表示只能传入passWord，password都无法进行调用
    @Data
    public class User{
        @JsonAlias(value={"userName","userName","UserName"})
        private String username;
        @JsonProperty(value="passWord")
        private String password;
    }
    
    @PostMapping("/getUserLogin")
    public User getUserLogin(@RequestBody User user){
        ...
    }

注意：

1.  @JsonAlias注解需要依赖于setter、getter，而@JsonProperty注解不需要。
2.  在不考虑上述两个注解的一般情况下，key与属性匹配时,默认大小写敏感。
3.  有多个相同的key的json字符串中，转换为模型时，会以相同的几个key中，排在最后的那个key的值给模型属性复制，因为setter会覆盖原来的值。
4.  后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标(即:@RequestBody后面的类)时，会根据json字符串中的key来匹配对应实体类的属性，如果匹配一致且json中的该key对应的值符合(或可转换为)实体类的对应属性的类型要求时，会调用实体类的setter方法将值赋给该属性。

上一篇：[【全栈最全Java框架总结】SSH、SSM、Springboot][Java_SSH_SSM_Springboot]

下一篇：[SpringCloud学习总纲][SpringCloud]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b3J1aV9qYXZh_size_16_color_FFFFFF_t_70]: /images/20210813/5cd477e4072342939ccb8a2065020d17.png
[Java_SSH_SSM_Springboot]: https://blog.csdn.net/guorui_java/article/details/104018528
[SpringCloud]: https://blog.csdn.net/guorui_java/article/details/112055672