Mybatis-Spring-Boot-Starter 소개 문서 번역

December 22, 2017 | 6 Minute Read

원문

• 소개
  • 마이바티스-스프링-부트-스타터란 무엇인가
  • 요구사항
  • 인스톨
  • 빠른 설정
  • 고급 스캐닝
  • SqlSession 사용하기
  • 환경설정
  • ConfigurationCustomizer 사용하기
  • 마이바티스 컴포넌트들 탐지하기.
  • 샘플들 실행하기

소개

마이바티스-스프링-부트-스타터란 무엇인가

마이바티스-스프링-부트-스타터는 스프링 부트에 마이바티스를 빠르게 빌드할 수 있게 도와준다.

이 모듈을 사용하면 다음을 얻을 수 있다

• 독립실행 어플리케이션 빌드
• 항상 만들어야하는 상용구문_boilerplate을 거의 0에 가깝게 줄일 수 있다
• XML설정을 줄일 수 있다

요구사항

마이바티스-스프링부트-스타터는 Java 6 이상 버전을 요구한다. 그리고 다음과 같은 버전의 마이바티스-스프링과 스프링 부트를 요구한다.

인스톨

마이바티스-스프링-부트-스타터 모듈을 사용하기 위해서는 mybatis-spring-boot-autoconfigure.jar 파일과 그것의 의존라이브러리들(mybatis.jar,mybatis-spring.jar 등)을 클래스 패스상에 포함 시키면 된다.

만약 메이븐을 사용한다면 다음 의존관계 설정을 pom.xml에 포함시킨다.

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

만약 그레이들을 사용한다면 build.gradle에 다음을 추가 한다

dependencies{ 
  compile("org.mybatis.spring.boot:mybatis-spring-boot-starter:2.0.0-SNAPSHOT") 
}

빠른 설정

이미 알고 있듯이, 마이바티스를 스프링과 함께 사용하기 위해서는 최소한 한개의 SqlSessionFactory 와 최소한 한개의 매퍼 인터페이스가 필요하다.

마이바티스-스프링-부트-스타터는 다음과 같은일을 처리한다.

• 존재하는 DataSource 자동감지
• SqlSeessionFactoryBean을 사용해서 해당 데이터소스를 전달하는 SqlSessionFactory의 객체를 생성하고 등록한다.
• SqlSessionFactory을 이용해 SqlSessionTemplate의 객체를 생성하고 등록한다.
• 매퍼들을 자동스캔한 뒤 스캔된 것들을 SqlSessionTemplate에 연결하고 Spring Context에 등록해서 당신의 빈들에 주입할 수 있게 해준다.

다음과 같은 매퍼가 있다고 가정한다.

@Mapper
public interface CityMapper {

    @Select("SELECT * FROM CITY WHERE state = #{state}")
    City findByState(@Param("state") String state);

}

당신은 그냥 평범한 스프링 부트 어플리케이션을 생성하고 다음 코드와 같이 매퍼가 주입되게 한다.(스프링 4.3 이상에서만 가능)

@SpringBootApplication
public class SampleMybatisApplication implements CommandLineRunner {
   private final CityMapper cityMapper;

   public SampleMybatisApplication(CityMapper cityMapper) {
       this.cityMapper = cityMapper;
   }

   public static void main(String[] args) {
       SpringApplication.run(SampleMybatisApplication.class, args);
   }

   @Override
   public void run(String... args) throws Exception {
       System.out.println(this.cityMapper.findByState("CA"));
   }

}

당신이 할일은 이게 전부다. 이제 당신의 어플리케이션은 스프링 부트 어플리케이션으로 실행될 수 있다.

고급 스캐닝

기본적으로 마이바티스-스프링-부트-스타터는 @Mapper 어노테이션이 표시된 매퍼들을 검색한다.

만약 매퍼 스캔을 위해 당신이 정의한 어노테이션이나 마커 인터페이스¹을 사용하기 원한다면 @MapperScan 어노테이션을 사용하면 된다. 그것에 대한 자세한 것은 마이바티스-스프링 참조페이지에서 확인하시오.

마이바티스-스프링-부트-스타터는 스프링 컨텍스트에서 MapperFactoryBean을 하나라도 찾으면 매퍼 스캔작업을 시작하지 않기 때문에 만약 당신이 스캔작업이 완전히 멈추길 바라면 당신의 매퍼들을 @Bean 메소드를 이용해 명시적으로 등록해야만 한다.

SqlSession 사용하기

SqlSessionTemplate의 객체는 생성된 뒤 스프링 컨택스트에 등록되기 때문에 당신의 빈에 주입된 마이바티스 API를 다음 코드처럼 사용할 수 있다. (스프링 4.3 이상버전에서만 사용가능)

@Component
public class CityDao {

   private final SqlSession sqlSession;

   public CityDao(SqlSession sqlSession) {
      this.sqlSession = sqlSession;
   }

   public City selectCityById(long id) {
      return this.sqlSession.selectOne("selectCityById", id);
   }

}

환경설정

다른 스프링 부트 어플리케이션 처럼 마이바티스-스프링-부트-어플리케이션의 환경설정 인자들_parameter들도 application.properties(또는 application.yml)에 작성한다.

마이바티스는 프라퍼티들에 mybatis 접두어를 사용한다.

프라퍼티들은 다음과 같다.

예:

#application.properties
mybatis.type-aliases-package=com.example.domain.model
mybatis.type-handlers-package=com.example.typehandler
mybatis.configuration.map-underscore-to-camel-case=true
mybatis.configuration.default-fetch-size=100
mybatis.configuration.default-statement-timeout=30
...

# application.yml
mybatis:
    type-aliases-package: com.example.domain.model
    type-handlers-package: com.example.typehandler
    configuration:
        map-underscore-to-camel-case: true
        default-fetch-size: 100
        default-statement-timeout: 30
...

ConfigurationCustomizer 사용하기

마이바티스-스프링-부트-스타터는 자동설정으로 등록된 마이바티스 환경설정을 Java Config를 사용해 커스터 마이징 할 수 있다. 마이바티스-스프링-부트-스타터는 ConfigurationCustomizer 를 implements한 빈을 자동으로 찾아서 마이바티스 환경설정을 커스터마이징하는 메소드를 호출한다. (1.2.1 이상 버전부터 사용가능)

예:

//@Configuration class
@Bean
ConfigurationCustomizer mybatisConfigurationCustomizer() {
    return new ConfigurationCustomizer() {
        @Override
        public void customize(Configuration configuration) {
            // customize ...
        }
    };
}

마이바티스 컴포넌트들 탐지하기.

마이바티스-스프링-부트-스타터는 마이바티스에서 제공하는 다음의 인터페이스를 구현한_implements 빈들을 탐지한다.

• Interceptor
• DatabaseIdProvider

샘플들 실행하기

이 프로젝트는 두개의 샘플을 제공한다.