Spring Web MVC注解

Spring Web MVC 注解

@RequestMapping

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

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

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

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

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

圖片

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

圖片

@RequestBody

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

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

圖片

@GetMapping

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

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

圖片

@PostMapping

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

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

圖片

@PutMapping

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

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

圖片

@DeleteMapping

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

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

圖片

@PatchMapping

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

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

圖片

@ControllerAdvice

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

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

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

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

圖片

@ResponseBody

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

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

圖片

@ExceptionHandler

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

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

圖片

@ResponseStatus

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

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

圖片

@PathVariable

复制@PathVariable注解是將方法中的參數(shù)綁定到請求URI中的模板變量上?？梢酝ㄟ^复制@RequestMapping注解來指定URI的模板變量，然后使用复制@PathVariable注解將方法中的參數(shù)綁定到模板變量上。

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

圖片

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

下面是一個(gè)簡寫的示例：

圖片

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

@RequestParam

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

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

圖片

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

圖片

@Controller

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

圖片

@RestController

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

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

圖片

@ModelAttribute

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

圖片

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

圖片

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

圖片

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

@CrossOrigin

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

圖片

@InitBinder

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

圖片