@RequestMapping 用法详解之地址映射

太过爱你忘了你带给我的痛 2022-08-27 03:58 154阅读 0赞

# 分类： [ spring][spring]2012-09-19 10:40  9093人阅读 [评论][Link 1](3) 收藏 [举报][Link 2]     #

[string][] [extension][] [autowired][] [正则表达式][Link 3] [variables][] [服务器][Link 4]

目录[(?)][Link 5][\[+\]][Link 5]

1.  [引言][Link 6]
2.  [简介][Link 7]
    
    1.  [value method][]
    2.  [consumesproduces][]
    3.  [paramsheaders ][paramsheaders]
3.  [示例][Link 8]
    
    1.  [value  method 示例 ][value_ method _]
    2.  [consumesproduces 示例 ][consumesproduces _]
    3.  [paramsheaders 示例 ][paramsheaders _]
4.  [参考资料][Link 9]

## 引言： ##

前段时间项目中用到了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 plain][Link 5] [copy][Link 5] [print][Link 5] [?][Link 5]

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<String, Appointment> get() \{  
14.         return appointmentBook.getAppointmentsForToday();  
15.     \}  
16.   
17.     @RequestMapping(value="/\{day\}", method = RequestMethod.GET)  
18.     public Map<String, Appointment> 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. \}

@Controller
    @RequestMapping("/appointments")
    public class AppointmentsController {
    
        private final AppointmentBook appointmentBook;
        
        @Autowired
        public AppointmentsController(AppointmentBook appointmentBook) {
            this.appointmentBook = appointmentBook;
        }
    
        @RequestMapping(method = RequestMethod.GET)
        public Map<String, Appointment> get() {
            return appointmentBook.getAppointmentsForToday();
        }
    
        @RequestMapping(value="/{day}", method = RequestMethod.GET)
        public Map<String, Appointment> getForDay(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date day, Model model) {
            return appointmentBook.getAppointmentsForDay(day);
        }
    
        @RequestMapping(value="/new", method = RequestMethod.GET)
        public AppointmentForm getNewForm() {
            return new AppointmentForm();
        }
    
        @RequestMapping(method = RequestMethod.POST)
        public String add(@Valid AppointmentForm appointment, BindingResult result) {
            if (result.hasErrors()) {
                return "appointments/new";
            }
            appointmentBook.addAppointment(appointment);
            return "redirect:/appointments";
        }
    }

value的uri值为以下三类：

A） 可以指定为普通的具体值；

B)  可以指定为含有某变量的一类值(URI Template Patterns with Path Variables)；

C) 可以指定为含正则表达式的一类值( URI Template Patterns with Regular Expressions);

example B)

**\[java\]** [ view plain][Link 5] [copy][Link 5] [print][Link 5] [?][Link 5]

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.  \}

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

example C)

**\[java\]** [ view plain][Link 5] [copy][Link 5] [print][Link 5] [?][Link 5]

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.  \}

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

### 2 consumes、produces 示例    ###

cousumes的样例：

**\[java\]** [ view plain][Link 5] [copy][Link 5] [print][Link 5] [?][Link 5]

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.  \}

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

方法仅处理request Content-Type为“application/json”类型的请求。

produces的样例：

**\[java\]** [ view plain][Link 5] [copy][Link 5] [print][Link 5] [?][Link 5]

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.  \}

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

方法仅处理request请求中Accept头中包含了"application/json"的请求，同时暗示了返回的内容类型为application/json;

### 3 params、headers 示例    ###

params的样例：

**\[java\]** [ view plain][Link 5] [copy][Link 5] [print][Link 5] [?][Link 5]

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.  \}

@Controller
    @RequestMapping("/owners/{ownerId}")
    public class RelativePathUriTemplateController {
    
      @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue")
      public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {    
        // implementation omitted
      }
    }

仅处理请求中包含了名为“myParam”，值为“myValue”的请求；

headers的样例：

**\[java\]** [ view plain][Link 5] [copy][Link 5] [print][Link 5] [?][Link 5]

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.  \}

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

仅处理request的header中包含了指定“Refer”请求头和对应值为“`http://www.ifeng.com/`”的请求；

上面仅仅介绍了，RequestMapping指定的方法处理哪些请求，下面一篇将讲解怎样处理request提交的数据（数据绑定）和返回的数据。

## 参考资料： ##

1、 Spring Web Doc：

spring-3.1.0/docs/spring-framework-reference/html/mvc.html

[spring]: http://blog.csdn.net/walkerJong/article/category/958282
[Link 1]: http://blog.csdn.net/walkerjong/article/details/7994326#comments
[Link 2]: http://blog.csdn.net/walkerjong/article/details/7994326#report
[string]: http://www.csdn.net/tag/string
[extension]: http://www.csdn.net/tag/extension
[autowired]: http://www.csdn.net/tag/autowired
[Link 3]: http://www.csdn.net/tag/%e6%ad%a3%e5%88%99%e8%a1%a8%e8%be%be%e5%bc%8f
[variables]: http://www.csdn.net/tag/variables
[Link 4]: http://www.csdn.net/tag/%e6%9c%8d%e5%8a%a1%e5%99%a8
[Link 5]: http://blog.csdn.net/walkerjong/article/details/7994326#
[Link 6]: http://blog.csdn.net/walkerjong/article/details/7994326#t0
[Link 7]: http://blog.csdn.net/walkerjong/article/details/7994326#t1
[value method]: http://blog.csdn.net/walkerjong/article/details/7994326#t2
[consumesproduces]: http://blog.csdn.net/walkerjong/article/details/7994326#t3
[paramsheaders]: http://blog.csdn.net/walkerjong/article/details/7994326#t4
[Link 8]: http://blog.csdn.net/walkerjong/article/details/7994326#t5
[value_ method _]: http://blog.csdn.net/walkerjong/article/details/7994326#t6
[consumesproduces _]: http://blog.csdn.net/walkerjong/article/details/7994326#t7
[paramsheaders _]: http://blog.csdn.net/walkerjong/article/details/7994326#t8
[Link 9]: http://blog.csdn.net/walkerjong/article/details/7994326#t9