通过属性禁用Spring配置：解决Aerospike与MariaDB配置冲突

我开发了一个可根据配置属性切换Aerospike或MariaDB连接的库，包含以下两个配置类：

Aerospike配置类 #

@Configuration(proxyBeanMethods = false)
@ConditionalOnProperty(prefix = "aerospike", name = "enabled", havingValue = "true", matchIfMissing = true)
public class AerospikeConfiguration {
}

MariaDB配置类 #

@Configuration(proxyBeanMethods = false)
@ConditionalOnProperty(prefix = "mariadb", name = "enabled", havingValue = "true")
public class MariadbConfiguration {
}

主自动配置类 #

@Configuration
@EnableConfigurationProperties
@Import({
        AerospikeConfiguration.class, MariadbConfiguration.class, // and other
})
public class MainAutoConfiguration {
}

单独使用Aerospike时运行正常，但引入MariaDB及其依赖后，即使未启用MariaDB（未配置mariadb.enabled=true），也会因Spring Boot自动尝试创建dataSource Bean但缺少必要属性（如spring.datasource.url）导致启动失败。

我不想通过添加空的spring.datasource.url属性来规避问题，之前尝试的方案未解决：

• 为AerospikeConfiguration添加@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class, HibernateJpaAutoConfiguration.class})，但与MainAutoConfiguration出现循环@Import错误。
• 在客户端应用的@SpringBootApplication中添加exclude配置，但要求客户端做额外配置不合理。

请问如何修改现有配置解决该冲突？

方案1：让MariaDB配置类按需引入DataSource自动配置 #

修改MariadbConfiguration，仅在MariaDB启用时导入DataSource相关自动配置，确保这些配置不会在Aerospike模式下触发：

@Configuration(proxyBeanMethods = false)
@ConditionalOnProperty(prefix = "mariadb", name = "enabled", havingValue = "true")
@Import({
        DataSourceAutoConfiguration.class,
        DataSourceTransactionManagerAutoConfiguration.class,
        HibernateJpaAutoConfiguration.class
})
public class MariadbConfiguration {
    // 可在此添加MariaDB自定义配置，比如数据源属性绑定
}

同时，确保你的库的META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中，不直接引入上述DataSource相关自动配置类，完全由MariadbConfiguration控制加载时机。

方案2：用自动配置注解控制排除与启用 #

修改MainAutoConfiguration默认排除DataSource相关配置：

@Configuration
@EnableConfigurationProperties
@Import({
        AerospikeConfiguration.class, MariadbConfiguration.class // and other
})
@AutoConfigureExclude({
        DataSourceAutoConfiguration.class,
        DataSourceTransactionManagerAutoConfiguration.class,
        HibernateJpaAutoConfiguration.class
})
public class MainAutoConfiguration {
}

然后在MariadbConfiguration中重新启用这些配置：

@Configuration(proxyBeanMethods = false)
@ConditionalOnProperty(prefix = "mariadb", name = "enabled", havingValue = "true")
@AutoConfigureInclude({
        DataSourceAutoConfiguration.class,
        DataSourceTransactionManagerAutoConfiguration.class,
        HibernateJpaAutoConfiguration.class
})
public class MariadbConfiguration {
}

方案3：自定义条件控制DataSource自动配置加载 #

创建自定义条件类，仅当mariadb.enabled=true时允许DataSource配置生效：

public class MariadbEnabledCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Environment env = context.getEnvironment();
        return Boolean.parseBoolean(env.getProperty("mariadb.enabled", "false"));
    }
}

在库的META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中，给DataSource相关配置绑定该条件：

org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration=your.package.MariadbEnabledCondition
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration=your.package.MariadbEnabledCondition
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration=your.package.MariadbEnabledCondition

让DataSource相关的Spring Boot自动配置仅在明确启用MariaDB时才加载，而非引入依赖就自动触发。全程由库内部配置控制，不需要客户端应用做额外操作。

内容的提问来源于stack exchange，提问作者gad_gadskiy