springBoot @Enable* 注解的使用

2024-07-14 08:41:10

字體：大中小

來源：轉載

供稿：網友

1、為什么使用@SpringBootApplication注解，即可做到自動配置？

答：@SpringBootApplication，內部起作用的注解其實有3個。@EnableAutoConfiguration，@ComponentScan，@Configuration。這篇文章主要是講解@EnableXX注解

2、為什么使用了@EnableAutoConfiguration。當使用了@ConfigurationProperties時，即可自動導入.yml 或者.properties里面的配置項？

答：在@EnableAutoConfiguration內部，使用了@Import注解。導入AutoConfigurationImportSelector幫助springBoot將符合條件的Configuration加載到IOC容器中。但是內部其實使用了SpringFactoriesLoader來完成。類似與java SPI的功能
，即從/META-INF/spring.factories加載配置

@Target({ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import({AutoConfigurationImportSelector.class})public @interface EnableAutoConfiguration

可以看到@Import中，其實是導入了一個AutoConfigurationImportSelector的類。最關鍵的是，該類實現了接口ImportSelector

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);}

這是ImportSelector的描述，大概意思就是，該方法返回的Bean 會自動的被注入，被Spring所管理。

接著來看 AutoConfigurationImportSelector中 selectImports 的實現

public String[] selectImports(AnnotationMetadata annotationMetadata) {  if(!this.isEnabled(annotationMetadata)) {   return NO_IMPORTS;  } else {   AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);   AnnotationAttributes attributes = this.getAttributes(annotationMetadata);   List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);   configurations = this.removeDuplicates(configurations);   Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);   this.checkExcludedClasses(configurations, exclusions);   configurations.removeAll(exclusions);   configurations = this.filter(configurations, autoConfigurationMetadata);   this.fireAutoConfigurationImportEvents(configurations, exclusions);   return StringUtils.toStringArray(configurations);  } }

代碼都寫得很清楚。就不解釋了。

在@Import中，可以看到有個鏈接指向了 ImportBeanDefinitionRegistrar。這同樣是一個接口，作用跟 ImportSelector 一樣。

public interface ImportBeanDefinitionRegistrar { public void registerBeanDefinitions(   AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);}

在registerBeanDefinitions方法中，可以用BeanDefinitionRegistry 注入我們想要注入的Bean。

代碼示例：

使用@Import編寫自己的@Enable

1、創建2個測試Bean

public class Role {}public class User {}

2、自定義Enable注解

@Target({ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Import(MyEnableAutoConfig.class)public @interface EnableBean {}

3、實現自己的EnableAutoConfiguration類

public class MyEnableAutoConfig implements ImportSelector{ @Override public String[] selectImports(AnnotationMetadata importingClassMetadata) {  return new String[]{"com.xhn2.Role","com.xhn2.User"}; }}

4、編寫啟動類

@EnableBean@ComponentScan("com.xhn2")public class Main { public static void main(String[] args) {  ConfigurableApplicationContext context = SpringApplication.run(Main.class, args);  System.out.println(context.getBean(User.class));  System.out.println(context.getBean(Role.class)); }}

5、運行結果

com.xhn2.User@496bc455
com.xhn2.Role@59402b8f

控制臺成功打印。

代碼示例2，自動裝配第3方jar包的Bean

新建maven工程

1、pom.xml

<modelVersion>4.0.0</modelVersion> <groupId>org.csp</groupId> <artifactId>hello</artifactId> <version>1.0.0</version> <properties>  <maven.compiler.source>1.8</maven.compiler.source>  <maven.compiler.target>1.8</maven.compiler.target>  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </properties> <dependencies>  <dependency>  <groupId>org.springframework</groupId>  <artifactId>spring-context</artifactId>  <version>4.3.17.RELEASE</version>  </dependency> </dependencies>

2、編寫Configuration

@Configurationpublic class MyTest { @Bean public Runnable runnable() {  return ()->{}; }}

在resources下新建META-INF/spring.factories文件，加入以下配置

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.edu.MyTest

3、將項目安裝到本地maven倉庫：mvn install

4、主工程引入剛才安裝到本地的jar。

<dependency>   <groupId>org.csp</groupId>   <artifactId>hello</artifactId>   <version>1.0.0</version>  </dependency>

5、獲取剛才配置的Runnable

@SpringBootApplicationpublic class Main { public static void main(String[] args) {  SpringApplication application = new SpringApplication(Main.class);  ConfigurableApplicationContext context = application.run(args);  System.out.println(context.getBean(Runnable.class)); }}

6、控制臺打印