@RequestParam @RequestBody @PathVariable 等参数绑定注解

handler method 参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为五类:(主要讲解常用类型)

1)、处理requet uri 部分(这里指uri template中variable,不含queryString部分)的注解:@RequestMapping, @PathVariable;
2)、处理request header部分的注解: @RequestHeader, @CookieValue;
3)、处理request body部分的注解:@RequestParam, @RequestBody;

4)、处理attribute类型是注解: @SessionAttributes, @ModelAttribute;

(1) @RequestMapping

RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。

RequestMapping注解有六个属性,

      value:     指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明);

      method:  指定请求的method类型, GET、POST、PUT、DELETE等;

      consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

      produces:    指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

      params: 指定request中必须包含某些参数值是,才让该方法处理。

      headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。

(2) @PathVariable 

      当使用@RequestMapping URI template 样式映射时, 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。

(3) @RequestHeader、@CookieValue

      @RequestHeader 注解,可以把Request请求header部分的值绑定到方法的参数上。

      @CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。

(4) @RequestParam, @RequestBody

    @RequestParam
      A) 常用来处理简单类型的绑定,通过Request.getParameter() 获取的String可直接转换为简单类型的情况( String--> 简单类型的转换操作由ConversionService配置的转换器来完成);因为使用request.getParameter()方式获取参数,所以可以处理get 方式中queryString的值,也可以处理post方式中 body data的值;
      B)用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容,提交方式GET、POST;

      C) 该注解有两个属性: value、required; value用来指定要传入值的id名称,required用来指示参数是否必须绑定;

    @RequestBody

      该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容,例如application/json, application/xml等;

      它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body,然后绑定到相应的bean上的。

      因为配置有FormHttpMessageConverter,所以也可以用来处理 application/x-www-form-urlencoded的内容,处理完的结果放在一个MultiValueMap<String, String>里,这种情况在某些特殊需求下使用,详情查看FormHttpMessageConverter api;

(5) @SessionAttributes, @ModelAttribute

    @SessionAttributes:

      该注解用来绑定HttpSession中的attribute对象的值,便于在方法中的参数里使用。
      该注解有value、types两个属性,可以通过名字和类型指定要使用的attribute 对象;

    @ModelAttribute

      该注解有两个用法,一个是用于方法上,一个是用于参数上;

      用于方法上时: 通常用来在处理@RequestMapping之前,为请求绑定需要从后台查询的model;

      用于参数上时: 用来通过名称对应,把相应名称的值绑定到注解的参数bean上;要绑定的值来源于:

      A) @SessionAttributes 启用的attribute 对象上;

      B) @ModelAttribute 用于方法上时指定的model对象;

      C) 上述两种情况都没有时,new一个需要绑定的bean对象,然后把request中按名称对应的方式把值绑定到bean中。

参考:

https://blog.csdn.net/walkerjong/article/details/7946109

原文地址:https://www.cnblogs.com/sfnz/p/15656490.html