Java技術(shù)棧
www.javastack.cn
優(yōu)秀的Java技術(shù)公眾號(hào)
學(xué)習(xí)和應(yīng)用 Spring Boot 有一些時(shí)間了挤安,你們對(duì) Spring Boot 注解了解有多少呢?今天棧長(zhǎng)我給大家整理了 Spring Boot 最核心的 25 個(gè)注解笼才,都是干貨漱受!
你所需具備的基礎(chǔ)
更多請(qǐng)?jiān)贘ava技術(shù)棧微信公眾號(hào)后臺(tái)回復(fù)關(guān)鍵字:boot昂羡。
Spring Boot 最核心的 25 個(gè)注解
1、@SpringBootApplication
這是 Spring Boot 最最最核心的注解摔踱,用在 Spring Boot 主類(lèi)上虐先,標(biāo)識(shí)這是一個(gè) Spring Boot 應(yīng)用,用來(lái)開(kāi)啟 Spring Boot 的各項(xiàng)能力派敷。
其實(shí)這個(gè)注解就是@SpringBootConfiguration
蛹批、@EnableAutoConfiguration
、@ComponentScan
這三個(gè)注解的組合篮愉,也可以用這三個(gè)注解來(lái)代替 @SpringBootApplication
注解腐芍。
2、@EnableAutoConfiguration
允許 Spring Boot 自動(dòng)配置注解试躏,開(kāi)啟這個(gè)注解之后猪勇,Spring Boot 就能根據(jù)當(dāng)前類(lèi)路徑下的包或者類(lèi)來(lái)配置 Spring Bean。
如:當(dāng)前類(lèi)路徑下有 Mybatis 這個(gè) JAR 包颠蕴,MybatisAutoConfiguration
注解就能根據(jù)相關(guān)參數(shù)來(lái)配置 Mybatis 的各個(gè) Spring Bean泣刹。
3助析、@Configuration
這是 Spring 3.0 添加的一個(gè)注解,用來(lái)代替 applicationContext.xml 配置文件椅您,所有這個(gè)配置文件里面能做到的事情都可以通過(guò)這個(gè)注解所在類(lèi)來(lái)進(jìn)行注冊(cè)外冀。
4、@SpringBootConfiguration
這個(gè)注解就是 @Configuration 注解的變體掀泳,只是用來(lái)修飾是 Spring Boot 配置而已雪隧,或者可利于 Spring Boot 后續(xù)的擴(kuò)展。
5开伏、@ComponentScan
這是 Spring 3.1 添加的一個(gè)注解膀跌,用來(lái)代替配置文件中的 component-scan 配置,開(kāi)啟組件掃描固灵,即自動(dòng)掃描包路徑下的 @Component 注解進(jìn)行注冊(cè) bean 實(shí)例到 context 中。
前面 5 個(gè)注解可以在這篇文章《Spring Boot 最核心的 3 個(gè)注解詳解》中了解更多細(xì)節(jié)的劫流。
6巫玻、@Conditional
這是 Spring 4.0 添加的新注解,用來(lái)標(biāo)識(shí)一個(gè) Spring Bean 或者 Configuration 配置文件祠汇,當(dāng)滿(mǎn)足指定的條件才開(kāi)啟配置仍秤。
7、@ConditionalOnBean
組合 @Conditional
注解可很,當(dāng)容器中有指定的 Bean 才開(kāi)啟配置诗力。
8、@ConditionalOnMissingBean
組合 @Conditional
注解我抠,和 @ConditionalOnBean
注解相反苇本,當(dāng)容器中沒(méi)有指定的 Bean 才開(kāi)啟配置。
9菜拓、@ConditionalOnClass
組合 @Conditional
注解瓣窄,當(dāng)容器中有指定的 Class 才開(kāi)啟配置。
10纳鼎、@ConditionalOnMissingClass
組合 @Conditional
注解俺夕,和 @ConditionalOnMissingClass
注解相反,當(dāng)容器中沒(méi)有指定的 Class 才開(kāi)啟配置贱鄙。
11劝贸、@ConditionalOnWebApplication
組合 @Conditional
注解,當(dāng)前項(xiàng)目類(lèi)型是 WEB 項(xiàng)目才開(kāi)啟配置逗宁。
當(dāng)前項(xiàng)目有以下 3 種類(lèi)型映九。
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)目類(lèi)型不是 WEB 項(xiàng)目才開(kāi)啟配置践叠。
13、@ConditionalOnProperty
組合 @Conditional
注解嚼蚀,當(dāng)指定的屬性有指定的值時(shí)才開(kāi)啟配置禁灼。
14、@ConditionalOnExpression
組合 @Conditional
注解轿曙,當(dāng) SpEL 表達(dá)式為 true 時(shí)才開(kāi)啟配置弄捕。
15、@ConditionalOnJava
組合 @Conditional
注解导帝,當(dāng)運(yùn)行的 Java JVM 在指定的版本范圍時(shí)才開(kāi)啟配置守谓。
16、@ConditionalOnResource
組合 @Conditional
注解您单,當(dāng)類(lèi)路徑下有指定的資源才開(kāi)啟配置斋荞。
17、@ConditionalOnJndi
組合 @Conditional
注解虐秦,當(dāng)指定的 JNDI 存在時(shí)才開(kāi)啟配置平酿。
18、@ConditionalOnCloudPlatform
組合 @Conditional
注解悦陋,當(dāng)指定的云平臺(tái)激活時(shí)才開(kāi)啟配置蜈彼。
19、@ConditionalOnSingleCandidate
組合 @Conditional
注解俺驶,當(dāng)指定的 class 在容器中只有一個(gè) Bean幸逆,或者同時(shí)有多個(gè)但為首選時(shí)才開(kāi)啟配置。
20暮现、@ConfigurationProperties
用來(lái)加載額外的配置(如 .properties 文件)还绘,可用在 @Configuration
注解類(lèi),或者@Bean
注解方法上面送矩。
關(guān)于這個(gè)注解的用法可以參考《Spring Boot讀取配置的幾種方式》這篇文章蚕甥。
21、@EnableConfigurationProperties
一般要配合 @ConfigurationProperties
注解使用栋荸,用來(lái)開(kāi)啟對(duì)@ConfigurationProperties
注解配置 Bean 的支持菇怀。
22、@AutoConfigureAfter
用在自動(dòng)配置類(lèi)上面晌块,表示該自動(dòng)配置類(lèi)需要在另外指定的自動(dòng)配置類(lèi)配置完之后爱沟。
如 Mybatis 的自動(dòng)配置類(lèi),需要在數(shù)據(jù)源自動(dòng)配置類(lèi)之后匆背。
@AutoConfigureAfter(DataSourceAutoConfiguration.class)public class MybatisAutoConfiguration {
23呼伸、@AutoConfigureBefore
這個(gè)和 @AutoConfigureAfter
注解使用相反,表示該自動(dòng)配置類(lèi)需要在另外指定的自動(dòng)配置類(lèi)配置之前。
24括享、@Import
這是 Spring 3.0 添加的新注解搂根,用來(lái)導(dǎo)入一個(gè)或者多個(gè) @Configuration
注解修飾的類(lèi),這在 Spring Boot 里面應(yīng)用很多铃辖。
25剩愧、@ImportResource
這是 Spring 3.0 添加的新注解,用來(lái)導(dǎo)入一個(gè)或者多個(gè) Spring 配置文件娇斩,這對(duì) Spring Boot 兼容老項(xiàng)目非常有用仁卷,因?yàn)橛行┡渲脽o(wú)法通過(guò) Java Config 的形式來(lái)配置就只能用這個(gè)注解來(lái)導(dǎo)入。