【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，由外部提供。