@RequestBody、@RequestParam 、@PathVariable @RequestPart 傻傻分不清

Love The Way You Lie 2023-06-27 12:40 22阅读 0赞

# 一、@RequestParam（一个方法中能使用多次） #

1.  用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容。（Http协议中，如果不指定Content-Type，则默认传递的参数就是application/x-www-form-urlencoded类型）
2.  RequestParam可以接受简单类型的属性，也可以接受对象类型。 实质是将Request.getParameter() 中的Key-Value参数Map利用Spring的转化机制ConversionService配置，转化成参数接收对象或字段。
3.  在Content-Type: application/x-www-form-urlencoded的请求中， get 方式中queryString的值，和post方式中 body data的值都会被Servlet接受到并转化到Request.getParameter()参数集中，所以@RequestParam可以获取的到。

# 二、 @RequestBody（一个方法中能使用多次，但是建议只使用一次） #

1.  处理HttpEntity传递过来的数据，一般用来处理非Content-Type: application/x-www-form-urlencoded编码格式的数据。
2.  GET请求中，因为没有HttpEntity，所以@RequestBody并不适用。
3.  POST请求中，通过HttpEntity传递的参数，必须要在请求头中声明数据的类型Content-Type，SpringMVC通过使用HandlerAdapter 配置的HttpMessageConverters来解析HttpEntity中的数据，然后绑定到相应的bean上。
4.  @RequestBody注解一次性将请求体中的数据全部取出来，所以不建议在一次方法中使用多次

# 三、@PathVariable （一个方法中可以使用多次） #

需要配合rest风格url使用，目的是接收rest Url中的参数，可以拼接多个  
例如：  
请求路径：http://127.0.0.1:8082/hello/4/zs

@RequestMapping(value = "/hello/{pageSize}/{name}", method = RequestMethod.GET)
        public String say(@PathVariable("pageSize") String pageSize，@PathVariable("name") String name) { 
            return pageSize;
        }

# 四、@RequestPart（主要用来接收文件） #

1.  @RequestPart这个注解用在multipart/form-data表单提交请求的方法上。
2.  支持的请求方法的方式MultipartFile，属于Spring的MultipartResolver类。这个请求是通过http协议传输的。
3.  @RequestParam也同样支持multipart/form-data请求。（即两者都能用于后端接收文件）
4.  他们最大的不同是，当请求方法的请求参数类型不再是String类型的时候。
5.  @RequestParam适用于name-valueString类型的请求域，@RequestPart适用于复杂的请求域（像JSON，XML）。

# 五、总结 #

1.  在GET请求中，不能使用@RequestBody。
2.  在POST请求中，可以使用@RequestBody和@RequestParam，但是如果使用@RequestBody，对于参数转化的配置必须统一。  
    举个例子，在SpringMVC配置了HttpMessageConverters处理栈中，指定json转化的格式，如Date转成‘yyyy-MM-dd’,则参数接收对象包含的字段如果是Date类型，就只能让客户端传递年月日的格式，不能传时分秒。因为不同的接口，它的参数可能对时间参数有不同的格式要求，所以这样做会让客户端调用同事对参数的格式有点困惑，所以说扩展性不高。
3.  如果使用@RequestParam来接受参数，可以在接受参数的model中设置@DateFormat指定所需要接受时间参数的格式。
4.  另外，使用@RequestBody接受的参数是不会被Servlet转化统一放在request对象的Param参数集中，@RequestParam是可以的。
5.  综上所述，一般情况下，推荐使用@RequestParam注解来接受Http请求参数。
6.  Get请求不能使用表单（没有请求体），只能在url中传参，传参方式只有这一种。 Post请求可以使用表单，也可以在url中传参。  
    使用表单时有几种数据类型（表现为数据的存储位置不同）：  
    1、 x-www-form-urlencoded 参数存储在query中 用@RequestParam接收。  
    2、formdata 参数存储在body中，用@RequestBody接收，文件类型用@RequestPart接收。  
    3、raw(json,xml) 参数存储在body中 用@RequetBody接收。  
    总结一下： 凡是放在body中的都可以用@RequestBody接收，文件类型的数据可以用@RequestPart接收。 凡是放在query中的都可以用@RequestParam接收，包括Get方式提交和Post(x-www-form-urlencoded)方式提交的。

# 六、 工作实际的使用情况 #

1.  如果项目组规定使用 rest 风格的api 并且参数不是很复杂不是很多的得情况下优先使用 @PathVariable 注解接收路径穿过来的参数
2.  能使用@PathVariable 注解的地方都能使用 @RequestParam 进行替换 ，@RequestParam 注解既能接收get请求 问号传参过来的参数，也能接收post请求 问号传参，（post也能使用问号传参）以及post请求 并且Content-Type: 为 application/x-www-form-urlencoded 通常用于接收文件
3.  @RequestPart 注解可以用来替换 @RequestParam 接收文件以及其他更为复杂的数据类型（json xml等等）
4.  @RequestBody 多用于接收post请求 中的请求体的内容，（json数据，大多对应后端的一个实体，或Map类型的数据 等等）
5.  @PathVariable @RequestParam @RequestBody @RequestPart 这四个注解能混合使用，并且每一次注解都支持使用 (required = false）