Spring Boot 最核心的 25 個註解

Spring Boot 最核心的 25 個註解

一、@SpringBootApplication

這是 Spring Boot 最最最核心的註解，用在 Spring Boot 主類上，標識這是一個 Spring Boot 應用，用來開啓 Spring Boot 的各項能力。

其實這個註解就是 @SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan 這三個註解的組合，也能夠用這三個註解來代替 @SpringBootApplication 註解。

二、@EnableAutoConfiguration

容許 Spring Boot 自動配置註解，開啓這個註解以後，Spring Boot 就能根據當前類路徑下的包或者類來配置 Spring Bean。

如：當前類路徑下有 Mybatis 這個 JAR 包，MybatisAutoConfiguration 註解就能根據相關參數來配置 Mybatis 的各個 Spring Bean。

三、@Configuration

這是 Spring 3.0 添加的一個註解，用來代替 applicationContext.xml 配置文件，全部這個配置文件裏面能作到的事情均可以經過這個註解所在類來進行註冊。

四、@SpringBootConfiguration

這個註解就是 @Configuration 註解的變體，只是用來修飾是 Spring Boot 配置而已，或者可利於 Spring Boot 後續的擴展。

五、@ComponentScan

這是 Spring 3.1 添加的一個註解，用來代替配置文件中的 component-scan 配置，開啓組件掃描，即自動掃描包路徑下的 @Component 註解進行註冊 bean 實例到 context 中。

前面 5 個註解能夠在這篇文章《Spring Boot 最核心的 3 個註解詳解》中瞭解更多細節的。

六、@Conditional

這是 Spring 4.0 添加的新註解，用來標識一個 Spring Bean 或者 Configuration 配置文件，當知足指定的條件纔開啓配置。

七、@ConditionalOnBean

組合 @Conditional 註解，當容器中有指定的 Bean 纔開啓配置。

八、@ConditionalOnMissingBean

組合 @Conditional 註解，和 @ConditionalOnBean 註解相反，當容器中沒有指定的 Bean 纔開啓配置。

九、@ConditionalOnClass

組合 @Conditional 註解，當容器中有指定的 Class 纔開啓配置。

十、@ConditionalOnMissingClass

組合 @Conditional 註解，和 @ConditionalOnMissingClass 註解相反，當容器中沒有指定的 Class 纔開啓配置。

十一、@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

}

十二、@ConditionalOnNotWebApplication

組合 @Conditional 註解，和 @ConditionalOnWebApplication 註解相反，當前項目類型不是 WEB 項目纔開啓配置。

1三、@ConditionalOnProperty

組合 @Conditional 註解，當指定的屬性有指定的值時纔開啓配置。

1四、@ConditionalOnExpression

組合 @Conditional 註解，當 SpEL 表達式爲 true 時纔開啓配置。

1五、@ConditionalOnJava

組合 @Conditional 註解，當運行的 Java JVM 在指定的版本範圍時纔開啓配置。

1六、@ConditionalOnResource

組合 @Conditional 註解，當類路徑下有指定的資源纔開啓配置。

1七、@ConditionalOnJndi

組合 @Conditional 註解，當指定的 JNDI 存在時纔開啓配置。

1八、@ConditionalOnCloudPlatform

組合 @Conditional 註解，當指定的雲平臺激活時纔開啓配置。

1九、@ConditionalOnSingleCandidate

組合 @Conditional 註解，當指定的 class 在容器中只有一個 Bean，或者同時有多個但爲首選時纔開啓配置。

20、@ConfigurationProperties

用來加載額外的配置（如 .properties 文件），可用在 @Configuration 註解類，或者 @Bean 註解方法上面。

關於這個註解的用法能夠參考《
Spring Boot讀取配置的幾種方式》這篇文章。

2一、@EnableConfigurationProperties

通常要配合 @ConfigurationProperties 註解使用，用來開啓對 @ConfigurationProperties 註解配置 Bean 的支持。

2二、@AutoConfigureAfter

用在自動配置類上面，表示該自動配置類須要在另外指定的自動配置類配置完以後。

如 Mybatis 的自動配置類，須要在數據源自動配置類以後。

@AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisAutoConfiguration {

2三、@AutoConfigureBefore

這個和 @AutoConfigureAfter 註解使用相反，表示該自動配置類須要在另外指定的自動配置類配置以前。

2四、@Import

這是 Spring 3.0 添加的新註解，用來導入一個或者多個 @Configuration 註解修飾的類，這在 Spring Boot 裏面應用不少。

2五、@ImportResource

這是 Spring 3.0 添加的新註解，用來導入一個或者多個 Spring 配置文件，這對 Spring Boot 兼容老項目很是有用，由於有些配置沒法經過 Java Config 的形式來配置就只能用這個註解來導入。

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