스프링 부트 자동 구성 (Auto Configuration)

스프링 부트는 개발자의 편의를 위해 자동 구성(Auto Configuration)이라는 강력한 기능을 제공합니다. 이를 통해 자주 사용하는 많은 빈들을 자동으로 등록해주어, 반복적이고 복잡한 설정을 최소화하고 빠르게 애플리케이션 개발을 시작할 수 있습니다. 이번 글에서는 자동 구성이 어떻게 동작하는지 예제를 통해 살펴보겠습니다.

 

자동 구성 알아보기

스프링 부트는 spring-boot-autoconfigure 프로젝트 안에서 수많은 자동 구성을 제공합니다. 예를 들어, JdbcTemplate을 설정하고 빈으로 등록해주는 자동 구성을 확인해보겠습니다.

 

JdbcTemplateAutoConfiguration

package org.springframework.boot.autoconfigure.jdbc;

import javax.sql.DataSource;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.sql.init.dependency.DatabaseInitializationDependencyConfigurer;
import org.springframework.context.annotation.Import;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;

@AutoConfiguration(after = DataSourceAutoConfiguration.class)
@ConditionalOnClass({ DataSource.class, JdbcTemplate.class })
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(JdbcProperties.class)
@Import({ DatabaseInitializationDependencyConfigurer.class, JdbcTemplateConfiguration.class, NamedParameterJdbcTemplateConfiguration.class })
public class JdbcTemplateAutoConfiguration {
}

 

위 코드를 통해 자동 구성이 어떻게 이루어지는지 살펴보겠습니다.

1. @AutoConfiguration: 자동 구성을 사용하려면 이 애노테이션을 등록해야 합니다. 이는 내부에 @Configuration이 있어 빈을 등록하는 자바 설정 파일로 사용할 수 있습니다.
2. after = DataSourceAutoConfiguration.class: 자동 구성이 실행되는 순서를 지정합니다. JdbcTemplate은 DataSource가 필요하기 때문에 DataSourceAutoConfiguration 다음에 실행되도록 설정되어 있습니다.
3. @ConditionalOnClass({ DataSource.class, JdbcTemplate.class }): 특정 클래스가 존재할 때만 설정이 동작하도록 합니다. 만약 해당 클래스들이 없으면 설정이 무효화되고, 빈도 등록되지 않습니다.

@Import의 대상이 되는 JdbcTemplateConfiguration를 추가로 확인해보겠습니다.

JdbcTemplateConfiguration

package org.springframework.boot.autoconfigure.jdbc;

import javax.sql.DataSource;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Primary;
import org.springframework.jdbc.core.JdbcOperations;
import org.springframework.jdbc.core.JdbcTemplate;

@Configuration(proxyBeanMethods = false) 
@ConditionalOnMissingBean(JdbcOperations.class)
class JdbcTemplateConfiguration {
    @Bean
    @Primary
    JdbcTemplate jdbcTemplate(DataSource dataSource, JdbcProperties properties) {
        JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
        JdbcProperties.Template template = properties.getTemplate();
        jdbcTemplate.setFetchSize(template.getFetchSize());
        jdbcTemplate.setMaxRows(template.getMaxRows());
        if (template.getQueryTimeout() != null) {
            jdbcTemplate.setQueryTimeout((int) template.getQueryTimeout().getSeconds());
        }
        return jdbcTemplate;
    }
}

 

위 설정에서는 JdbcTemplate이 빈으로 등록되는 과정을 보여줍니다.

1. @Configuration: 자바 설정 파일로 사용됩니다.
2. @ConditionalOnMissingBean(JdbcOperations.class): JdbcOperations 빈이 없을 때 동작합니다. 즉, JdbcTemplate이 이미 빈으로 등록되어 있지 않은 경우에만 동작합니다. 이를 통해 중복 등록 문제를 방지할 수 있습니다.

 

자동 등록 설정

다음 자동 구성 기능들이 빈들을 등록해줍니다.

• JdbcTemplateAutoConfiguration: JdbcTemplate
• DataSourceAutoConfiguration: DataSource
• DataSourceTransactionManagerAutoConfiguration: TransactionManager

따라서 개발자가 직접 빈을 등록하지 않아도 JdbcTemplate, DataSource, TransactionManager가 스프링 빈으로 등록됩니다.

 

용어 설명

• 자동 설정(Auto Configuration): 빈들을 자동으로 등록하여 스프링이 동작하는 환경을 자동으로 설정해주는 것.
• 자동 구성(Auto Configuration): 스프링 실행에 필요한 빈들을 적절하게 배치해주는 것.

 

[참조]

스프링 부트 - 핵심 원리와 활용