Spring Web MVC 注解

@RequestMapping

@RequestMapping注解的主要用途是將Web請(qǐng)求與請(qǐng)求處理類(lèi)中的方法進(jìn)行映射。Spring MVC和Spring WebFlux都通過(guò)RquestMappingHandlerMapping和RequestMappingHndlerAdapter兩個(gè)類(lèi)來(lái)提供對(duì)@RequestMapping注解的支持。

@RequestMapping注解對(duì)請(qǐng)求處理類(lèi)中的請(qǐng)求處理方法進(jìn)行標(biāo)注；@RequestMapping注解擁有以下的六個(gè)配置屬性：

• value:映射的請(qǐng)求URL或者其別名
• method:兼容HTTP的方法名
• params:根據(jù)HTTP參數(shù)的存在、缺省或值對(duì)請(qǐng)求進(jìn)行過(guò)濾
• header:根據(jù)HTTP Header的存在、缺省或值對(duì)請(qǐng)求進(jìn)行過(guò)濾
• consume:設(shè)定在HTTP請(qǐng)求正文中允許使用的媒體類(lèi)型
• product:在HTTP響應(yīng)體中允許使用的媒體類(lèi)型

提示：在使用@RequestMapping之前，請(qǐng)求處理類(lèi)還需要使用@Controller或@RestController進(jìn)行標(biāo)記

下面是使用@RequestMapping的兩個(gè)示例：

圖片

@RequestMapping還可以對(duì)類(lèi)進(jìn)行標(biāo)記，這樣類(lèi)中的處理方法在映射請(qǐng)求路徑時(shí)，會(huì)自動(dòng)將類(lèi)上@RequestMapping設(shè)置的value拼接到方法中映射路徑之前，如下：

圖片

@RequestBody

@RequestBody在處理請(qǐng)求方法的參數(shù)列表中使用，它可以將請(qǐng)求主體中的參數(shù)綁定到一個(gè)對(duì)象中，請(qǐng)求主體參數(shù)是通過(guò)HttpMessageConverter傳遞的，根據(jù)請(qǐng)求主體中的參數(shù)名與對(duì)象的屬性名進(jìn)行匹配并綁定值。此外，還可以通過(guò)@Valid注解對(duì)請(qǐng)求主體中的參數(shù)進(jìn)行校驗(yàn)。

下面是一個(gè)使用@RequestBody的示例：

圖片

@GetMapping

@GetMapping注解用于處理HTTP GET請(qǐng)求，并將請(qǐng)求映射到具體的處理方法中。具體來(lái)說(shuō)，@GetMapping是一個(gè)組合注解，它相當(dāng)于是@RequestMapping(method=RequestMethod.GET)的快捷方式。

下面是@GetMapping的一個(gè)使用示例：

圖片

@PostMapping

@PostMapping注解用于處理HTTP POST請(qǐng)求，并將請(qǐng)求映射到具體的處理方法中。@PostMapping與@GetMapping一樣，也是一個(gè)組合注解，它相當(dāng)于是@RequestMapping(method=HttpMethod.POST)的快捷方式。

下面是使用@PostMapping的一個(gè)示例：

圖片

@PutMapping

@PutMapping注解用于處理HTTP PUT請(qǐng)求，并將請(qǐng)求映射到具體的處理方法中，@PutMapping是一個(gè)組合注解，相當(dāng)于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。

下面是使用@PutMapping的一個(gè)示例：

圖片

@DeleteMapping

@DeleteMapping注解用于處理HTTP DELETE請(qǐng)求，并將請(qǐng)求映射到刪除方法中。@DeleteMapping是一個(gè)組合注解，它相當(dāng)于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。

下面是使用@DeleteMapping的一個(gè)示例：

圖片

@PatchMapping

@PatchMapping注解用于處理HTTP PATCH請(qǐng)求，并將請(qǐng)求映射到對(duì)應(yīng)的處理方法中。@PatchMapping相當(dāng)于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。

下面是一個(gè)簡(jiǎn)單的示例：

圖片

@ControllerAdvice

@ControllerAdvice是@Component注解的一個(gè)延伸注解，Spring會(huì)自動(dòng)掃描并檢測(cè)被@ControllerAdvice所標(biāo)注的類(lèi)。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用，主要是用來(lái)處理控制器所拋出的異常信息。

首先，我們需要定義一個(gè)被@ControllerAdvice所標(biāo)注的類(lèi)，在該類(lèi)中，定義一個(gè)用于處理具體異常的方法，并使用@ExceptionHandler注解進(jìn)行標(biāo)記。

此外，在有必要的時(shí)候，可以使用@InitBinder在類(lèi)中進(jìn)行全局的配置，還可以使用@ModelAttribute配置與視圖相關(guān)的參數(shù)。使用@ControllerAdvice注解，就可以快速的創(chuàng)建統(tǒng)一的，自定義的異常處理類(lèi)。

下面是一個(gè)使用@ControllerAdvice的示例代碼：

圖片

@ResponseBody

@ResponseBody會(huì)自動(dòng)將控制器中方法的返回值寫(xiě)入到HTTP響應(yīng)中。特別的，@ResponseBody注解只能用在被@Controller注解標(biāo)記的類(lèi)中。如果在被@RestController標(biāo)記的類(lèi)中，則方法不需要使用@ResponseBody注解進(jìn)行標(biāo)注。@RestController相當(dāng)于是@Controller和@ResponseBody的組合注解。

下面是使用該注解的一個(gè)示例

圖片

@ExceptionHandler

@ExceptionHander注解用于標(biāo)注處理特定類(lèi)型異常類(lèi)所拋出異常的方法。當(dāng)控制器中的方法拋出異常時(shí)，Spring會(huì)自動(dòng)捕獲異常，并將捕獲的異常信息傳遞給被@ExceptionHandler標(biāo)注的方法。

下面是使用該注解的一個(gè)示例：

圖片

@ResponseStatus

@ResponseStatus注解可以標(biāo)注請(qǐng)求處理方法。使用此注解，可以指定響應(yīng)所需要的HTTP STATUS。特別地，我們可以使用HttpStauts類(lèi)對(duì)該注解的value屬性進(jìn)行賦值。

下面是使用@ResponseStatus注解的一個(gè)示例：

圖片

@PathVariable

@PathVariable注解是將方法中的參數(shù)綁定到請(qǐng)求URI中的模板變量上。可以通過(guò)@RequestMapping注解來(lái)指定URI的模板變量，然后使用@PathVariable注解將方法中的參數(shù)綁定到模板變量上。

特別地，@PathVariable注解允許我們使用value或name屬性來(lái)給參數(shù)取一個(gè)別名。下面是使用此注解的一個(gè)示例：

圖片

模板變量名需要使用{ }進(jìn)行包裹，如果方法的參數(shù)名與URI模板變量名一致，則在@PathVariable中就可以省略別名的定義。

下面是一個(gè)簡(jiǎn)寫(xiě)的示例：

圖片

提示：如果參數(shù)是一個(gè)非必須的，可選的項(xiàng)，則可以在@PathVariable中設(shè)置require = false

@RequestParam

@RequestParam注解用于將方法的參數(shù)與Web請(qǐng)求的傳遞的參數(shù)進(jìn)行綁定。使用@RequestParam可以輕松的訪問(wèn)HTTP請(qǐng)求參數(shù)的值。

下面是使用該注解的代碼示例：

圖片

該注解的其他屬性配置與@PathVariable的配置相同，特別的，如果傳遞的參數(shù)為空，還可以通過(guò)defaultValue設(shè)置一個(gè)默認(rèn)值。示例代碼如下：

圖片

@Controller

@Controller是@Component注解的一個(gè)延伸，Spring 會(huì)自動(dòng)掃描并配置被該注解標(biāo)注的類(lèi)。此注解用于標(biāo)注Spring MVC的控制器。下面是使用此注解的示例代碼：

圖片

@RestController

@RestController是在Spring 4.0開(kāi)始引入的，這是一個(gè)特定的控制器注解。此注解相當(dāng)于@Controller和@ResponseBody的快捷方式。當(dāng)使用此注解時(shí)，不需要再在方法上使用@ResponseBody注解。

下面是使用此注解的示例代碼：

圖片

@ModelAttribute

通過(guò)此注解，可以通過(guò)模型索引名稱來(lái)訪問(wèn)已經(jīng)存在于控制器中的model。下面是使用此注解的一個(gè)簡(jiǎn)單示例：

圖片

與@PathVariable和@RequestParam注解一樣，如果參數(shù)名與模型具有相同的名字，則不必指定索引名稱，簡(jiǎn)寫(xiě)示例如下：

圖片

特別地，如果使用@ModelAttribute對(duì)方法進(jìn)行標(biāo)注，Spring會(huì)將方法的返回值綁定到具體的Model上。示例如下：

圖片

在Spring調(diào)用具體的處理方法之前，被@ModelAttribute注解標(biāo)注的所有方法都將被執(zhí)行。

@CrossOrigin

@CrossOrigin注解將為請(qǐng)求處理類(lèi)或請(qǐng)求處理方法提供跨域調(diào)用支持。如果我們將此注解標(biāo)注類(lèi)，那么類(lèi)中的所有方法都將獲得支持跨域的能力。使用此注解的好處是可以微調(diào)跨域行為。使用此注解的示例如下：

圖片

@InitBinder

@InitBinder注解用于標(biāo)注初始化WebDataBinider 的方法，該方法用于對(duì)Http請(qǐng)求傳遞的表單數(shù)據(jù)進(jìn)行處理，如時(shí)間格式化、字符串處理等。下面是使用此注解的示例：

圖片