SpringMVC中 -- @RequestMapping的作用及用法

標籤：對象   display   代碼   java   完成   常用   man   writer   數組   

一、@RequestMapping 簡介
　　在Spring MVC 中使用 @RequestMapping 來映射請求，也就是通過它來指定控制器可以處理哪些URL請求，相當於Servlet中在web.xml中配置

    <servlet>        <servlet-name>servletName</servlet-name>        <servlet-class>ServletClass</servlet-class>    </servlet>    <servlet-mapping>        <servlet-name>servletName</servlet-name>        <url-pattern>url</url-pattern>    </servlet-mapping>

　　的映射作用一致。

　　RequestMapping註解類的源碼：

    @Target({ElementType.METHOD, ElementType.TYPE})    @Retention(RetentionPolicy.RUNTIME)    @Documented    @Mapping    public @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）方法均返回數組，也就是可以定義多個屬性值

二、@RequestMapping 域簡介
　　RequestMapping是一個用來處理請求地址映射的註解，可用於類或方法上。用於類上，表示類中的所有響應請求的方法都是以該地址作為父路徑。
　　RequestMapping註解有六個屬性，下面我們把她分成三類進行說明。
　　1、 value， method；
　　　　value： 指定請求的實際地址，指定的地址可以是URI Template 模式；
　　　　method： 指定請求的method類型， GET、POST、PUT、DELETE等；
　　2、 consumes，produces；
　　　　consumes： 指定處理請求的提交內容類型（Content-Type），例如application/json, text/html;
　　　　produces: 指定返回的內容類型，僅當request要求標頭中的(Accept)類型中包含該指定類型才返回；
　　3、 params，headers；
　　　　params： 指定request中必須包含某些參數值是，才讓該方法處理。
　　　　headers： 指定request中必須包含某些指定的header值，才能讓該方法處理請求。

三、@RequestMapping 域用法
　　value的uri值為以下三類：
　　　　A） 可以指定為普通的具體值；
　　　　B) 可以指定為含有某變數的一類值(URI Template Patterns with Path Variables):/owners/{ownerId}
　　　　C) 可以指定為含Regex的一類值( URI Template Patterns with Regular Expressions):/spring-web/{symbolicName:[a-z-]+}-{version:\d\.\d\.\d}.{extension:\.[a-z]}
　　method:
　　　　Http規範定義了多種請求資源的方式，最基本的有四種，分別為：GET（查）、POST（增）、PUT（改）、DELETE（刪），而URL則用於定位網路上的資源相當於地址的作用，配合四種請求方式，可以實現對URL對應的資源的增刪改查操作。
　　consumes:
　　　　consumes="application/json"方法僅處理request Content-Type為“application/json”類型的請求。
　　produces:
　　　　produces="application/json"方法僅處理request請求中Accept頭中包含了"application/json"的請求，同時暗示了返回的內容類型為application/json;
　　params:
　　　　params="myParam=myValue"僅處理請求中包含了名為“myParam”，值為“myValue”的請求；
　　headers:
　　　　headers="Referer=http://www.ifeng.com/" 僅處理request的header中包含了指定“Refer”要求標頭和對應值為“http://www.ifeng.com/”的請求；
四、@RequestParam @RequestBody @PathVariable 等參數綁定註解詳解
　　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可通過 @Controller

        @RequestMapping("/owners/{ownerId}")          public class RelativePathUriTemplateController {            @RequestMapping("/pets/{petId}")              public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {                      // implementation omitted              }          }

　　　　上面代碼把URI template 中變數 ownerId的值和petId的值，綁定到方法的參數上。若方法參數名稱和需要綁定的uri template中變數名稱不一致，需要在@PathVariable("name")指定uri template中的名稱。
　　2、 @RequestHeader、@CookieValue
　　　　@RequestHeader 註解，可以把Request請求header部分的值綁定到方法的參數上。

        Host                    localhost:8080          Accept                  text/html,application/xhtml+xml,application/xml;q=0.9          Accept-Language         fr,en-gb;q=0.7,en;q=0.3          Accept-Encoding         gzip,deflate          Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7          Keep-Alive              300 

        @RequestMapping("/displayHeaderInfo.do")          public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,          @RequestHeader("Keep-Alive") long keepAlive)  {              //...          } 

　　　　上面的代碼，把request header部分的 Accept-Encoding的值，綁定到參數encoding上了， Keep-Alive header的值綁定到參數keepAlive上。

　　　　@CookieValue 可以把Request header中關於cookie的值綁定到方法的參數上。

        JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84  

        @RequestMapping("/displayHeaderInfo.do")          public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {              //...          } 

　　　　即把JSESSIONID的值綁定到參數cookie上。
3、@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用來指示參數是否必須綁定；

        @Controller          @RequestMapping("/pets")          @SessionAttributes("pet")          public class EditPetForm {              @RequestMapping(method = RequestMethod.GET)              public String setupForm(@RequestParam("petId") int petId, ModelMap model) {                  Pet pet = this.clinic.loadPet(petId);                  model.addAttribute("pet", pet);                  return "petForm";              }          }

　　@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;

        @RequestMapping(value = "/something", method = RequestMethod.PUT)          public void handle(@RequestBody String body, Writer writer) throws IOException {              writer.write(body);          }

4、@SessionAttributes, @ModelAttribute
　　@SessionAttributes:
　　該註解用來綁定HttpSession中的attribute對象的值，便於在方法中的參數裡使用。
　　該註解有value、types兩個屬性，可以通過名字和類型指定要使用的attribute 對象；

        @Controller          @RequestMapping("/editPet.do")          @SessionAttributes("pet")          public class EditPetForm {              // ...          } 

　　@ModelAttribute
　　該註解有兩個用法，一個是用於方法上，一個是用於參數上；
　　用於方法上時： 通常用來在處理@RequestMapping之前，為請求綁定需要從後台查詢的model；
　　用於參數上時： 用來通過名稱對應，把相應名稱的值綁定到註解的參數bean上；要綁定的值來源於：
　　　　A） @SessionAttributes 啟用的attribute 對象上；
　　　　B） @ModelAttribute 用於方法上時指定的model對象；
　　　　C） 上述兩種情況都沒有時，new一個需要綁定的bean對象，然後把request中按名稱對應的方式把值綁定到bean中。

        @ModelAttribute          public Account addAccount(@RequestParam String number) {              return accountManager.findAccount(number);          } 

　　這種方式實際的效果就是在調用@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中的值按對應的名稱綁定到Pet對象的各屬性上。
五、補充講解：
問題： 在不給定註解的情況下，參數是怎樣綁定的？
通過分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的原始碼發現，方法的參數在不給定參數的情況下：
若要綁定的對象是簡單類型： 調用@RequestParam來處理的。
若要綁定的對象是複雜類型： 調用@ModelAttribute來處理的。
這裡的簡單類型指Java的原始類型(boolean, int 等)、原始類型對象（Boolean, Int等）、String、Date等ConversionService裡可以直接String轉換成目標對象的類型；

    @RequestMapping ({"/", "/home"})      public String showHomePage(String key){          logger.debug("key="+key);          return "home";      }  

這種情況下，就調用預設的@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";      }  

這種情況下，就調用@ModelAttribute來處理。

2. Java註解：
ThinkingInJava 第20章
3. 建立WEB工程
點這裡
建立和配置 web.xml 以及 spring-mvc.xml 檔案

啦啦啦

SpringMVC中 -- @RequestMapping的作用及用法