1. 程式人生 > >【API知識】SpringBoot專案中@EnableXXX的原理

【API知識】SpringBoot專案中@EnableXXX的原理

@EnableXX註解的使用場景

SpringBoot為開發人員提供了很多便利,例如如果想要定時功能,只要新增@EnableSchedule,即可配合@Schedule註解實現定時任務功能,不需要額外配置定時任務的處理執行緒,就可以直接使用(框架提供預設配置,在找不到使用者自定配置的執行器時,使用預設配置)

@EnableXXX註解給人的感覺就是有一個"開關",只要開關開啟就可以對應的功能,非常方便。

有時候,我們可能也想實現一個功能,打包釋出後,其他專案只要引入依賴,新增@Enable註解就可以直接使用。

那麼@EnableXXX的原理是什麼呢?

個人認為@Enable的核心就是將XXX配置引入到當前容器內,而這個操作就由@Import註解來完成,@Import引入的類,一般是配置類,該配置類可能會使用兩種方式引入相關的Bean

①在配置類中使用@Bean構造相關的Bean

②使用@ComponentScan掃描指定路徑,引入Bean。

這些Bean就用於提供XXX功能。

那如果是這樣,直接使用@Import就好了,幹嘛還需要@EnableXXX?

直接使用@Import確實夠了,但是@EnableXXX有兩個好處

①可以整合多個配置,便於記憶。例如要提供XXX功能,可能需要@Import多個配置類

②內容封裝且使用者友好。使用者不需要知道使用XXX功能需要引入哪些配置。直接@Enable就好了。

簡單案例

@Enable提供health介面

//project 1
@Target({java.lang.annotation.ElementType.TYPE})
@Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
@Documented
@Import({HealthConfig.class}) //指明引入HealthConfig類
public @interface EnableHealth {

}

@Configuration
@ComponentScan({"com.test.controller"}) //掃描當前專案的controller
public class HealthConfig {

}

@RestController
public class HealthController { //提供health介面

    @GetMapping("/health")
    public String health() {
        return "{\"status\":\"UP\"}";
    }
}

//project2
@EnableHealth //開啟health功能,最終將HealthController注入到當前容器中
@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

1)project1是一個普通的maven專案,封裝一個Health功能。

2)project2就是一個普通的SpringBoot專案,只要引入project1依賴,並使用@EnableHealth即可提供health介面

3)project1專案中需要使用Spring的註解,需要引入spring依賴,這可能與project2的版本不同,故project1的spring相關依賴的scope可以指定為provided,由外部提