一文了解SpringBoot 自动化配置

自动化配置的意义

Spring Boot的一大优势就是自动化配置，省去了传统模式下繁琐的配置过程。同时，还有另外一个重要意义，就是实现了组件的“自治”，即组件的配置选项以及依赖的其他组件、资源等，由其自行管理，进而才能实现“积木化”的组件拼装与整合。

自动化配置如何启用

要启用自动化配置，需要在应用级别添加一个注解@EnableAutoConfiguration，并且只需添加一次。对于SpringBoot项目，我们通常会在主程序的启动类上，添加注解@SpringBootApplication，这个注解实际已经内置了注解@EnableAutoConfiguration，因此就不需要再额外添加了。或者说，自动化配置功能，实际已经通过@SpringBootApplication隐含开启了，只是我们平常没有注意到这个细节而已。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
………
}

通过条件注解灵活控制

问题与挑战

前面说过，自动化配置实现了组件的“自治”，由组件自行管理配置项，以及依赖的其他组件、资源等。当多个组件进行拼装与整合时，则面临一个新的挑战，不同组件配置项与依赖项，可能会重复，不需要也不应该重复加载，并且还可能存在冲突，这问题如何解决呢？

对于该问题，SpringBoot提供了一系列条件注解来解决。条件注解可用于修饰@Configuration类或@Bean方法，表示只有满足指定条件时，被修饰的配置类或配置方法才会生效。
下面按照使用频率从高到低一一介绍。

Bean对象

@ConditionalOnBean 当指定的Bean存在
@ConditionalOnMissingBean 当指定的Bean不存在
@ConditionalOnSingleCandidate当指定Bean在容器中只有一个，或者虽然有多个但是指定了首选Bean

	@Configuration(proxyBeanMethods = false)
	@ConditionalOnBean(DataSource.class)
	@ConditionalOnClass(DatabasePopulator.class)
	static class DataSourceInitializerConfiguration {

		@Bean
		@ConditionalOnMissingBean
		BatchDataSourceInitializer batchDataSourceInitializer(DataSource dataSource,
				@BatchDataSource ObjectProvider<DataSource> batchDataSource, ResourceLoader resourceLoader,
				BatchProperties properties) {
			return new BatchDataSourceInitializer(batchDataSource.getIfAvailable(() -> dataSource), resourceLoader,
					properties);
		}

	}

当DataSource的Bean存在时，才会执行数据源的初始化配置。

属性

@ConditionalOnProperty用于检查特定属性是否具有指定的属性值。

	@Bean(name = "rabbitListenerContainerFactory")
	@ConditionalOnMissingBean(name = "rabbitListenerContainerFactory")
	@ConditionalOnProperty(prefix = "spring.rabbitmq.listener", name = "type", havingValue = "simple",
			matchIfMissing = true)
	SimpleRabbitListenerContainerFactory simpleRabbitListenerContainerFactory(
			SimpleRabbitListenerContainerFactoryConfigurer configurer, ConnectionFactory connectionFactory) {
		SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
		configurer.configure(factory, connectionFactory);
		return factory;
	}

当系统配置文件 properties或.yml中存在属性
spring.rabbitmq.listener，并且包含simple键值时才生效。

Class类

@ConditionalOnClass 指定的类存在
@ConditionalOnMissingClass 指定的类不存在
需要注意的是，这里指的是项目中是否有某一个类，而不是容器中是否有该类。

/**
 * Redis connection configuration using Lettuce.
 *
 * @author Mark Paluch
 * @author Andy Wilkinson
 */
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(RedisClient.class)
class LettuceConnectionConfiguration extends RedisConnectionConfiguration {

	LettuceConnectionConfiguration(RedisProperties properties,
			ObjectProvider<RedisSentinelConfiguration> sentinelConfigurationProvider,
			ObjectProvider<RedisClusterConfiguration> clusterConfigurationProvider) {
		super(properties, sentinelConfigurationProvider, clusterConfigurationProvider);
	}

	@Bean(destroyMethod = "shutdown")
	@ConditionalOnMissingBean(ClientResources.class)
	DefaultClientResources lettuceClientResources() {
		return DefaultClientResources.create();
	}
}

存在RedisClient类时，才进行Lettuce的配置。

资源

@ConditionalOnResource 指定的资源必须存在
使用该注解时只需指定resources属性。

@ConditionalOnResource(resources = "${spring.info.build.location:classpath:META-INF/build-info.properties}")
	@ConditionalOnMissingBean
	@Bean
	public BuildProperties buildProperties() throws Exception {
		return new BuildProperties(
				loadFrom(this.properties.getBuild().getLocation(), "build", this.properties.getBuild().getEncoding()));
	}

web应用及类型

@ConditionalOnWebApplication 要求当前应用必须是Web应用
使用该注解时可通过type属性进一步限定Web应用的类型，该属性支持如下三个枚举值。
➢ SERVLET：基于Servlet的Web应用时（Spring MVC）
➢ REACTIVE：反应式Web应用时（Spring WebFlux）
➢ ANY：任何Web应用时，即以上两种情况

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(WebSecurityConfigurerAdapter.class)
@ConditionalOnMissingBean(WebSecurityConfigurerAdapter.class)
@ConditionalOnWebApplication(type = Type.SERVLET)
public class SpringBootWebSecurityConfiguration {

	@Configuration(proxyBeanMethods = false)
	@Order(SecurityProperties.BASIC_AUTH_ORDER)
	static class DefaultConfigurerAdapter extends WebSecurityConfigurerAdapter {

	}

}

不常用

其他不常用条件注解，仅做了解，某些特定场景下还是有大作用，例如判断目标平台的java版本。
@ConditionalOnExpression 要求指定SpEL表达式的值为true
@ConditionalOnJava 对目标平台的Java版本进行检测，它既可要求目标平台的Java版本是某个具体的版本，也可要求其高于或低于某个版本
@ConditionalOnNotWebApplication 要求当前应用不是Web应用
@ConditionalOnWarDeployment 要求当前应用以传统WAR包方式被部署到Web服务器或应用服务器中时（不以独立Java程序的方式运行）