스프링 부트 Auto Configuration

 

0️⃣ 예제 프로젝트 생성 

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-jdbc'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'com.h2database:h2'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'

    //테스트에서 lombok 사용
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
}

예제 프로젝트를 생성할 때 Lombok, Spring Web, H2 Database, JDBC API 라이브러리를 사용하기 위해서 dependencies를 추가해줬다.

 

 

Member

@Data
public class Member
{
   private String memberId;
   private String name;
   
   public Member()
   {
   }
   
   public Member(String memberId, String name)
   {
      this.memberId = memberId;
      this.name = name;
   }
}

예제 프로젝트는 간단하게 회원을 생성하고 저장하며 조회하는 간단한 프로젝트로 Member 회원에는 memberId와 name 필드가 있는 객체이다. 

 

 

DbConfig

@Slf4j
@Configuration
public class DbConfig
{
   
   @Bean
   public DataSource dataSource()
   {
      log.info("dataSource 빈 등록");
      HikariDataSource dataSource = new HikariDataSource();
      dataSource.setDriverClassName("org.h2.Driver");
      dataSource.setJdbcUrl("jdbc:h2:mem:test");
      dataSource.setUsername("sa");
      dataSource.setPassword("");
      
      return dataSource;
   }
   
   @Bean
   public TransactionManager transactionManager()
   {
      log.info("transactionManager 빈 등록");
      return new JdbcTransactionManager(dataSource());
   }
   
   @Bean
   public JdbcTemplate jdbcTemplate()
   {
      log.info("jdbcTemplate 빈 등록");
      return new JdbcTemplate(dataSource());
   }
   
   
}

예제 프로젝트는 jdbcTemplate를 사용해서 회원 데이터를 저장하고 관리하는 기능이다. 

그리고 여기서는 직접 DataSource, TransactionManager, JdbcTemplate 을 스프링 빈으로 직접 등록한다. 

(JdbcTanscationManager는 DataSoureTransactionManager 와 같은 것으로 보면 되는데 JdbcTransactionManager는 기존에서 예외 변환 기능이 추가되었다.) 

 

 

MemberRepository

@Repository
public class MemberRepository
{
   
   public final JdbcTemplate template;
   
   public MemberRepository(JdbcTemplate template)
   {
      this.template = template;
   }
   
   public void initTable()
   {
      template.execute("create table member (member_id varchar primary key , name varchar)");
   }
   
   public void save(Member member)
   {
      template.update("insert into member(member_id, name) values (?,?)", member.getMemberId(), member.getName());
   }
   
   public Member find(String memberId)
   {
      return template.queryForObject(
            "select member_id , name from member where member_id = ? ", BeanPropertyRowMapper.newInstance(Member.class), memberId);
   }
   
   public List<Member> findAll()
   {
      return template.query("select member_id, name from member", BeanPropertyRowMapper.newInstance(Member.class));
   }
}

JdbcTemplate를 사용해서 회원을 관리하는 리포지토리이다. 

 

*initTable : 보통 리포지토리에 테이블을 생성하는 스크립트는 넣어두지 않는데 예제 프로젝트라서 여기선 단순히 하기 위해서 리포지토리에 넣어뒀다. 

 

 

MemberRepositoryTest

@SpringBootTest
class MemberRepositoryTest
{
   
   @Autowired
   MemberRepository memberRepository;
   
   @Transactional
   @Test
   void memberTest()
   {
      Member member = new Member("idA", "memberA");
      memberRepository.initTable();
      memberRepository.save(member);
      Member findMember = memberRepository.find(member.getMemberId());
      Assertions.assertThat(findMember.getMemberId()).isEqualTo(member.getMemberId());
      Assertions.assertThat(findMember.getName()).isEqualTo(member.getName());
   }
   
}

그리고 만든 리포지토리를 테스트해볼 것인데 ctrl+ shift + T 누르면 쉽게 테스트 클래스를 생성할 수있다. (인텔리제이 단축키 ㅎㅎ) 

 

스프링 부트를 사용해서 테스트해야하기 때문에 @SpringbootTest 어노테이션을 사용했고, 

@Transactional 어노테이션을 사용해서 트랜잭션 기능을 적용했다.  (이 어노테이션을 사용하려면 TransactionManager가 스프링 빈으로 등록되어 있어야 한다.) 

 

 

📚 위에 테스트를 실행해보고 정상 동작하면 된 것인데... 

지금 보면 직접 DataSource, TransacionManager, JdbcTemplate를 사용하기 위해서 스프링 빈으로 등록해줬는데.. 

DB를 사용하기 위해서 다른 프로젝트를 또 한다면 이러한 객체들을 반복해서 스프링 빈으로 등록해야 한다.. 

 

 

 

1️⃣ 스프링 부트 자동 구성 Auto Configuration 

사실 DbConfig의 @Configuration 어노테이션을 제거하고 테스트를 실행해도 정상 동작하는 것을 확인할 수 있다. 

우리가 직접 스프링 빈으로 등록하지 않아도 사실 스프링 부트가 자동으로 등록해준다. 

 

스프링 부트는 자동 구성 Auto Configuration 이라는 기능을 제공하는데 일반적으로 자주 사용하는 수많은 빈들을 자동으로 등록해주는 기능이다.  앞에서 봤던 JdbcTemplate, DataSource, TransactionManager 모두 스프링 부트가 자동 구성(Auto Configuration) 을 제공해서 자동으로 스프링 빈으로 등록해준다. 

 

 

JdbcTemplateAutoConfiguration 

@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 {

}

스프링 부트는 spring-boot-autoconfiguration 이라는 프로젝트 안에서 수많은 자동 구성을 제공한다. 

@AutoConfiguration :  자동 구성을 사용하기 위해서는 이 어노테이션을 사용해야 한다. 

@ConditionalOnClass ({DataSource.class, JdbcTemplate.class}) 

: if 문과 유사하게 생각하면 되는데 위에 지정한 클래스가 있는 경우에만 설정이 동작하도록 설정한다. 만약 이 클래스들이 없다면 여기 있는 설정을 하지 않는다. 

 

 

JdbcTemplateConfiguration

@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;
   }

}

@Configuartion : 자바 설정 파일로 사용된다. 

@ConditionalOnMissinigBean (JdbcOperationis.class)

: JdbcOperation 빈이 없을 때 동작하도록 하는 것으로 JdbcOperations는 JdbcTemplate의 부모 인터페이스로 즉, JdbcTemplate 가 빈으로 등록되어 있지 않는 경우에만 동작한다. 

-> 즉, 개발자가 직접 JdbcTemplate 을 등록하면 개발자가 등록한 빈을 사용하고, 자동 구성은 동작하지 않게 된다. 

 

이런식으로 자동 구성 기능들이 필요한 것들을 빈으로 등록해준다. 

DataSource -> DataSourceAutoConfiguration 

TransactionManager -> DataSourceTransactionManagerAutoConfigurationi 

JdbcTemplate -> JdbcTemplateAutoConfiguration 

 

 

 

💌 Auto Configuration 

스프링 부트는 수 많은 자동 구성을 제공하고, spring-boot-autoconfigure 에 자동 구성을 모아둔다. 

그리고 스프링 부트 프로젝트를 사용하면 spring-boot-autoconfigure 라이브러리는 기본적으로 사용한다.