40 個 SpringBoot 常用注解，你知道幾個？

一、Spring Web MVC 與 Spring Bean 注解

Spring Web MVC 注解

@RequestMapping

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

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

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

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

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

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

@RequestBody

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

下面是一個使用@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請求，并將請求映射到對應(yīng)的處理方法中。@PatchMapping相當于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。

下面是一個簡單的示例：

@ControllerAdvice

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

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

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

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

@ResponseBody

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

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

@ExceptionHandler

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

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

@ResponseStatus

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

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

@PathVariable

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

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

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

下面是一個簡寫的示例：

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

@RequestParam

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

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

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

@Controller

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

Spring

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

@RestController

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

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

@ModelAttribute

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

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

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

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

@CrossOrigin

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

@InitBinder

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

二、Spring Bean 注解

在本小節(jié)中，主要列舉與Spring Bean相關(guān)的4個注解以及它們的使用方式。

@ComponentScan

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

@Component

@Component注解用于標注一個普通的組件類，它沒有明確的業(yè)務(wù)范圍，只是通知Spring被此注解的類需要被納入到Spring Bean容器中并進行管理。此注解的使用示例如下：

@Service

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

@Repository

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

三、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時，可以設(shè)置Bean的scope屬性為prototype：scope=“prototype”,也可以使用@Scope注解設(shè)置，如下：

@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)

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

@Scope?單例模式

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

四、容器配置注解

@Autowired

@Autowired注解用于標記Spring將要解析和注入的依賴項。此注解可以作用在構(gòu)造函數(shù)、字段和setter方法上。

作用于構(gòu)造函數(shù)

下面是@Autowired注解標注構(gòu)造函數(shù)的使用示例：

作用于setter方法

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

作用于字段

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

@Primary

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

輸出結(jié)果：

this?is?send?DingDing?method?message.

@PostConstruct與@PreDestroy

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

@Qualifier

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

五、Spring Boot注解

@SpringBootApplication

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

在Spring Boot應(yīng)用程序的主類中，就使用了此注解。示例代碼如下：

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

@EnableAutoConfiguration

@EnableAutoConfiguration注解用于通知Spring，根據(jù)當前類路徑下引入的依賴包，自動配置與這些依賴包相關(guān)的配置項。

@ConditionalOnClass與@ConditionalOnMissingClass

這兩個注解屬于類條件注解，它們根據(jù)是否存在某個類作為判斷依據(jù)來決定是否要執(zhí)行某些配置。下面是一個簡單的示例代碼：

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

@ConditionalOnBean與@ConditionalOnMissingBean

這兩個注解屬于對象條件注解，根據(jù)是否存在某個對象作為依據(jù)來決定是否要執(zhí)行某些配置方法。示例代碼如下：

@Bean
@ConditionalOnBean(name="dataSource")
LocalContainerEntityManagerFactoryBean?entityManagerFactory(){
?//...
}
@Bean
@ConditionalOnMissingBean
public?MyBean?myBean(){
?//...
}

@ConditionalOnProperty

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

@Bean
@ConditionalOnProperty(name="alipay",havingValue="on")
Alipay?alipay(){
?return?new?Alipay();
}

@ConditionalOnResource

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

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

@ConditionalOnWebApplication與@ConditionalOnNotWebApplication

這兩個注解用于判斷當前的應(yīng)用程序是否是Web應(yīng)用程序。如果當前應(yīng)用是Web應(yīng)用程序，則使用Spring WebApplicationContext,并定義其會話的生命周期。下面是一個簡單的示例：

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

@ConditionalExpression

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

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

@Conditional

@Conditional注解可以控制更為復(fù)雜的配置條件。在Spring內(nèi)置的條件控制注解不滿足應(yīng)用需求的時候，可以使用此注解定義自定義的控制條件，以達到自定義的要求。下面是使用該注解的簡單示例：

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

總結(jié)

本次課程總結(jié)了Spring Boot中常見的各類型注解的使用方式，讓大家能夠統(tǒng)一的對Spring Boot常用注解有一個全面的了解。

由于篇幅的原因，關(guān)于Spring Boot不常用的一些注解，將在下一次分享中進行補充和說明。