新聞中心
在 Spring Boot開發(fā)過程中,我們經(jīng)常會看到使用 @EnableXXX來激活我們某一個功能性的模塊,通過類注解激活后我們就能使用所激活的配置給我們帶來的功能。

創(chuàng)新互聯(lián)公司服務(wù)項目包括蘆山網(wǎng)站建設(shè)、蘆山網(wǎng)站制作、蘆山網(wǎng)頁制作以及蘆山網(wǎng)絡(luò)營銷策劃等。多年來,我們專注于互聯(lián)網(wǎng)行業(yè),利用自身積累的技術(shù)優(yōu)勢、行業(yè)經(jīng)驗、深度合作伙伴關(guān)系等,向廣大中小型企業(yè)、政府機構(gòu)等提供互聯(lián)網(wǎng)行業(yè)的解決方案,蘆山網(wǎng)站推廣取得了明顯的社會效益與經(jīng)濟效益。目前,我們服務(wù)的客戶以成都為中心已經(jīng)輻射到蘆山省份的部分城市,未來相信會繼續(xù)擴大服務(wù)區(qū)域并繼續(xù)獲得客戶的支持與信任!
今天我們就來探究一下這個 @EnableXXX給我們做了哪些工作,或者我們應(yīng)該怎么通過自定義的方式開發(fā)我們自己的功能模塊。
演示環(huán)境
- IntelliJ IDEA 2020.2.1 (Community Edition)
- Maven 3.5.4
- Spring Boot 2.1.1.RELEASE
走進源碼
在 SpringBoot中 @Enable的實現(xiàn)方式用兩種。
一種是注解驅(qū)動的方式,我們以 @EnableWebMvc為例進行探究;
另外一種是接口編程的方式,我們以 @EnableCaching為例進行探究。
1、注解驅(qū)動方式(@EnableWebMvc)
在 Spring Boot項目中,當我們可以使用 @EnableWebMvc注解用來激活我們的 Spring MVC相關(guān)的配置,接下來進入源碼一探究竟。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}
通過觀察上面的源碼,我們就可以大膽的猜測,其實使用 @EnableWebMvc注解的作用就是導(dǎo)入 DelegatingWebMvcConfiguration.class這個類,接下來我們就進入這個類看看。
@Configuration
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
........
@Override
protected void addInterceptors(InterceptorRegistry registry) {
this.configurers.addInterceptors(registry);
}
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
this.configurers.addResourceHandlers(registry);
}
........
}
進入到這個類中我們發(fā)現(xiàn)了這個 @Configuration注解,到這兒我們好像明白了寫什么。首先這個 DelegatingWebMvcConfiguration類繼承了 WebMvcConfigurationSupport類,重寫了里面的關(guān)于 WebMvc的相關(guān)配置,然后作為一個配置類加載到我們的 Spring容器中。至此來實現(xiàn)啟動(激活)WebMvc模塊。
2、接口編程的方式(@EnableCaching)
在 Spring Boot項目中,當我們可以使用 @EnableCaching注解用來激活我們的緩存相關(guān)的配置,接著進入源碼看看到底做了什么。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(CachingConfigurationSelector.class)
public @interface EnableCaching {
boolean proxyTargetClass() default false;
AdviceMode mode() default AdviceMode.PROXY;
int order() default Ordered.LOWEST_PRECEDENCE;
}
這里 @EnableCaching同樣是使用 @Import導(dǎo)入了一個配置類,而它導(dǎo)入的是 CachingConfigurationSelector,接著我進入這個類看一看。
public class CachingConfigurationSelector extends AdviceModeImportSelector{
.....
@Override
public String[] selectImports(AdviceMode adviceMode) {
switch (adviceMode) {
case PROXY:
return getProxyImports();
case ASPECTJ:
return getAspectJImports();
default:
return null;
}
}
.....
}
發(fā)現(xiàn)其實這個類沒有被注解標注,但是它繼承了 AdviceModeImportSelector
public interface ImportSelector {
/**
* Select and return the names of which class(es) should be imported based on
* the {@link AnnotationMetadata} of the importing @{@link Configuration} class.
*/
String[] selectImports(AnnotationMetadata importingClassMetadata);
}
這個類中只用一個方法,那就是 selectImports。也就是說當我們重寫了這個方法之后,我們可以在方法中添加自己的邏輯判斷,來決定最后導(dǎo)入哪些配置類。這樣就可以實現(xiàn)靈活的加載配置。這個方法的返回值 String[]里面存放的是所有復(fù)合條件的配置類的全路徑信息。
自定義實現(xiàn)
通過上面的分析我們已經(jīng)完成了對 @EnableXXX套路的了解,接下來我們自己動手實現(xiàn)下。首先需要準備一個 Spirng Boot的項目,這里我已經(jīng)準備好了。
1、注解驅(qū)動方式的自定義實現(xiàn)
根據(jù)我們分析源碼的步驟我們首先需要準備一個配置類。接下來在 configuration包下,創(chuàng)建一個 HelloConfiguration。代碼如下:
/**
* Hello模塊的配置
*/
@Configuration
public class HelloConfiguration {
@Bean
public String hello() { // method name is bean name
System.out.println("Bean : hello is loading.");
return "hello word !";
}
}
這里被 @Bean標注的方法,方法名會作為 bean對象的名稱。而且當該 bean被加載的時候我們還會在控制臺輸出一段話 Bean : hello is loading.。
配置類我們已經(jīng)準備好了,接下來我們在 annotation包中編寫激活配置的注解。
/**
* 激活Hello模塊配置
*
* @author Jerome Zhu
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(HelloConfiguration.class) // 模塊裝配:注解驅(qū)動實現(xiàn)
public @interface EnableHello {
}
最后我們在 bootstrap包中編寫驗證我們 @EnableHello模塊的啟動類。
/**
* 驗證自定義 {@link EnableHello} 模塊化裝配
*
* @author Jerome Zhu
*/
@EnableHello
public class EnableHelloBootstrap {
public static void main(String[] args) {
ConfigurableApplicationContext context = new SpringApplicationBuilder(EnableHelloBootstrap.class)
.web(WebApplicationType.NONE)
.run(args);
String helloBean = context.getBean("hello", String.class);
System.out.println("hello Bean: " + helloBean);
context.close();
}
}
我們在我們啟動類上標注了 @EnableHello來激活我們的 Hello模塊,并且在 Spring Boot項目啟動后,獲取到了應(yīng)用的上下文 ConfigurableApplicationContext。然后我們根據(jù)我們注入的 bean的名字 hello來獲取 bean,接著打印 bean的內(nèi)容,最后關(guān)閉上下文。
我們啟動程序后,可以在控制臺中看到這樣兩行輸出:
Bean : hello is loading.
hello Bean: hello word !
這剛好就是我們配置的內(nèi)容,到這兒我們就完成了基于注解驅(qū)動方式激活(啟動)配置。
2、接口編程方式自定義實現(xiàn)
根據(jù)我們讀過源碼后,我們首先最重要的是有一個繼承 ImportSelector的實現(xiàn)類。在 annotation包中創(chuàng)建一個 HelloImportSelector配置類。
/**
* Hello {@link ImportSelector} 的實現(xiàn)
*/
public class HelloImportSelector implements ImportSelector {
private final String key = "jerome";
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
if ("jerome".equals(key)) {
return new String[]{HelloJeromeConfiguration.class.getName()};
}
return new String[]{HelloConfiguration.class.getName()};
}
}
這里為了體現(xiàn)出 selectImports方法的作用,我們在本類中添加一個 key字段。當 key的值為 jerome的時候我們?nèi)ゼ虞d HelloJeromeConfiguration這個配置類。首先看一個這個配置類的內(nèi)容。
/**
* Hello模塊的配置
*
* @author Jerome Zhu
*/
@Configuration
public class HelloJeromeConfiguration {
@Bean
public String hello() { // method name is bean name
System.out.println("Bean : hello is loading.");
return "hello jerome !";
}
}
加載這個配置類后 bean的名字還是 hello但是內(nèi)容變成了 hello jerome !。接著我們對 @EnableHello注解進行改造改造成 @EnableHellos。
/**
* 激活Hellos模塊配置
*
* @author Jerome Zhu
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(HelloImportSelector.class) // 模塊裝配:接口驅(qū)動實現(xiàn) 優(yōu)點可選bean
public @interface EnableHellos {
}
這里使用了 HelloImportSelector來實現(xiàn)我們的模塊裝配。
這里 @EnableHellos可能不符合命名規(guī)范,這里只做演示使用,不要噴我。
最后我們在 bootstrap包中編寫驗證我們 @EnableHello模塊的啟動類。
/**
* 驗證自定義 {@link EnableHellos} 模塊化裝配
*
* @author Jerome Zhu
*/
@EnableHellos
public class EnableHellosBootstrap {
public static void main(String[] args) {
ConfigurableApplicationContext context = new SpringApplicationBuilder(EnableHellosBootstrap.class)
.web(WebApplicationType.NONE)
.run(args);
String helloBean = context.getBean("hello", String.class);
System.out.println("hello Bean: " + helloBean);
context.close();
}
}
這里和基于注解驅(qū)動方式激活(啟動)配置的驗證方法一樣,我就是直接拷貝的,主要修改了 @EnableHellos這個激活注解。
我們啟動程序后,可以在控制臺中看到這樣兩行輸出:
Bean : hello is loading.
hello Bean: hello jerome !
這剛好就是我們配置的內(nèi)容,到這兒我們就完成了基于接口編程方式激活(啟動)配置。
總結(jié)
我們通過上面了解了 @EnableXXX的兩種實現(xiàn)方式。其中基于注解驅(qū)動方式激活(啟動)配置的方式是相對方便的一個實現(xiàn),需要激活什么就直接導(dǎo)入該配置類即可;而基于接口編程方式激活(啟動)配置的方式相對更加靈活,可以根據(jù)自定義的規(guī)則來選擇激活哪些配置類,不激活哪些配置類,這是一種比較靈活的方式,方便我們對其進行擴展。
總之這兩種方式都是手動激活的方式,換言之我們需要在啟動類上添加 @Enable***的注解,來手動激活配置,這種方式在某些場景并不是很方便。
分享標題:SpringBoot手動配置@Enable的秘密
標題路徑:http://m.fisionsoft.com.cn/article/ccisige.html


咨詢
建站咨詢
