Spring MVC之@RequestMapping 详解

Bertha 。 2022-06-02 05:41 157阅读 0赞

## 引言： ##

前段时间项目中用到了REST风格来开发程序，但是当用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][] [copy][view plain]

1.  @Controller
2.  @RequestMapping("/appointments") 
3.  publicclass AppointmentsController \{ 
4.  
5.  privatefinal 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. returnnew 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 plain][] [copy][view plain]

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 plain][] [copy][view plain]

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

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

cousumes的样例：

**\[java\]** [view plain][] [copy][view plain]

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

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

produces的样例：

**\[java\]** [view plain][] [copy][view plain]

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 plain][] [copy][view plain]

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

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

headers的样例：

**\[java\]** [view plain][] [copy][view plain]

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

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

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

[view plain]: http://blog.csdn.net/walkerjong/article/details/7994326#