Master Spring Boot Auto-Configuration: 6 Essential Annotation Patterns

Introduction

Many articles describe how to integrate various components with Spring Boot, but they often miss the underlying patterns. This guide focuses on the core concepts and practical steps needed to understand and customize Spring Boot auto‑configuration.

Spring Boot Version

The examples are based on Spring Boot 2.3.4.RELEASE.

1. Locate the Auto‑Configuration Class

When integrating a component, Spring Boot adds a starter dependency, such as mybatis-spring-boot-starter:

<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>2.0.0</version>
</dependency>

Each starter provides an auto‑configuration class named xxxAutoConfiguration, e.g., MybatisAutoConfiguration, RedisAutoConfiguration, or WebMvcAutoConfiguration.

2. Pay Attention to @Conditionalxxx Annotations

The @Conditionalxxx annotation on a configuration class or method defines the conditions under which the auto‑configuration is applied. For example, WebMvcAutoConfiguration uses:

@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)

This means the configuration is active only when WebMvcConfigurationSupport is absent in the IoC container. Similarly, methods can combine @Bean with @ConditionalOnMissingBean to provide default beans that developers can override by defining their own instances.

Example from MybatisAutoConfiguration:

@Bean
@ConditionalOnMissingBean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {}

If a SqlSessionFactory bean is already present, this method is skipped, allowing custom implementations.

3. Understand @EnableConfigurationProperties

The @EnableConfigurationProperties annotation activates @ConfigurationProperties -annotated classes, binding properties with a specific prefix from application.yml or application.properties. For instance, RedisAutoConfiguration includes:

@EnableConfigurationProperties(RedisProperties.class)

The corresponding RedisProperties class defines fields such as host, port, password, etc., which are populated from the spring.redis.* namespace.

4. Use @Import to Bring in Additional Configurations

The @Import annotation imports one or more configuration classes into the IoC container. Examples:

@Import(RabbitAnnotationDrivenConfiguration.class)

and

@Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class })

This mechanism is essential when a component relies on multiple sub‑configurations, such as choosing between Lettuce and Jedis for Redis connections.

5. Control Loading Order with @AutoConfigurexxx Annotations

Annotations like @AutoConfigureAfter, @AutoConfigureBefore, and @AutoConfigureOrder dictate the sequence of auto‑configuration classes. For example, MybatisAutoConfiguration declares:

@AutoConfigureAfter(DataSourceAutoConfiguration.class)

This ensures the data source is configured before MyBatis attempts to initialize.

6. Beware of Internal Static Configuration Classes

Some auto‑configuration classes contain nested static configuration classes that hold additional bean definitions. WebMvcAutoConfiguration includes nested classes such as WebMvcAutoConfigurationAdapter, EnableWebMvcConfiguration, and ResourceChainCustomizerConfiguration. Even if the outer class appears simple, its inner classes can provide substantial functionality.

Conclusion

The six patterns above—locating auto‑configuration classes, handling @Conditionalxxx, enabling configuration properties, importing additional configurations, managing loading order, and inspecting internal static classes—form a systematic approach to mastering Spring Boot component integration without relying on ad‑hoc searches.