40 個 SpringBoot 常用註解

一、Spring Web MVC 與 Spring Bean 註解

Spring Web MVC 註解

@RequestMapping

@RequestMapping 註解的主要用途是將 Web 請求與請求處理類中的方法進行映射。Spring MVC 和 Spring WebFlux 都通過RquestMappingHandlerMapping和RequestMappingHndlerAdapter兩個類來提供對 @RequestMapping 註解的支持。

@RequestMapping註解對請求處理類中的請求處理方法進行標註；@RequestMapping註解擁有以下的六個配置屬性：

提示：在使用 @RequestMapping 之前，請求處理類還需要使用 @Controller 或 @RestController 進行標記

下面是使用 @RequestMapping 的兩個示例：

圖片

@RequestMapping 還可以對類進行標記，這樣類中的處理方法在映射請求路徑時，會自動將類上 @RequestMapping 設置的 value 拼接到方法中映射路徑之前，如下：

圖片

@RequestBody

@RequestBody 在處理請求方法的參數列表中使用，它可以將請求主體中的參數綁定到一個對象中，請求主體參數是通過HttpMessageConverter傳遞的，根據請求主體中的參數名與對象的屬性名進行匹配並綁定值。此外，還可以通過 @Valid 註解對請求主體中的參數進行校驗。

下面是一個使用@RequestBody的示例：

圖片

@GetMapping

@GetMapping註解用於處理 HTTP GET 請求，並將請求映射到具體的處理方法中。具體來說，@GetMapping 是一個組合註解，它相當於是@RequestMapping(method=RequestMethod.GET)的快捷方式。

下面是@GetMapping的一個使用示例：

圖片

@PostMapping

@PostMapping註解用於處理 HTTP POST 請求，並將請求映射到具體的處理方法中。@PostMapping 與 @GetMapping 一樣，也是一個組合註解，它相當於是@RequestMapping(method=HttpMethod.POST)的快捷方式。

下面是使用@PostMapping的一個示例：

圖片

@PutMapping

@PutMapping註解用於處理 HTTP PUT 請求，並將請求映射到具體的處理方法中，@PutMapping 是一個組合註解，相當於是@RequestMapping(method=HttpMethod.PUT)的快捷方式。

下面是使用@PutMapping的一個示例：

圖片

@DeleteMapping

@DeleteMapping註解用於處理 HTTP DELETE 請求，並將請求映射到刪除方法中。@DeleteMapping 是一個組合註解，它相當於是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。

下面是使用@DeleteMapping的一個示例：

圖片

@PatchMapping

@PatchMapping註解用於處理 HTTP PATCH 請求，並將請求映射到對應的處理方法中。@PatchMapping 相當於是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。

下面是一個簡單的示例：

圖片

@ControllerAdvice

@ControllerAdvice是 @Component 註解的一個延伸註解，Spring 會自動掃描並檢測被 @ControllerAdvice 所標註的類。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute註解搭配使用，主要是用來處理控制器所拋出的異常信息。

首先，我們需要定義一個被@ControllerAdvice所標註的類，在該類中，定義一個用於處理具體異常的方法，並使用 @ExceptionHandler 註解進行標記。

此外，在有必要的時候，可以使用@InitBinder在類中進行全局的配置，還可以使用 @ModelAttribute 配置與視圖相關的參數。使用@ControllerAdvice註解，就可以快速的創建統一的，自定義的異常處理類。

下面是一個使用@ControllerAdvice的示例代碼：

圖片

@ResponseBody

@ResponseBody會自動將控制器中方法的返回值寫入到 HTTP 響應中。特別的，@ResponseBody註解只能用在被@Controller註解標記的類中。如果在被@RestController標記的類中，則方法不需要使用@ResponseBody註解進行標註。@RestController相當於是@Controller和@ResponseBody的組合註解。

下面是使用該註解的一個示例

圖片

@ExceptionHandler

@ExceptionHander註解用於標註處理特定類型異常類所拋出異常的方法。當控制器中的方法拋出異常時，Spring 會自動捕獲異常，並將捕獲的異常信息傳遞給被@ExceptionHandler標註的方法。

下面是使用該註解的一個示例：

圖片

@ResponseStatus

@ResponseStatus註解可以標註請求處理方法。使用此註解，可以指定響應所需要的 HTTP STATUS。特別地，我們可以使用 HttpStauts 類對該註解的 value 屬性進行賦值。

下面是使用@ResponseStatus註解的一個示例：

圖片

@PathVariable

@PathVariable註解是將方法中的參數綁定到請求 URI 中的模板變量上。可以通過@RequestMapping註解來指定 URI 的模板變量，然後使用@PathVariable註解將方法中的參數綁定到模板變量上。

特別地，@PathVariable註解允許我們使用 value 或 name 屬性來給參數取一個別名。下面是使用此註解的一個示例：

圖片

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

下面是一個簡寫的示例：

圖片

提示：如果參數是一個非必須的，可選的項，則可以在@PathVariable中設置require = false

@RequestParam

@RequestParam註解用於將方法的參數與 Web 請求的傳遞的參數進行綁定。使用@RequestParam可以輕鬆的訪問 HTTP 請求參數的值。

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

圖片

該註解的其他屬性配置與@PathVariable的配置相同，特別的，如果傳遞的參數爲空，還可以通過 defaultValue 設置一個默認值。示例代碼如下：

圖片

@Controller

@Controller是@Component註解的一個延伸，

Spring

會自動掃描並配置被該註解標註的類。此註解用於標註 Spring MVC 的控制器。下面是使用此註解的示例代碼：

圖片

@RestController

@RestController是在 Spring 4.0 開始引入的，這是一個特定的控制器註解。此註解相當於@Controller和@ResponseBody的快捷方式。當使用此註解時，不需要再在方法上使用@ResponseBody註解。

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

圖片

@ModelAttribute

通過此註解，可以通過模型索引名稱來訪問已經存在於控制器中的 model。下面是使用此註解的一個簡單示例：

圖片

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

圖片

特別地，如果使用@ModelAttribute對方法進行標註，Spring 會將方法的返回值綁定到具體的 Model 上。示例如下：

圖片

在 Spring 調用具體的處理方法之前，被@ModelAttribute註解標註的所有方法都將被執行。

@CrossOrigin

@CrossOrigin註解將爲請求處理類或請求處理方法提供跨域調用支持。如果我們將此註解標註類，那麼類中的所有方法都將獲得支持跨域的能力。使用此註解的好處是可以微調跨域行爲。使用此註解的示例如下：

圖片

@InitBinder

@InitBinder註解用於標註初始化 WebDataBinider 的方法，該方法用於對 Http 請求傳遞的表單數據進行處理，如時間格式化、字符串處理等。下面是使用此註解的示例：

圖片

二、Spring Bean 註解

在本小節中，主要列舉與 Spring Bean 相關的 4 個註解以及它們的使用方式。

@ComponentScan

@ComponentScan註解用於配置 Spring 需要掃描的被組件註解註釋的類所在的包。可以通過配置其 basePackages 屬性或者 value 屬性來配置需要掃描的包路徑。value 屬性是 basePackages 的別名。此註解的用法如下：

@Component

@Component 註解用於標註一個普通的組件類，它沒有明確的業務範圍，只是通知 Spring 被此註解的類需要被納入到 Spring Bean 容器中並進行管理。此註解的使用示例如下：

圖片

@Service

@Service註解是@Component的一個延伸（特例），它用於標註業務邏輯類。與@Component註解一樣，被此註解標註的類，會自動被 Spring 所管理。下面是使用@Service註解的示例：

圖片

@Repository

@Repository註解也是@Component註解的延伸，與@Component註解一樣，被此註解標註的類會被 Spring 自動管理起來，@Repository註解用於標註 DAO 層的數據持久化類。此註解的用法如下：

圖片

三、Spring Dependency Inject 與 Bean Scops 註解

Spring DI 註解

@DependsOn

@DependsOn註解可以配置 Spring IoC 容器在初始化一個 Bean 之前，先初始化其他的 Bean 對象。下面是此註解使用示例代碼：

圖片

@Bean

@Bean 註解主要的作用是告知 Spring，被此註解所標註的類將需要納入到 Bean 管理工廠中。@Bean 註解的用法很簡單，在這裏，着重介紹 @Bean 註解中initMethod和destroyMethod的用法。示例如下：

圖片

Scops 註解

@Scope

@Scope 註解可以用來定義 @Component 標註的類的作用範圍以及 @Bean 所標記的類的作用範圍。@Scope 所限定的作用範圍有：singleton、prototype、request、session、globalSession或者其他的自定義範圍。這裏以 prototype 爲例子進行講解。

當一個 Spring Bean 被聲明爲 prototype（原型模式）時，在每次需要使用到該類的時候，Spring IoC 容器都會初始化一個新的改類的實例。在定義一個 Bean 時，可以設置 Bean 的 scope 屬性爲prototype：scope=“prototype”, 也可以使用 @Scope 註解設置，如下：

@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)

下面將給出兩種不同的方式來使用 @Scope 註解，示例代碼如下：

圖片

@Scope 單例模式

當 @Scope 的作用範圍設置成 Singleton 時，被此註解所標註的類只會被 Spring IoC 容器初始化一次。在默認情況下，Spring IoC 容器所初始化的類實例都爲 singleton。同樣的原理，此情形也有兩種配置方式，示例代碼如下：

圖片

四、容器配置註解

@Autowired

@Autowired 註解用於標記 Spring 將要解析和注入的依賴項。此註解可以作用在構造函數、字段和 setter 方法上。

作用於構造函數

下面是 @Autowired 註解標註構造函數的使用示例：

圖片

作用於 setter 方法

下面是 @Autowired 註解標註 setter 方法的示例代碼：

圖片

作用於字段

@Autowired 註解標註字段是最簡單的，只需要在對應的字段上加入此註解即可，示例代碼如下：

圖片

@Primary

當系統中需要配置多個具有相同類型的 bean 時，@Primary 可以定義這些 Bean 的優先級。下面將給出一個實例代碼來說明這一特性：

圖片

輸出結果：

this is send DingDing method message.

@PostConstruct 與 @PreDestroy

值得注意的是，這兩個註解不屬於 Spring, 它們是源於 JSR-250 中的兩個註解，位於common-annotations.jar中。@PostConstruct 註解用於標註在 Bean 被 Spring 初始化之前需要執行的方法。@PreDestroy 註解用於標註 Bean 被銷燬前需要執行的方法。下面是具體的示例代碼：

圖片

@Qualifier

當系統中存在同一類型的多個 Bean 時，@Autowired 在進行依賴注入的時候就不知道該選擇哪一個實現類進行注入。此時，我們可以使用 @Qualifier 註解來微調，幫助 @Autowired 選擇正確的依賴項。下面是一個關於此註解的代碼示例：

圖片

五、Spring Boot 註解

@SpringBootApplication

@SpringBootApplication註解是一個快捷的配置註解，在被它標註的類中，可以定義一個或多個 Bean，並自動觸發自動配置 Bean 和自動掃描組件。此註解相當於@Configuration、@EnableAutoConfiguration和@ComponentScan的組合。

在 Spring Boot 應用程序的主類中，就使用了此註解。示例代碼如下：

@SpringBootApplication
public class Application{
 public static void main(String [] args){
   SpringApplication.run(Application.class,args);
 }
}

@EnableAutoConfiguration

@EnableAutoConfiguration 註解用於通知 Spring，根據當前類路徑下引入的依賴包，自動配置與這些依賴包相關的配置項。

@ConditionalOnClass 與 @ConditionalOnMissingClass

這兩個註解屬於類條件註解，它們根據是否存在某個類作爲判斷依據來決定是否要執行某些配置。下面是一個簡單的示例代碼：

@Configuration
@ConditionalOnClass(DataSource.class)
class MySQLAutoConfiguration {
 //...
}

@ConditionalOnBean 與 @ConditionalOnMissingBean

這兩個註解屬於對象條件註解，根據是否存在某個對象作爲依據來決定是否要執行某些配置方法。示例代碼如下：

@Bean
@ConditionalOnBean()
LocalContainerEntityManagerFactoryBean entityManagerFactory(){
 //...
}
@Bean
@ConditionalOnMissingBean
public MyBean myBean(){
 //...
}

@ConditionalOnProperty

@ConditionalOnProperty 註解會根據 Spring 配置文件中的配置項是否滿足配置要求，從而決定是否要執行被其標註的方法。示例代碼如下：

@Bean
@ConditionalOnProperty()
Alipay alipay(){
 return new Alipay();
}

@ConditionalOnResource

此註解用於檢測當某個配置文件存在使，則觸發被其標註的方法，下面是使用此註解的代碼示例：

@ConditionalOnResource(resources = "classpath:website.properties")
Properties addWebsiteProperties(){
 //...
}

@ConditionalOnWebApplication 與 @ConditionalOnNotWebApplication

這兩個註解用於判斷當前的應用程序是否是 Web 應用程序。如果當前應用是 Web 應用程序，則使用 Spring WebApplicationContext, 並定義其會話的生命週期。下面是一個簡單的示例：

@ConditionalOnWebApplication
HealthCheckController healthCheckController(){
 //...
}

@ConditionalExpression

此註解可以讓我們控制更細粒度的基於表達式的配置條件限制。當表達式滿足某個條件或者表達式爲真的時候，將會執行被此註解標註的方法。

@Bean
@ConditionalException("${localstore} && ${local == 'true'}")
LocalFileStore store(){
 //...
}

@Conditional

@Conditional 註解可以控制更爲複雜的配置條件。在 Spring 內置的條件控制註解不滿足應用需求的時候，可以使用此註解定義自定義的控制條件，以達到自定義的要求。下面是使用該註解的簡單示例：

@Conditioanl(CustomConditioanl.class)
CustomProperties addCustomProperties(){
 //...
}

總結

本次課程總結了 Spring Boot 中常見的各類型註解的使用方式，讓大家能夠統一的對 Spring Boot 常用註解有一個全面的瞭解。

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/wXkQ5nTDGyOku1cXrw0Fuw

猜你喜歡