學習和應用 Spring Boot 有一些時間了,你們對 Spring Boot 注解了解有多少呢?今天棧長我給大家整理了 Spring Boot 最核心的 25 個注解,都是幹貨!
你所需具備的基礎
什麼是 Spring Boot?
Spring Boot 核心配置檔案詳解
Spring Boot 開啟的 2 種方式
Spring Boot 自動配置原理、實戰
Spring Boot 2.x 啟動全過程源碼分析
Java 必須掌握的 12 種 Spring 常用注解!
更多請在Java技術棧微信公衆号背景回複關鍵字:boot。
Spring Boot 最核心的 25 個注解
1、@SpringBootApplication
這是 Spring Boot 最最最核心的注解,用在 Spring Boot 主類上,辨別這是一個 Spring Boot 應用,用來開啟 Spring Boot 的各項能力。
其實這個注解就是 @SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan 這三個注解的組合,也可以用這三個注解來代替 @SpringBootApplication 注解。
2、@EnableAutoConfiguration
允許 Spring Boot 自動配置注解,開啟這個注解之後,Spring Boot 就能根據目前類路徑下的包或者類來配置 Spring Bean。
如:目前類路徑下有 Mybatis 這個 JAR 包,MybatisAutoConfiguration 注解就能根據相關參數來配置 Mybatis 的各個 Spring Bean。
3、@Configuration
這是 Spring 3.0 添加的一個注解,用來代替 applicationContext.xml 配置檔案,所有這個配置檔案裡面能做到的事情都可以通過這個注解所在類來進行注冊。
4、@SpringBootConfiguration
這個注解就是 @Configuration 注解的變體,隻是用來修飾是 Spring Boot 配置而已,或者可利于 Spring Boot 後續的擴充。
5、@ComponentScan
這是 Spring 3.1 添加的一個注解,用來代替配置檔案中的 component-scan 配置,開啟元件掃描,即自動掃描包路徑下的 @Component 注解進行注冊 bean 執行個體到 context 中。
前面 5 個注解可以在這篇文章《Spring Boot 最核心的 3 個注解詳解》中了解更多細節的。
6、@Conditional
這是 Spring 4.0 添加的新注解,用來辨別一個 Spring Bean 或者 Configuration 配置檔案,當滿足指定的條件才開啟配置。
7、@ConditionalOnBean
組合 @Conditional 注解,當容器中有指定的 Bean 才開啟配置。
8、@ConditionalOnMissingBean
組合 @Conditional 注解,和 @ConditionalOnBean 注解相反,當容器中沒有指定的 Bean 才開啟配置。
9、@ConditionalOnClass
組合 @Conditional 注解,當容器中有指定的 Class 才開啟配置。
10、@ConditionalOnMissingClass
組合 @Conditional 注解,和 @ConditionalOnMissingClass 注解相反,當容器中沒有指定的 Class 才開啟配置。
11、@ConditionalOnWebApplication
組合 @Conditional 注解,目前項目類型是 WEB 項目才開啟配置。
目前項目有以下 3 種類型。
enum Type {
/**
* Any web application will match.
*/
ANY,
/**
* Only servlet-based web application will match.
*/
SERVLET,
/**
* Only reactive-based web application will match.
*/
REACTIVE
}
12、@ConditionalOnNotWebApplication
組合 @Conditional 注解,和 @ConditionalOnWebApplication 注解相反,目前項目類型不是 WEB 項目才開啟配置。
13、@ConditionalOnProperty
組合 @Conditional 注解,當指定的屬性有指定的值時才開啟配置。
14、@ConditionalOnExpression
組合 @Conditional 注解,當 SpEL 表達式為 true 時才開啟配置。
15、@ConditionalOnJava
組合 @Conditional 注解,當運作的 Java JVM 在指定的版本範圍時才開啟配置。
16、@ConditionalOnResource
組合 @Conditional 注解,當類路徑下有指定的資源才開啟配置。
17、@ConditionalOnJndi
組合 @Conditional 注解,當指定的 JNDI 存在時才開啟配置。
18、@ConditionalOnCloudPlatform
組合 @Conditional 注解,當指定的雲平台激活時才開啟配置。
19、@ConditionalOnSingleCandidate
組合 @Conditional 注解,當指定的 class 在容器中隻有一個 Bean,或者同時有多個但為首選時才開啟配置。
20、@ConfigurationProperties
用來加載額外的配置(如 .properties 檔案),可用在 @Configuration 注解類,或者 @Bean 注解方法上面。
關于這個注解的用法可以參考《
Spring Boot讀取配置的幾種方式》這篇文章。
21、@EnableConfigurationProperties
一般要配合 @ConfigurationProperties 注解使用,用來開啟對 @ConfigurationProperties 注解配置 Bean 的支援。
22、@AutoConfigureAfter
用在自動配置類上面,表示該自動配置類需要在另外指定的自動配置類配置完之後。
如 Mybatis 的自動配置類,需要在資料源自動配置類之後。
@AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisAutoConfiguration {
23、@AutoConfigureBefore
這個和 @AutoConfigureAfter 注解使用相反,表示該自動配置類需要在另外指定的自動配置類配置之前。
24、@Import
這是 Spring 3.0 添加的新注解,用來導入一個或者多個 @Configuration 注解修飾的類,這在 Spring Boot 裡面應用很多。
25、@ImportResource
這是 Spring 3.0 添加的新注解,用來導入一個或者多個 Spring 配置檔案,這對 Spring Boot 相容老項目非常有用,因為有些配置無法通過 Java Config 的形式來配置就隻能用這個注解來導入。