@PathVariable、@RequestParam和@RequestBody的详解

拼搏现实的明天。 2023-07-11 05:43 5阅读 0赞

**1一、@PathVariable 直译：路径变量**

**@PathVariable是spring3.0的一个新功能：接收请求路径中占位符的值**

@PathVariable("xxx")
    通过 @PathVariable 可以将URL中占位符参数{xxx}绑定到处理器类的方法形参中，获取动态参数链接
    
    @PathVariable(“xxx“) 
     
    @RequestMapping(value = "get/{workID1}",method = RequestMethod.GET)
    	public JsonResult getDeptById(@PathVariable("workID1") String workID) {
    		Employee emp = empService.findOneEmp(workID);
    		return new JsonResult("获取员工数据成功",emp);
    	}
    请求路径：http://localhost:8080/emp/get/0001
    其中两个workID1要保持一致

**二、@RequestParam直译：请求参数**

作用：就是把请求中的指定名称的参数传递给控制器中的形参赋值

属性：1. value / name：请求参数中的名称 （必写参数）  
           2. required：请求参数中是否必须提供此参数，默认值是true，true为必须提供  
           3. defaultValue：默认值

@RequestMapping(value = "get",method = RequestMethod.GET)
    	public JsonResult getDeptById(String workID) {
    		Employee emp = empService.findOneEmp(workID);//workID可以为空
    		return new JsonResult("获取员工数据成功",emp);
    	}
    @RequestMapping(value = "get",method = RequestMethod.GET)
    	public JsonResult getDeptById(@RequestParam String workID) {
    		Employee emp = empService.findOneEmp(workID);
    		return new JsonResult("获取员工数据成功",emp);
    	}
    第一种写法参数为非必传，第二种写法参数为必传

添加属性的用法：

通过@RequestParam(required = false)设置为非必传。因为required值默认是true，所以默认必传

通过@RequestParam("workID")或者@RequestParam(value = "workID")指定参数名

通过@RequestParam(defaultValue = "0")指定参数默认值

@RequestMapping(value = "get",method = RequestMethod.GET)
    	public JsonResult getDeptById(@RequestParam(value = "workID",required =         
                        false,defaultValue = "00002") String workID) {
    		Employee emp = empService.findOneEmp(workID);
    		return new JsonResult("获取员工数据成功",emp);
    	}

**@RequestParam用来处理 `Content-Type` 为 `application/x-www-form-urlencoded` 编码的内容，`Content-Type`默认为该属性。@RequestParam也可用于其它类型的请求，例如：POST、DELETE等请求**。

所以在postman中，要选择body的类型为 `x-www-form-urlencoded`，这样在headers中就自动变为了 `Content-Type` : `application/x-www-form-urlencoded` 编码格式。

但是这样不支持批量插入数据啊，如果改用 `json` 字符串来传值的话，类型设置为 `application/json`，点击发送的话，会报错，后台接收不到值，为 `null`。

这时就需要使用注解@RequestBody了！

**三、@RequestBody直译：请求体**

**作用:**

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

2.GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST方式进行提交。

3.在后端的同一个接收方法里，@RequestBody与@RequestParam()可以同时使用，@RequestBody最多只能有一个，而@RequestParam()可以有多个。

注：当同时使用@RequestParam（）和@RequestBody时，@RequestParam（）指定的参数可以是普通元素、  
       数组、集合、对象等等(即:当，@RequestBody 与@RequestParam()可以同时使用时，原SpringMVC接收  
       参数的机制不变，只不过RequestBody 接收的是请求体里面的数据；而RequestParam接收的是key-value  
       里面的参数，所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。  
       即：如果参数时放在请求体中，传入后台的话，那么后台要用@RequestBody才能接收到；如果不是放在  
              请求体中的话，那么后台接收前台传过来的参数时，要用@RequestParam来接收，或则形参前  
              什么也不写也能接收。

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

注：如果参数前不写@RequestParam(xxx)的话，那么就前端可以有可以没有对应的xxx名字才行，如果有xxx名  
       的话，那么就会自动匹配；没有的话，请求也能正确发送。  
       追注：这里与feign消费服务时不同；feign消费服务时，如果参数前什么也不写，那么会被默认是  
                  @RequestBody的。

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

后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即：@RequestBody后面的类)时，会根据json字符串中的key来匹配对应实体类的属性，如果匹配一致且json中的该key对应的值符合(或可转换为)，这一条我会在下面详细分析，其他的都可简单略过，但是本文末的核心逻辑代码以及几个结论一定要看！ 实体类的对应属性的类型要求时,会调用实体类的setter方法将值赋给该属性。

json字符串中，如果value为""的话，后端对应属性如果是String类型的，那么接受到的就是""，如果是后端属性的类型是Integer、Double等类型，那么接收到的就是null。

json字符串中，如果value为null的话，后端对应收到的就是null。

如果某个参数没有value的话，在传json字符串给后端时，要么干脆就不把该字段写到json字符串中；要么写value时， 必须有值，null  或""都行。

@RequestMapping(value = "updateEmp",method = RequestMethod.PUT)
    	public JsonResult doUpdateEmp(@RequestBody Employee emp){
    		empService.updateEmpInfo(emp);
    		return new JsonResult("update ok");
    	}

## ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MDM4Nzkz_size_16_color_FFFFFF_t_70][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MDM4Nzkz_size_16_color_FFFFFF_t_70 1][] ##

设置Content-Type为json

## **1、从content-type方面总结：** ##

① form-data、x-www-form-urlencoded：不可以用@RequestBody；可以用@RequestParam。见postman的格局，这两种方式的时候没有json字符串部分。

② application/json：json字符串部分可以用@RequestBody；url中的?后面参数可以用@RequestParam。

## **2、从两种注解方式总结：** ##

**@RequestBody**

(@RequestBody Map map)
    (@RequestBody Object object)
    application/json时候可用
    form-data、x-www-form-urlencoded时候不可用

**@RequestParam**

(@RequestParam Map map)
    application/json时候，json字符串部分不可用，
    url中的?后面添加参数即可用，form-data、x-www-form-urlencoded时候可用，
    但是要将Headers里的Content-Type删掉

(@RequestParam String waterEleId,@RequestParam String enterpriseName)
    application/json时候，json字符串部分不可用，url中的?后面添加参数即可用
    form-data、x-www-form-urlencoded时候可用，且参数可以没有顺序（即前端传过来的参数或者url中的参数顺序不必
    和后台接口中的参数顺序一致，只要字段名相同就可以），但是要将Headers里的Content-Type删掉

## ** (@RequestParam Object object)   不管application/json、form-data、x-www-form-urlencoded都不可用** ##

## **3.GET请求上面提过** ##

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MDM4Nzkz_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200304104742501.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MDM4Nzkz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MDM4Nzkz_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200304104828756.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MDM4Nzkz,size_16,color_FFFFFF,t_70