SpringBoot自动配置中的条件化注解

最新推荐文章于 2025-05-22 08:34:28 发布

那些很冒险的梦丶

最新推荐文章于 2025-05-22 08:34:28 发布

阅读量1.2k

点赞数

CC 4.0 BY-SA版权

分类专栏： SpringBoot

本文链接：https://blog.youkuaiyun.com/qq360694660/article/details/80816113

SpringBoot 专栏收录该内容

9 篇文章

订阅专栏

本文介绍了SpringBoot中条件化配置的基本原理及其实现方式，包括如何通过自定义条件类来控制Bean的创建过程，以及SpringBoot如何利用条件化配置进行自动配置。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SpringBoot中有个名为spring-boot-autoconfigure的JAR文件，其中包含了很多配置类。每个配置类都在应用程序的Classpath里。都有机会为应用程序配置添砖加瓦，有用于Spring Data JPA的配置，有用于Spiring MVC的配置，

还有很多其他东西的配置。那么什么时候去使用这些配置类呢？

原因在于使用了Spring的条件化配置这是Spring 4.0引入的新特性。条件化配置允许配置类存在于应用程序中，并在在满足某些特定条件才会使用这个配置。

如何写自己的自定义条件呢？我们所要做的就是实现Condition接口覆盖它的matches()方法

比如：只有在Classpath里存在JdbcTemplate时，才去实例化Bean。

package com.example.studySpringBoot.condition;

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;

/**
 * Created by zjh on 2018/6/26.
 */
public class JDBCTemplateCondition implements Condition {
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        try {
            conditionContext.getClassLoader().loadClass("org.springframework.jdbc.core.JdbcTemplate");
            return true;
        } catch (ClassNotFoundException e) {
            return false;
        }
    }
}

package com.example.studySpringBoot.condition;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;

/**
 * Created by zjh on 2018/6/26.
 */
@Configuration
public class MyConditionClass {

    @Bean
    @Conditional(JDBCTemplateCondition.class)
    public ConditionBean initCondition(){
        System.out.println("init ConditionBean ~~~~~~");
        return new ConditionBean(1001,"test",18);
    }

}

Spring Boot基于Spring条件化配置定义了很多更有趣的条件，并把它们运用到了配置类上，这些配置类构成了Spring Boot的自动配置。Spring Boot运用条件化配置的方法是，定义多个特殊的条件化注解，并将它们用到配置类上。

当我们在.properties中配置以下信息，SpringBoot如何实现自动化配置数据源。

spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8

spring.datasource.username=root

spring.datasource.password=admin

对应数据源的配置类是DataSourceAutoConfiguration

@Configuration
@ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class })
@EnableConfigurationProperties(DataSourceProperties.class)
@Import({ Registrar.class, DataSourcePoolMetadataProvidersConfiguration.class })
public class DataSourceAutoConfiguration {

	private static final Log logger = LogFactory
			.getLog(DataSourceAutoConfiguration.class);

	@Bean
	@ConditionalOnMissingBean
	public DataSourceInitializer dataSourceInitializer() {
		return new DataSourceInitializer();
	}
        ......
}

DataSourceAutoConfiguration上添加了@ConditionalOnClass注解，要求Classpath里必须要有DataSource和EmbeddedDatabaseType。如果它们不存在，条件就不成立，DataSourceAutoConfiguration提供的配置都会被忽略掉。

dataSourceInitializer() 有@ConditionalOnMissingBean注解，没有配置DataSourceInitializer的Bean才会去实例化DataSourceInitializer Bean

.properties配置的Key是@EnableConfigurationProperties(DataSourceProperties.class)中的DataSourceProperties中定义的

@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties
		implements BeanClassLoaderAware, EnvironmentAware, InitializingBean {

	private ClassLoader classLoader;

	private Environment environment;
	/**
	 * Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.
	 */
	private String driverClassName;

	/**
	 * JDBC url of the database.
	 */
	private String url;

	/**
	 * Login user of the database.
	 */
	private String username;

	/**
	 * Login password of the database.
	 */
	private String password;

SpringBoot的自动化配置就是使用条件化注解去实现的。SpringBoot提供的自动化配置类全在Spring-boot-autoconfigure包下。