快捷導(dǎo)航

Spring MVC之@RequestMapping注解詳解

更新時(shí)間：2017年01月23日 10:50:32 作者：kobejayandy

本篇文章主要介紹了Spring MVC之@RequestMapping 詳解，RequestMapping是一個(gè)用來(lái)處理請(qǐng)求地址映射的注解，可用于類或方法上。有興趣的可以了解一下。

引言：

前段時(shí)間項(xiàng)目中用到了REST風(fēng)格來(lái)開(kāi)發(fā)程序，但是當(dāng)用POST、PUT模式提交數(shù)據(jù)時(shí)，發(fā)現(xiàn)服務(wù)器端接受不到提交的數(shù)據(jù)（服務(wù)器端參數(shù)綁定沒(méi)有加任何注解），查看了提交方式為application/json，而且服務(wù)器端通過(guò)request.getReader() 打出的數(shù)據(jù)里確實(shí)存在瀏覽器提交的數(shù)據(jù)。為了找出原因，便對(duì)參數(shù)綁定（@RequestParam、 @RequestBody、 @RequestHeader 、 @PathVariable）進(jìn)行了研究，同時(shí)也看了一下HttpMessageConverter的相關(guān)內(nèi)容，在此一并總結(jié)。

簡(jiǎn)介：

@RequestMapping

RequestMapping是一個(gè)用來(lái)處理請(qǐng)求地址映射的注解，可用于類或方法上。用于類上，表示類中的所有響應(yīng)請(qǐng)求的方法都是以該地址作為父路徑。

RequestMapping注解有六個(gè)屬性，下面我們把她分成三類進(jìn)行說(shuō)明。

1、 value， method；

value：指定請(qǐng)求的實(shí)際地址，指定的地址可以是URI Template 模式（后面將會(huì)說(shuō)明）；

method：指定請(qǐng)求的method類型， GET、POST、PUT、DELETE等；

2、 consumes，produces；

consumes：指定處理請(qǐng)求的提交內(nèi)容類型（Content-Type），例如application/json, text/html;

produces: 指定返回的內(nèi)容類型，僅當(dāng)request請(qǐng)求頭中的(Accept)類型中包含該指定類型才返回；

3、 params，headers；

params：指定request中必須包含某些參數(shù)值是，才讓該方法處理。

headers：指定request中必須包含某些指定的header值，才能讓該方法處理請(qǐng)求。

示例：

1、value / method 示例

默認(rèn)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) 可以指定為含正則表達(dá)式的一類值( 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”類型的請(qǐng)求。

produces的樣例：

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

方法僅處理request請(qǐng)求中Accept頭中包含了"application/json"的請(qǐng)求，同時(shí)暗示了返回的內(nèi)容類型為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 
 } 
}

僅處理請(qǐng)求中包含了名為“myParam”，值為“myValue”的請(qǐng)求；

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”請(qǐng)求頭和對(duì)應(yīng)值為“http://www.ifeng.com/”的請(qǐng)求；

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

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: