Spring Boot 最核心的 25 個(gè)注解
1、@SpringBootApplication
這是 Spring Boot 最最最核心的注解,用在 Spring Boot 主類上,標(biāo)識這是一個(gè) Spring Boot 應(yīng)用,用來開啟 Spring Boot 的各項(xiàng)能力。
其實(shí)這個(gè)注解就是@SpringBootConfiguration
、@EnableAutoConfiguration
、@ComponentScan
這三個(gè)注解的組合,也可以用這三個(gè)注解來代替 @SpringBootApplication
注解。
2、@EnableAutoConfiguration
允許 Spring Boot 自動配置注解,開啟這個(gè)注解之后,Spring Boot 就能根據(jù)當(dāng)前類路徑下的包或者類來配置 Spring Bean。
如:當(dāng)前類路徑下有 Mybatis 這個(gè) JAR 包,MybatisAutoConfiguration
注解就能根據(jù)相關(guān)參數(shù)來配置 Mybatis 的各個(gè) Spring Bean。
3、@Configuration
這是 Spring 3.0 添加的一個(gè)注解,用來代替 applicationContext.xml 配置文件,所有這個(gè)配置文件里面能做到的事情都可以通過這個(gè)注解所在類來進(jìn)行注冊。
4、@SpringBootConfiguration
這個(gè)注解就是 @Configuration 注解的變體,只是用來修飾是 Spring Boot 配置而已,或者可利于 Spring Boot 后續(xù)的擴(kuò)展。
5、@ComponentScan
這是 Spring 3.1 添加的一個(gè)注解,用來代替配置文件中的 component-scan 配置,開啟組件掃描,即自動掃描包路徑下的 @Component 注解進(jìn)行注冊 bean 實(shí)例到 context 中。
前面 5 個(gè)注解可以在這篇文章《Spring Boot 最核心的 3 個(gè)注解詳解》中了解更多細(xì)節(jié)的。
6、@Conditional
這是 Spring 4.0 添加的新注解,用來標(biāo)識一個(gè) Spring Bean 或者 Configuration 配置文件,當(dāng)滿足指定的條件才開啟配置。
7、@ConditionalOnBean
組合 @Conditional
注解,當(dāng)容器中有指定的 Bean 才開啟配置。
8、@ConditionalOnMissingBean
組合 @Conditional
注解,和 @ConditionalOnBean
注解相反,當(dāng)容器中沒有指定的 Bean 才開啟配置。
9、@ConditionalOnClass
組合 @Conditional
注解,當(dāng)容器中有指定的 Class 才開啟配置。
10、@ConditionalOnMissingClass
組合 @Conditional
注解,和 @ConditionalOnMissingClass
注解相反,當(dāng)容器中沒有指定的 Class 才開啟配置。
11、@ConditionalOnWebApplication
組合 @Conditional
注解,當(dāng)前項(xiàng)目類型是 WEB 項(xiàng)目才開啟配置。
當(dāng)前項(xiàng)目有以下 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
注解相反,當(dāng)前項(xiàng)目類型不是 WEB 項(xiàng)目才開啟配置。
13、@ConditionalOnProperty
組合 @Conditional
注解,當(dāng)指定的屬性有指定的值時(shí)才開啟配置。
14、@ConditionalOnExpression
組合 @Conditional
注解,當(dāng) SpEL 表達(dá)式為 true 時(shí)才開啟配置。
15、@ConditionalOnJava
組合 @Conditional
注解,當(dāng)運(yùn)行的 Java JVM 在指定的版本范圍時(shí)才開啟配置。
16、@ConditionalOnResource
組合 @Conditional
注解,當(dāng)類路徑下有指定的資源才開啟配置。
17、@ConditionalOnJndi
組合 @Conditional
注解,當(dāng)指定的 JNDI 存在時(shí)才開啟配置。
18、@ConditionalOnCloudPlatform
組合 @Conditional
注解,當(dāng)指定的云平臺激活時(shí)才開啟配置。
19、@ConditionalOnSingleCandidate
組合 @Conditional
注解,當(dāng)指定的 class 在容器中只有一個(gè) Bean,或者同時(shí)有多個(gè)但為首選時(shí)才開啟配置。
20、@ConfigurationProperties
用來加載額外的配置(如 .properties 文件),可用在 @Configuration
注解類,或者@Bean
注解方法上面。
關(guān)于這個(gè)注解的用法可以參考《Spring Boot讀取配置的幾種方式》這篇文章。
21、@EnableConfigurationProperties
一般要配合 @ConfigurationProperties
注解使用,用來開啟對@ConfigurationProperties
注解配置 Bean 的支持。
22、@AutoConfigureAfter
用在自動配置類上面,表示該自動配置類需要在另外指定的自動配置類配置完之后。
如 Mybatis 的自動配置類,需要在數(shù)據(jù)源自動配置類之后。
@AutoConfigureAfter(DataSourceAutoConfiguration.class)public class MybatisAutoConfiguration {
23、@AutoConfigureBefore
這個(gè)和 @AutoConfigureAfter
注解使用相反,表示該自動配置類需要在另外指定的自動配置類配置之前。
24、@Import
這是 Spring 3.0 添加的新注解,用來導(dǎo)入一個(gè)或者多個(gè) @Configuration
注解修飾的類,這在 Spring Boot 里面應(yīng)用很多。
25、@ImportResource
這是 Spring 3.0 添加的新注解,用來導(dǎo)入一個(gè)或者多個(gè) Spring 配置文件,這對 Spring Boot 兼容老項(xiàng)目非常有用,因?yàn)橛行┡渲脽o法通過 Java Config 的形式來配置就只能用這個(gè)注解來導(dǎo)入。
好了,終于總結(jié)完了,花了棧長我 2 個(gè)小時(shí)。。。另外,關(guān)注微信公眾號Java技術(shù)棧,在后臺回復(fù)關(guān)鍵字:boot, 可以獲取棧長整理的更多 Spring Boot 系列教程文章。
對以上有疑問或者對 Spring Boot 有不懂的都可以點(diǎn)擊文末閱讀原文鏈接加入棧長的知識星球,和棧長及更多 Java 技術(shù)人一起學(xué)習(xí)。