基于@RequestMapping 用法詳解之地址映射
@RequestMapping之地址映射
引言:
前段時間項目中用到了RESTful模式來開發(fā)程序,但是當(dāng)用POST、PUT模式提交數(shù)據(jù)時,發(fā)現(xiàn)服務(wù)器端接受不到提交的數(shù)據(jù)(服務(wù)器端參數(shù)綁定沒有加任何注解),查看了提交方式為application/json, 而且服務(wù)器端通過request.getReader() 打出的數(shù)據(jù)里確實存在瀏覽器提交的數(shù)據(jù)。
為了找出原因,便對參數(shù)綁定(@RequestParam、 @RequestBody、 @RequestHeader 、 @PathVariable)進(jìn)行了研究,同時也看了一下HttpMessageConverter的相關(guān)內(nèi)容,在此一并總結(jié)。
簡介:
@RequestMapping
RequestMapping是一個用來處理請求地址映射的注解,可用于類或方法上。用于類上,表示類中的所有響應(yīng)請求的方法都是以該地址作為父路徑。
RequestMapping注解有六個屬性,下面我們把她分成三類進(jìn)行說明。
1、value, method;
value
:指定請求的實際地址,指定的地址可以是URI Template 模式(后面將會說明);method
:指定請求的method類型, GET、POST、PUT、DELETE等;
2、consumes,produces;
consumes
:指定處理請求的提交內(nèi)容類型(Content-Type),例如application/json, text/html;produces
:指定返回的內(nèi)容類型,僅當(dāng)request請求頭中的(Accept)類型中包含該指定類型才返回;
3、 params,headers;
params
:指定request中必須包含某些參數(shù)值是,才讓該方法處理。headers
:指定request中必須包含某些指定的header值,才能讓該方法處理請求。
示例:
1、value / method 示例
默認(rèn)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) 可以指定為含正則表達(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”類型的請求。
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"的請求,同時暗示了返回的內(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 } }
僅處理請求中包含了名為“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”請求頭和對應(yīng)值為“http://www.ifeng.com/”的請求;
上面介紹了,RequestMapping指定的方法處理哪些請求,以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
Java創(chuàng)建對象(顯式創(chuàng)建和隱含創(chuàng)建)
本文詳細(xì)介紹對象的創(chuàng)建,在 Java 語言中創(chuàng)建對象分顯式創(chuàng)建與隱含創(chuàng)建兩種情況,顯式創(chuàng)建和隱含創(chuàng)建,,需要的朋友可以參考下面文章的具體內(nèi)容2021-09-09Spring Boot 項目設(shè)置網(wǎng)站圖標(biāo)的方法
這篇文章主要介紹了Spring Boot 項目設(shè)置網(wǎng)站圖標(biāo)的方法,本文給大家介紹的非常詳細(xì),具有一定的參考借鑒價值,需要的朋友可以參考下2020-02-02SpringBoot從Nacos讀取MySQL數(shù)據(jù)庫配置錯誤:Public Key Retrieva
最近的項目,突然都從MySQL5.7升級到8.0了,有些項目能運行成功,有些項目遇到了問題,啟動不成功,顯示數(shù)據(jù)庫方面的異常信息,本文給大家介紹了SpringBoot從Nacos讀取MySQL數(shù)據(jù)庫配置錯誤:Public Key Retrieval is not allowed的解決方案,需要的朋友可以參考下2024-04-04