是否可以在spring boot中从另一个自动配置类中禁用自动配置类?

时间:2018-05-23 16:39:37

标签: java spring spring-boot

我正在开发一个数据访问库,并希望能够以最小配置将其作为依赖项包含在其他项目中(理想情况下只需自动备份一个repo)。特别是,此库使用自动配置类(在spring.factories中启用)自行设置,并且需要禁用其他自动配置类(DataSourceAutoConfigurationHibernateJpaAutoConfiguration)。

是否可以在依赖项目之外执行此操作?

为了使配置尽可能简单,我想避免在依赖项目的@SpringBootApplication注释或其spring.autoconfigure.exclude属性中放置排除。

更新

在我的@Configuration上,我尝试添加注释:

@EnableAutoConfiguration(exclude={
    DataSourceAutoConfiguration.class,
    HibernateJpaAutoConfiguration.class})

这会导致

  

IllegalStateException:配置问题:循环@Import有   被发现

@ImportAutoConfiguration(exclude={
    DataSourceAutoConfiguration.class, 
    HibernateJpaAutoConfiguration.class})

哪个什么都不做。

2 个答案:

答案 0 :(得分:4)

有一个非常方便的接口叫AutoConfigurationImportFilter,它决定应该加载哪个自动配置。这也是@ConditionalOnClass注释的工作原理。

在您的资料库中,添加以下课程:

public class MyExclusionFilter
        implements AutoConfigurationImportFilter {

    private static final Set<String> SHOULD_SKIP = new HashSet<>(
            Arrays.asList("org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration",
                    "org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration"));

    @Override
    public boolean[] match(String[] classNames, AutoConfigurationMetadata metadata) {
        boolean[] matches = new boolean[classNames.length];

        for(int i = 0; i< classNames.length; i++) {
            matches[i] = !SHOULD_SKIP.contains(classNames[i]);
        }
        return matches;
    }
}

此类需要在spring.factories中注册才能工作。将库中的以下行添加到META-INF/spring.factories

org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=com.mycompany.db.MyExclusionFilter

您无需对依赖项目进行任何更改。只需将库添加为依赖项,就不会为整个应用程序加载您指定的自动配置。

注意:您可以添加多个导入过滤器,只会加载未在所有导入过滤器中过滤的自动配置类。

有关详细信息,请参阅org.springframework.boot.autoconfigure.AutoConfigurationImportSelector#filterorg.springframework.boot.autoconfigure.condition.OnClassCondition.java类的源代码。

答案 1 :(得分:0)

您可以通过

排除

@SpringBootApplication(exclude= {DataSourceAutoConfiguration.class, HibernateJpaAutoConfiguration.class}))

但您可以通过添加@Configuration将其排除在外 @EnableAutoConfiguration(exclude= {DataSourceAutoConfiguration.class, HibernateJpaAutoConfiguration.class})