javascript
SpringMVC中 -- @RequestMapping的作用及用法
一、@RequestMapping 簡介
在Spring MVC 中使用 @RequestMapping 來映射請求,也就是通過它來指定控制器可以處理哪些URL請求,相當(dāng)于Servlet中在web.xml中配置
的映射作用一致。
RequestMapping注解類的源碼:
@Target({ElementType.METHOD, ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Mappingpublic @interface RequestMapping {String[] value() default {};RequestMethod[] method() default {};String[] params() default {};String[] headers() default {};String[] consumes() default {};String[] produces() default {};} 1)在@Target中有兩個屬性,分別為 ElementType.METHOD 和 ElementType.TYPE ,也就是說 @RequestMapping 可以在方法和類的聲明中使用
2)方法均返回數(shù)組,也就是可以定義多個屬性值
二、@RequestMapping 域簡介
RequestMapping是一個用來處理請求地址映射的注解,可用于類或方法上。用于類上,表示類中的所有響應(yīng)請求的方法都是以該地址作為父路徑。
RequestMapping注解有六個屬性,下面我們把她分成三類進行說明。
1、 value, method;
value: 指定請求的實際地址,指定的地址可以是URI Template 模式;
method: 指定請求的method類型, GET、POST、PUT、DELETE等;
2、 consumes,produces;
consumes: 指定處理請求的提交內(nèi)容類型(Content-Type),例如application/json, text/html;
produces: 指定返回的內(nèi)容類型,僅當(dāng)request請求頭中的(Accept)類型中包含該指定類型才返回;
3、 params,headers;
params: 指定request中必須包含某些參數(shù)值是,才讓該方法處理。
headers: 指定request中必須包含某些指定的header值,才能讓該方法處理請求。
三、@RequestMapping 域用法
value的uri值為以下三類:
A) 可以指定為普通的具體值;
B) 可以指定為含有某變量的一類值(URI Template Patterns with Path Variables):/owners/{ownerId}
C) 可以指定為含正則表達(dá)式的一類值( URI Template Patterns with Regular Expressions):/spring-web/{symbolicName:[a-z-]+}-{version:\d\.\d\.\d}.{extension:\.[a-z]}
method:
Http規(guī)范定義了多種請求資源的方式,最基本的有四種,分別為:GET(查)、POST(增)、PUT(改)、DELETE(刪),而URL則用于定位網(wǎng)絡(luò)上的資源相當(dāng)于地址的作用,配合四種請求方式,可以實現(xiàn)對URL對應(yīng)的資源的增刪改查操作。
consumes:
consumes="application/json"方法僅處理request Content-Type為“application/json”類型的請求。
produces:
produces="application/json"方法僅處理request請求中Accept頭中包含了"application/json"的請求,同時暗示了返回的內(nèi)容類型為application/json;
params:
params="myParam=myValue"僅處理請求中包含了名為“myParam”,值為“myValue”的請求;
headers:
headers="Referer=http://www.ifeng.com/" 僅處理request的header中包含了指定“Refer”請求頭和對應(yīng)值為“http://www.ifeng.com/”的請求;
四、@RequestParam @RequestBody @PathVariable 等參數(shù)綁定注解詳解
handler method 參數(shù)綁定常用的注解,我們根據(jù)他們處理的Request的不同內(nèi)容部分分為四類:(主要講解常用類型)
A、處理requet uri 部分(這里指uri template中variable,不含queryString部分)的注解: @PathVariable;
B、處理request header部分的注解: @RequestHeader, @CookieValue;
C、處理request body部分的注解:@RequestParam, @RequestBody;
D、處理attribute類型是注解: @SessionAttributes, @ModelAttribute;
1、 @PathVariable
當(dāng)使用@RequestMapping URI template 樣式映射時, 即 someUrl/{paramId}, 這時的paramId可通過 @Controller
上面代碼把URI template 中變量 ownerId的值和petId的值,綁定到方法的參數(shù)上。若方法參數(shù)名稱和需要綁定的uri template中變量名稱不一致,需要在@PathVariable("name")指定uri template中的名稱。
2、 @RequestHeader、@CookieValue
@RequestHeader 注解,可以把Request請求header部分的值綁定到方法的參數(shù)上。
上面的代碼,把request header部分的 Accept-Encoding的值,綁定到參數(shù)encoding上了, Keep-Alive header的值綁定到參數(shù)keepAlive上。
@CookieValue 可以把Request header中關(guān)于cookie的值綁定到方法的參數(shù)上。
JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84 @RequestMapping("/displayHeaderInfo.do") public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie) { //... } 即把JSESSIONID的值綁定到參數(shù)cookie上。
3、@RequestParam, @RequestBody
@RequestParam
A) 常用來處理簡單類型的綁定,通過Request.getParameter() 獲取的String可直接轉(zhuǎn)換為簡單類型的情況( String--> 簡單類型的轉(zhuǎn)換操作由ConversionService配置的轉(zhuǎn)換器來完成);因為使用request.getParameter()方式獲取參數(shù),所以可以處理get 方式中queryString的值,也可以處理post方式中 body data的值;
B)用來處理Content-Type: 為 application/x-www-form-urlencoded編碼的內(nèi)容,提交方式GET、POST;
C) 該注解有兩個屬性: value、required; value用來指定要傳入值的id名稱,required用來指示參數(shù)是否必須綁定;
@RequestBody
該注解常用來處理Content-Type: 不是application/x-www-form-urlencoded編碼的內(nèi)容,例如application/json, application/xml等;
它是通過使用HandlerAdapter 配置的HttpMessageConverters來解析post data body,然后綁定到相應(yīng)的bean上的。
因為配置有FormHttpMessageConverter,所以也可以用來處理 application/x-www-form-urlencoded的內(nèi)容,處理完的結(jié)果放在一個MultiValueMap<String, String>里,這種情況在某些特殊需求下使用,詳情查看FormHttpMessageConverter api;
4、@SessionAttributes, @ModelAttribute
@SessionAttributes:
該注解用來綁定HttpSession中的attribute對象的值,便于在方法中的參數(shù)里使用。
該注解有value、types兩個屬性,可以通過名字和類型指定要使用的attribute 對象;
@ModelAttribute
該注解有兩個用法,一個是用于方法上,一個是用于參數(shù)上;
用于方法上時: 通常用來在處理@RequestMapping之前,為請求綁定需要從后臺查詢的model;
用于參數(shù)上時: 用來通過名稱對應(yīng),把相應(yīng)名稱的值綁定到注解的參數(shù)bean上;要綁定的值來源于:
A) @SessionAttributes 啟用的attribute 對象上;
B) @ModelAttribute 用于方法上時指定的model對象;
C) 上述兩種情況都沒有時,new一個需要綁定的bean對象,然后把request中按名稱對應(yīng)的方式把值綁定到bean中。
這種方式實際的效果就是在調(diào)用@RequestMapping的方法之前,為request對象的model里put(“account”, Account);
@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST) public String processSubmit(@ModelAttribute Pet pet) { }首先查詢 @SessionAttributes有無綁定的Pet對象,若沒有則查詢@ModelAttribute方法層面上是否綁定了Pet對象,若沒有則將URI template中的值按對應(yīng)的名稱綁定到Pet對象的各屬性上。
五、補充講解:
問題: 在不給定注解的情況下,參數(shù)是怎樣綁定的?
通過分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的源代碼發(fā)現(xiàn),方法的參數(shù)在不給定參數(shù)的情況下:
若要綁定的對象是簡單類型: 調(diào)用@RequestParam來處理的。
若要綁定的對象是復(fù)雜類型: 調(diào)用@ModelAttribute來處理的。
這里的簡單類型指Java的原始類型(boolean, int 等)、原始類型對象(Boolean, Int等)、String、Date等ConversionService里可以直接String轉(zhuǎn)換成目標(biāo)對象的類型;
這種情況下,就調(diào)用默認(rèn)的@RequestParam來處理。
@RequestMapping (method = RequestMethod.POST) public String doRegister(User user){ if(logger.isDebugEnabled()){ logger.debug("process url[/user], method[post] in "+getClass()); logger.debug(user); } return "user"; }這種情況下,就調(diào)用@ModelAttribute來處理。
2. Java注解:
ThinkingInJava 第20章
3. 新建WEB工程
點這里
新建和配置 web.xml 以及 spring-mvc.xml 文件
啦啦啦
總結(jié)
以上是生活随笔為你收集整理的SpringMVC中 -- @RequestMapping的作用及用法的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Java代码质量监控工具Sonar安装
- 下一篇: Python 深拷贝和浅拷贝的区别