簡介:
handler method參數綁定常用的注解,我們根據他們處理的Request的不同内容部分分為四類:(主要講解常用類型)
A、處理requet uri部分(這裡指uri template中variable,不含queryString部分)的注解:@PathVariable;
B、處理request header部分的注解:@RequestHeader,@CookieValue;
C、處理request body部分的注解:@RequestParam,@RequestBody;
D、處理attribute類型是注解: @SessionAttributes,@ModelAttribute;
1、 @PathVariable
當使用@RequestMapping URI template樣式映射時, 即someUrl/{paramId},這時的paramId可通過@Pathvariable注解綁定它傳過來的值到方法的參數上。
示例代碼:
上面代碼把URI template中變量ownerId的值和petId的值,綁定到方法的參數上。若方法參數名稱和需要綁定的uri template中變量名稱不一緻,需要在@PathVariable("name")指定uri template中的名稱。
2、 @RequestHeader、@CookieValue
@RequestHeader 注解,可以把Request請求header部分的值綁定到方法的參數上。
這是一個Request 的header部分:
上面的代碼,把request header部分的 Accept-Encoding的值,綁定到參數encoding上了,Keep-Alive header的值綁定到參數keepAlive上。
@CookieValue 可以把Request header中關于cookie的值綁定到方法的參數上。
例如有如下Cookie值:
參數綁定的代碼:
即把JSESSIONID的值綁定到參數cookie上。
3、@RequestParam, @RequestBody
@RequestParam
A)常用來處理簡單類型的綁定,通過Request.getParameter() 擷取的String可直接轉換為簡單類型的情況( String-->簡單類型的轉換操作由ConversionService配置的轉換器來完成);因為使用request.getParameter()方式擷取參數,是以可以處理get方式中queryString的值,也可以處理post方式中body data的值;
B)用來處理Content-Type: 為 <code>application/x-www-form-urlencoded</code>編碼的内容,送出方式GET、POST;
C)該注解有兩個屬性: value、required;value用來指定要傳入值的id名稱,required用來訓示參數是否必須綁定;
@RequestBody
該注解常用來處理Content-Type: 不是<code>application/x-www-form-urlencoded</code>編碼的内容,例如application/json,application/xml等;
它是通過使用HandlerAdapter 配置的<code>HttpMessageConverters</code>來解析post data body,然後綁定到相應的bean上的。
因為配置有FormHttpMessageConverter,是以也可以用來處理<code>application/x-www-form-urlencoded</code>的内容,處理完的結果放在一個MultiValueMap<String, String>裡,這種情況在某些特殊需求下使用,詳情檢視FormHttpMessageConverter api;
4、@SessionAttributes, @ModelAttribute
@SessionAttributes
該注解用來綁定HttpSession中的attribute對象的值,便于在方法中的參數裡使用。
該注解有value、types兩個屬性,可以通過名字和類型指定要使用的attribute 對象;
@ModelAttribute
該注解有兩個用法,一個是用于方法上,一個是用于參數上;
用于方法上時:通常用來在處理@RequestMapping之前,為請求綁定需要從背景查詢的model;
用于參數上時:用來通過名稱對應,把相應名稱的值綁定到注解的參數bean上;要綁定的值來源于:
A)@SessionAttributes 啟用的attribute 對象上;
B)@ModelAttribute 用于方法上時指定的model對象;
C)上述兩種情況都沒有時,new一個需要綁定的bean對象,然後把request中按名稱對應的方式把值綁定到bean中。
用到方法上@ModelAttribute的示例代碼:
這種方式實際的效果就是在調用@RequestMapping的方法之前,為request對象的model裡put(“account”, Account);
用在參數上的@ModelAttribute示例代碼:
首先查詢@SessionAttributes有無綁定的Pet對象,若沒有則查詢@ModelAttribute方法層面上是否綁定了Pet對象,若沒有則将URI template中的值按對應的名稱綁定到Pet對象的各屬性上。