@RequestMapping

简介：

@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值，才能让该方法处理请求。

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的用法。 

1）最基本的，方法级别上应用，例如： 
   

Java代码  

1. @RequestMapping(value="/departments")  
2. public String simplePattern(){  
3.   
4.   System.out.println("simplePattern method was called");  
5.   return "someResult";  
6.   
7. }  

   则访问http://localhost/xxxx/departments的时候，会调用 simplePattern方法了 

2） 参数绑定 
  

Java代码  

1. @RequestMapping(value="/departments")  
2. public String findDepatment(  
3.   @RequestParam("departmentId") String departmentId){  
4.     
5.     System.out.println("Find department with ID: " + departmentId);  
6.     return "someResult";  
7.   
8. }  

   
  形如这样的访问形式： 

   /departments?departmentId=23就可以触发访问findDepatment方法了 

3 REST风格的参数 
  

Java代码  

1. @RequestMapping(value="/departments/{departmentId}")  
2. public String findDepatment(@PathVariable String departmentId){  
3.   
4.   System.out.println("Find department with ID: " + departmentId);  
5.   return "someResult";  
6.   
7. }  

  
  形如REST风格的地址访问，比如： 
/departments/23，其中用(@PathVariable接收rest风格的参数 

4 REST风格的参数绑定形式之2 
   先看例子，这个有点象之前的： 

Java代码  

1. @RequestMapping(value="/departments/{departmentId}")  
2. public String findDepatmentAlternative(  
3.   @PathVariable("departmentId") String someDepartmentId){  
4.   
5.     System.out.println("Find department with ID: " + someDepartmentId);  
6.     return "someResult";  
7.   
8. }  

   这个有点不同，就是接收形如/departments/23的URL访问，把23作为传入的departmetnId,，但是在实际的方法findDepatmentAlternative中，使用 
@PathVariable("departmentId") String someDepartmentId，将其绑定为 
someDepartmentId,所以这里someDepartmentId为23 

5 url中同时绑定多个id 
 

Java代码  

1. @RequestMapping(value="/departments/{departmentId}/employees/{employeeId}")  
2. public String findEmployee(  
3.   @PathVariable String departmentId,  
4.   @PathVariable String employeeId){  
5.   
6.     System.out.println("Find employee with ID: " + employeeId +   
7.       " from department: " + departmentId);  
8.     return "someResult";  
9.   
10. }  

   这个其实也比较好理解了。 

6 支持正则表达式 
  

Java代码  

1. @RequestMapping(value="/{textualPart:[a-z-]+}.{numericPart:[\\d]+}")  
2. public String regularExpression(  
3.   @PathVariable String textualPart,  
4.   @PathVariable String numericPart){  
5.   
6.     System.out.println("Textual part: " + textualPart +   
7.       ", numeric part: " + numericPart);  
8.     return "someResult";  
9. }  

   比如如下的URL：/sometext.123，则输出： 
Textual part: sometext, numeric part: 123.