How to externalize @SpringBootApplication configuration?

Question

I want to externalize the @SpringBootApplication(exclude...) option, to have a reusable class or annotation that I could throw in to exclude any database/hibernate initialization.

So, instead of writing:

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

I would like to create a annotation that I could apply to my @SpringBootApplication main class:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@EnableAutoConfiguration(exclude = {
        DataSourceAutoConfiguration.class,
        DataSourceTransactionManagerAutoConfiguration.class,
        HibernateJpaAutoConfiguration.class})
@Configuration
public @interface ExcludeDataSources {
}

And then enable this feature by annotation:

@SpringBootApplication
@ExcludeDataSources
public class MainApp {
}

Problem: the annotation approach does not work, and spring still tries to load a database. Why?

My final goal is to have multiple startup classes, where only one loads the database.

@SpringBootApplication contains @EnableAutoConfiguration without excludes, I am not sure which annotation will be chosen by Spring's meta annotation logic, but I would replace @SpringBootApplication with its annotations (except @EnableAutoConfiguration of course) — Sankozi
– Sankozi, Commented Dec 7, 2021 at 14:14
Why not set the configuration property spring.autoconfigure.exclude to the list of auto-configuration classes to exclude? Set this configuration property inside a profile. — Chin Huang
– Chin Huang, Commented Dec 7, 2021 at 20:45
@ChinHuang because I don't run my application in different profiles (different jobs are triggered by program args). — membersound
– membersound, Commented Dec 8, 2021 at 8:43

membersound · Accepted Answer · 2021-12-07 15:38:00Z

2

I could manage it by adding an additional @EnableAutoConfiguration that is only executed on a certain condition. This way I can dynamically exclude the database config, while keeping a clean basis main @SpringBootConfiguration class.

public class DataSourceConfig {
    @Configuration
    @Conditional(MyCondition.class)
    @EnableAutoConfiguration(exclude = {
            DataSourceAutoConfiguration.class,
            DataSourceTransactionManagerAutoConfiguration.class,
            HibernateJpaAutoConfiguration.class})
    static class ExcludeDataSource {
    }
}

answered Dec 7, 2021 at 15:38

membersound

87.9k222 gold badges690 silver badges1.2k bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to externalize @SpringBootApplication configuration?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related