@RequestMapping 用法…

原文地址：@RequestMapping 用法詳解之地址映射作者：LeoWei

前段時間項目中用到了RESTful模式來開發程序，但是當用POST、PUT模式提交數據時，發現服務器端接受不到提交的數據（服務器端參數綁定沒有加任何註解），查看了提交方式爲application/json， 而且服務器端通過request.getReader() 打出的數據裏確實存在瀏覽器提交的數據。爲了找出原因，便對參數綁定（@RequestParam、 @RequestBody、 @RequestHeader 、 @PathVariable）進行了研究，同時也看了一下HttpMessageConverter的相關內容，在此一併總結。

簡介：

@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值，才能讓該方法處理請求。

示例：

1、value  / method 示例

默認RequestMapping("....str...")即爲value的值；

 

[java] view plaincopy

1. @Controller  
2. @RequestMapping("/appointments")  
3. public class AppointmentsController {  
4.   
5.     private final AppointmentBook appointmentBook;  
6.       
7.     @Autowired  
8.     public AppointmentsController(AppointmentBook appointmentBook) {  
9.         this.appointmentBook = appointmentBook;  
10.     }  
11.   
12.     @RequestMapping(method = RequestMethod.GET)  
13.     public Map get() {  
14.         return appointmentBook.getAppointmentsForToday();  
15.     }  
16.   
17.     @RequestMapping(value="/{day}", method = RequestMethod.GET)  
18.     public Map getForDay(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date day, Model model) {  
19.         return appointmentBook.getAppointmentsForDay(day);  
20.     }  
21.   
22.     @RequestMapping(value="/new", method = RequestMethod.GET)  
23.     public AppointmentForm getNewForm() {  
24.         return new AppointmentForm();  
25.     }  
26.   
27.     @RequestMapping(method = RequestMethod.POST)  
28.     public String add(@Valid AppointmentForm appointment, BindingResult result) {  
29.         if (result.hasErrors()) {  
30.             return "appointments/new";  
31.         }  
32.         appointmentBook.addAppointment(appointment);  
33.         return "redirect:/appointments";  
34.     }  
35. }  

 

 

 

 

 

value的uri值爲以下三類：

A） 可以指定爲普通的具體值；

B)  可以指定爲含有某變量的一類值(URI Template Patterns with Path Variables)；

C) 可以指定爲含正則表達式的一類值( URI Template Patterns with Regular Expressions);

example B)

 

[java] view plaincopy

1. @RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)  
2. public String findOwner(@PathVariable String ownerId, Model model) {  
3.   Owner owner = ownerService.findOwner(ownerId);    
4.   model.addAttribute("owner", owner);    
5.   return "displayOwner";   
6. }  

example C)

 

 

 

 

 

 

[java] view plaincopy

1. @RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:d.d.d}.{extension:.[a-z]}")  
2.   public void handle(@PathVariable String version, @PathVariable String extension) {      
3.     // ...  
4.   }  
5. }  

 

 

 

 

 

2 consumes、produces 示例

cousumes的樣例：

 

[java] view plaincopy

1. @Controller  
2. @RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")  
3. public void addPet(@RequestBody Pet pet, Model model) {      
4.     // implementation omitted  
5. }  

方法僅處理request Content-Type爲“application/json”類型的請求。

 

 

 

 

 

produces的樣例：

[java] view plaincopy

1. @Controller  
2. @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json")  
3. @ResponseBody  
4. public Pet getPet(@PathVariable String petId, Model model) {      
5.     // implementation omitted  
6. }  

方法僅處理request請求中Accept頭中包含了"application/json"的請求，同時暗示了返回的內容類型爲application/json;

 

3 params、headers 示例

params的樣例：

[java] view plaincopy

1. @Controller  
2. @RequestMapping("/owners/{ownerId}")  
3. public class RelativePathUriTemplateController {  
4.   
5.   @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue")  
6.   public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
7.     // implementation omitted  
8.   }  
9. }  

 僅處理請求中包含了名爲“myParam”，值爲“myValue”的請求；

 

headers的樣例：

[java] view plaincopy

1. @Controller  
2. @RequestMapping("/owners/{ownerId}")  
3. public class RelativePathUriTemplateController {  
4.   
5. @RequestMapping(value = "/pets", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")  
6.   public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
7.     // implementation omitted  
8.   }  
9. }  

 僅處理request的header中包含了指定“Refer”請求頭和對應值爲“http://www.ifeng.com/”的請求；

 

上面僅僅介紹了，RequestMapping指定的方法處理哪些請求，下面一篇將講解怎樣處理request提交的數據（數據綁定）和返回的數據。