springboot-@Enablexxx原理

为什么会写这篇？@EnableConfigurationProperties 看名字很容易被误解成为引入某个properties文件。但其实不是，这个是开启某种配置 ，真正的是 Enable 某个@ConfigurationProperties注解的类
这篇从代码角度看下@EnableAutoConfiguration的流程。

1. springboot里有许多的@Enablexxxx，比如

• @EnableConfigurationProperties
• @EnableAutoConfiguration
• @EnableWebMvc

2. @EnableConfigurationProperties的代码流程

很简单的例子

public class Demo3BootStrap {
    public static void main(String[] args) {
  AnnotationConfigApplicationContext context = new      AnnotationConfigApplicationContext(Demo3Configuration.class);
   }
}

@Configuration
@EnableConfigurationProperties
@EnableAutoConfiguration
@Import({SecurityConfigration.class,BeanDefinitionRegistrar.class,BeanImportSelector.class})
public class Demo3Configuration {
}

可以看到Demo3Configuration上加了@EnableConfigurationProperties，下面从代码角度分析下这个做了什么

@Import(EnableConfigurationPropertiesImportSelector.class)
public @interface EnableConfigurationProperties {

	/**
	 * Convenient way to quickly register {@link ConfigurationProperties} annotated beans
	 * with Spring. Standard Spring Beans will also be scanned regardless of this value.
	 * @return {@link ConfigurationProperties} annotated beans to register
	 */
	Class<?>[] value() default {};

}

比较关键的是
@Import(EnableConfigurationPropertiesImportSelector.class),看org.springframework.context.annotation.Import这个annotaion:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {

	/**
	 * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar}
	 * or regular component classes to import.
	 */
	Class<?>[] value();

}

value()可以接受3种类型的参数，分别是

• Configuration
• ImportSelector
• ImportBeanDefinitionRegistrar

@Import(EnableConfigurationPropertiesImportSelector.class)里的value是个EnableConfigurationPropertiesImportSelector.class,看下

class EnableConfigurationPropertiesImportSelector 
implements ImportSelector {
  ...
}

是ImportSelector类型,只有1个方法selectImports ，选择器

public interface ImportSelector {
	String[] selectImports(AnnotationMetadata importingClassMetadata);
}

class EnableConfigurationPropertiesImportSelector implements ImportSelector {

private static final String[] IMPORTS = {			  ConfigurationPropertiesBeanRegistrar.class.getName(),			ConfigurationPropertiesBindingPostProcessorRegistrar.class.getName() };

//接受1个class类型的数组
public String[] selectImports(AnnotationMetadata metadata) {
		return IMPORTS;
}
...
}

很明显会进入ConfigurationPropertiesBeanRegistrar这个类，实现了ImportBeanDefinitionRegistrar接口只有一个方法，这个方法顾名思意就是加入一个beanDefinition

public static class ConfigurationPropertiesBeanRegistrar
			implements ImportBeanDefinitionRegistrar {
}

public interface ImportBeanDefinitionRegistrar {

		/**	
	 * @param importingClassMetadata annotation metadata of the importing class
	 * @param registry current bean definition registry
	 */
	public void registerBeanDefinitions(
			AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);

}

• AnnotationMetadata 指被@Import这个注解的类的annotaionMetaData
  比如
  
  @EnableConfigurationProperties 放在Demo3Configuration这个类上，则
  AnnotationMetadata则是这个类上所有的注解
  

public void registerBeanDefinitions(AnnotationMetadata metadata,
				BeanDefinitionRegistry registry) {
			//	getTypes(metadata)上获取到的value的集合，然后进行注册
			getTypes(metadata).forEach((type) -> register(registry,
					(ConfigurableListableBeanFactory) registry, type));
		}

		//获取到metadata上是否有@EnableConfigurationProperties，有的话返回
		EnableConfigurationProperties.value()
		private List<Class<?>> getTypes(AnnotationMetadata metadata) {
			MultiValueMap<String, Object> attributes = metadata
					.getAllAnnotationAttributes(
							EnableConfigurationProperties.class.getName(), false);
			return collectClasses(attributes == null ? Collections.emptyList()
					: attributes.get("value"));
		}

由于我们的例子里的@EnableConfigurationProperties没加任何东西，所以value为空

可以找个比较熟悉的类如下

    @Configuration
	@Import(EnableWebMvcConfiguration.class)
	@EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
	public static class WebMvcAutoConfigurationAdapter
			implements WebMvcConfigurer, ResourceLoaderAware {
	 ...
	}

@EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })可以看出这个注解里有个class,这2个将会被register成为2个bean definition,看其中的一个类

@ConfigurationProperties(prefix = "spring.mvc")
public class WebMvcProperties {
 	...
	private Locale locale;
}

由于将WebMvcProperties加载成为了一个beandefinition.
我们可以在application.properties里修改比如

spring.mvc.locale=zh_CN

@EnableConfigurationProperties 不要将其理解成引入某个properties文件。

3. 自己写个 Enablexxx的模块

了解了其原理后，就可以自己来写个enablexxx的东西，通过在@EnableXXX进行使用