@RequestMapping 用法詳解

標籤：size   ica   title   樣本   int   dap   version   響應   mode   

簡介：

@RequestMapping

RequestMapping是一個用來處理請求地址映射的註解，可用於類或方法上。用於類上，表示類中的所有響應請求的方法都是以該地址作為父路徑。

RequestMapping註解有六個屬性，下面我們把她分成三類進行說明。

value， method

value：     指定請求的實際地址，指定的地址可以是URI Template 模式（後面將會說明）；

method：  指定請求的method類型， GET、POST、PUT、DELETE等；

consumes，produces

consumes： 指定處理請求的提交內容類型（Content-Type），例如application/json, text/html;

produces:    指定返回的內容類型，僅當request要求標頭中的(Accept)類型中包含該指定類型才返回；

params，headers

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

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

樣本：value  / method 樣本

預設RequestMapping("....str...")即為value的值；

@Controller  @RequestMapping("/appointments")  public class AppointmentsController {        private 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) 可以指定為含Regex的一類值( 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) {          // ...    }  }  

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;

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 用法詳解