Spring MVC之@RequestMapping注解详解

引言：

前段时间项目中用到了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的值；

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

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

@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的样例：

@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的样例：

@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的样例：

@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的样例：

@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提交的数据（数据绑定）和返回的数据。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。