[Spring] 10 - MyBatis

해당 게시글의 전체 소스코드는 이곳 Github를 참고해 주세요

MyBatis

SQL과 자바 객체를 매핑하는 사상에서 개발된 데이터베이스 접근용 프레임워크
SQL 기반으로 데이터베이스 접근을 수행하는 기존 방식과 큰 규모의 애플리케이션 개발에서 발생하는 과제를 해결하는 구조
장점
- SQL의 체계적인 관리(설정 파일, 애노테이션)
  - 자바 Mapper 인터페이스를 통해 SQL 설정 파일과 연동
  - 비즈니스 로직에서 Mapper 인터페이스를 통해 SQL문 실행
- 자바 객체와 SQL 입출력 값의 바인딩
- 동적 SQL 조합
주요 컴포넌트
- MyBatis 라이브러리
  - MyBatis 설정 파일
  - SqlSessionFactoryBuilder : MyBatis 설정 파일을 바탕으로 SqlSessionFactory를 생성
  - SqlSessionFactory : sqlSession 생성을 위한 컴포넌트
  - SqlSession : SQL 발행과 트랜잭션 관리
  - Mapper 인터페이스 : 매핑 파일과 SQL에 대응하는 자바 인터페이스
  - 매핑 파일 : SQL과 OR 매핑을 XML에 파일 기술
- 스프링 프레임워크 연동을 위한 MyBatis-Spring 라이브러리
  - org.mybatis.spring.SqlSessionTemplate : sqlSession 인터페이스를 구현
MyBatis의 핵심 API는 sqlSession 인터페이스 이다
- sqlSession을 사용하는 방법
  - sqlSession 객체를 DAO 객체에 의존관계 주입으로 사용
  - DAO 역할을 Mapper 객체를 통해 기능 제공
    - myBatis는 DAO의 구현을 자동으로 생성해주는 Mapper라는 기능을 제공
    - 개발자가 Mapper 인터페이스를 준비해서 Mapper 객체를 생성하도록 빈 정의
MyBatis 연동을 위한 라이브러리(pom.xml 추가 필요)
- spring-jdbc : 스프링이 제공하는 JDBC 래핑 모듈
- MyBatis-Spring : 마이바티스가 제공하는 프레임워크 간의 연동 라이브러리
- MyBatis : 마이바티스 프레임워크 모듈
- mysql-connector-java : 사용할 데이터베이스 JDBC 라이브러리
- commons-dbcp : 커넥션 풀 지원 라이브러리
Pom.xml 내용 일부

    ...
    <!-- DataBase DI by doop -->		
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>${org.springframework-version}</version>
    </dependency>
    
    <!-- commons dbcp by doop -->
    <dependency>
        <groupId>commons-dbcp</groupId>
        <artifactId>commons-dbcp</artifactId>
        <version>1.4</version>
    </dependency>
    
    <!-- mysql-connector-java by doop -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.12</version>		
    </dependency>
    
    <!-- MyBatis by doop -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.4.6</version>
    </dependency>
    
    <!-- MyBatis-Spring by doop -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>1.3.2</version>
    </dependency>
    ...

MyBatis 연동 설정하기 (root-context.xml)

MyBatis 연동을 위한 스프링 의존 관계 설정
1. 커넥션 풀을 지원하는 데이터 소스 빈 을 등록한다.
2. 스프링의 트랜잭션 관리자의 빈을 등록 한다 (스프링의 트랜잭션 제어를 사용하기 때문에 MyBatis의 트랜잭션 API는 사용하지 않음)
3. MyBatis의 SqlSessionFactory 빈을 등록 한다
4. MyBatis-Spring의 SqlSessionTemplate 빈을 등록 한다.
root-context.xml XML 네임스페이스 설정
- XML 문서들의 엘리먼트와 어트리뷰트의 충돌을 피하기 위해 구분을 지어 주는 방법

    <!-- DataSource bean 등록 by doop -->
	<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
		<property name="driverClassName" value="com.mysql.cj.jdbc.Driver"></property>
		<property name="url" value="jdbc:mysql://127.0.0.1:3306/myspring?useSSL=false&amp;serverTimezone=UTC"></property>
		<property name="username" value="root" />
		<property name="password" value="root" />
		<property name="maxActive" value="5" />
	</bean>
	
	<!-- 트랜잭션 관리자 빈 등록 by doop -->
	<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
		<property name="dataSource" ref="dataSource"></property>
	</bean> 
	
	<!-- MyBatis의 SqlSessionFactory 빈 등록 by doop -->
	<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
		<property name="dataSource" ref="dataSource"></property>
		<property name="configLocation" value="classpath:/mybatis-config.xml"></property>
      	<property name="mapperLocations" value="classpath:mappers/*Mapper.xml"></property> 
	</bean>
	
	<!-- Mybatis-Spring의 SqlSessionTemplate 빈 등록 -->
	<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate" destroy-method="clearCache">
		<constructor-arg name="sqlSessionFactory" ref="sqlSessionFactory"></constructor-arg>
	</bean>

mybatis-config.xml

MyBatis의 공통적인 설정을 지정하는 XML파일
mybatis-config.xml 내용

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
  
<configuration>
  <typeAliases>
        <!--
            아래와 같이 사용가능
            <package name="org.doorisopen.myspring.Member.Domain" /> 
        -->
        <typeAlias type="org.doorisopen.myspring.Member.Domain.MemberVO" alias="MemberVO"/> 
        <typeAlias type="org.doorisopen.myspring.Board.Domain.BoardVO" alias="BoardVO"/>
        
  </typeAliases>   
</configuration>

~Mapper 파일에서 parameterType이나 resultType에 사용하는 클래스 이름에서 “org.doorisopen.myspring.Member.Domain”을 생략할 수 있다

여기까지 MyBatis 연동 완료

Spring Test

스프링 프레임워크에서 동작하도록 만든 클래스(@Controller, @Service, @Repository, @Component 등이 붙은 클래스)를 테스트 하는 모듈
빈의 통합 테스트
- Junit 에서 DI 컨테이너를 구동시킨 후, DI 컨테이너 안에 관리되는 빈을 테스트
스트링 테스트가 지원하는 기능
- JUnit 테스팅 프레임워크를 사용하여 스프링의 DI 컨테이너를 동작시키는 기능
- 트랜잭션을 테스트 상황에 맞게 제어하는 기능
- 애플리케이션 서버를 사용하지 않고 스프링 MVC의 동작을 재현하는 기능
- 테스트 데이터를 적재하기 위해 SQL을 실행하는 기능
- RestTemplate를 이용해 HTTP 요청에 대한 임의 응답을 보내는 기능

Spring Test를 위한 라이브러리 등록

Pom.xml

    <!-- Spring Test by doop -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <version>${org.springframework-version}</version>
        <scope>test</scope>
    </dependency>

Test Case 작성

테스트 케이스 작성을 위한 주요 애노테이션
- @RunWith : 스프링 테스트를 위한 DI 컨테이너(애플리케이션 컨텍스트)를 로딩
- @ContextConfiguration : DI 컨테이너(애플리케이션 컨텍스트)의 설정 파일 위치 또는 설정 클래스를 지정
스프링 TestContext 프레임워크 (Spring TestContext Framework)
- 스프링 테스트에서 동작하는 테스트용 프레임워크
- 스프링 테스트는 Junit에서 스프링 TestContext 프레임워크을 동작시킬 수 있도록 지원하기 위해 org.springframework.test.context.junit4.SpringJUnit4ClassRunner 를 제공
DataSourceTest.java

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"file:src/main/webapp/WEB-INF/spring/root-context.xml"})
public class DataSourceTest {
	
	@Inject
	private DataSource ds;
	
	@Test
	public void ConnectionTest() throws Exception {
		
		try(Connection con = ds.getConnection()) {
			System.out.println(con);
		}
		catch(Exception e) {
			e.printStackTrace();
		}
	}
}

MyBatisTest.java

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = { "file:src/main/webapp/WEB-INF/spring/root-context.xml" })
public class MyBatisTest {
	
	
	@Inject
	private SqlSessionFactory sqlFactory;
	
	@Test
	public void testFactory() throws Exception {
		try(SqlSession session = sqlFactory.openSession()) {
			System.out.println(session);
		}
		catch(Exception e) {
			e.printStackTrace();
		}
	}
}

References

대학교 웹 프레임워크 수업 정리한 내용 입니다.

목차

MyBatis

MyBatis 연동 설정하기 (root-context.xml)

mybatis-config.xml

Spring Test

Spring Test를 위한 라이브러리 등록

Test Case 작성

References