Spring Boot 最核心的 25 個註解，都是乾貨！

Java技術棧發表於2019-02-26
Spring Boot

學習和應用 Spring Boot 有一些時間了，你們對 Spring Boot 註解瞭解有多少呢？今天棧長我給大家整理了 Spring Boot 最核心的 25 個註解，都是乾貨！

你所需具備的基礎

更多請在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 的形式來配置就只能用這個註解來匯入。

好了，終於總結完了，花了棧長我 2 個小時。。。另外，關注微信公眾號Java技術棧，在後臺回覆關鍵字：boot, 可以獲取棧長整理的更多 Spring Boot 系列教程文章。

本文原創首發於微信公眾號：Java技術棧（id:javastack），關注公眾號在後臺回覆 “boot” 可獲取更多，轉載請原樣保留本資訊。

相關文章