MyBatis 설정 파일 작성 방법

• 관련 글

- [JAVA/WEB] 웹 프로젝트에 MyBatis 세팅 및 적용하기

- MyBatis 설정 파일 - SQL Mapper 작성 방법

---

MyBatis 설정 파일 작성 방법

MyBatis 프레임워크가 참조하는 XML 파일은 MyBatis 설정 파일과 SQL mapper 파일로 나누어진다. 본 포스팅에서는 MyBatis 설정 파일 작성 방법에 대해 다룰것이다.

 

MyBatis는

• 자체 커넥션풀 구축
• 여러 개의 데이터베이스 연결 정보를 설정해 두고 개발, 테스트, 운영에 따라 사용할 DB 지정
• SELECT 결과 캐싱
• VO(Value Object, 값 객체)에 alias 부여

등의 기능을 지원한다.

따라서 MyBatis 설정파일에는 해당 기능을 수행하는 동작 환경을 설정한다.

 

다음은 MyBatis 설정 파일의 예이다.

 

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <properties resource="com/atoz_develop/spms/dao/db.properties"/>
 
    <typeAliases>
        <typeAlias type="com.atoz_develop.spms.vo.Project" alias="project"/>
        <typeAlias type="com.atoz_develop.spms.vo.Member" alias="member"/>
    </typeAliases>
 
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
 
    <mappers>
        <mapper resource="com/atoz_develop/spms/dao/MySqlProjectDao.xml"/>
    </mappers>
</configuration>

1. XML과 DTD 선언

가장 먼저 XML 선언과 DTD 선언이 온다.

 

 

2. Root Element - <configuration>

MyBatis 설정의 루트 엘리먼트는 <configuration>이다.

 

📝 참고 - <configuration>의 DTD 규칙

<!ELEMENT configuration (properties?, settings?, typeAliases?, typeHandlers?, objectFactory?, objectWrapperFactory?, plugins?, environments?, databaseIdProvider?, mappers?)>

 

다음은 <configurations>의 child elements 중 주요 엘리먼트의 용도를 정리한 표이다.

 

엘리먼트	용도
properties	프로퍼티 파일 경로 <property>에 개별 프로퍼티 정의
settings	프레임워크 실행 환경 설정
typeAliases	자바 클래스 이름에 대한 alias 설정
typeHandlers	컬럼 값을 자바 객체로, 자바 객체를 컬럼 값으로 변환해주는 클래스 설정
environments	프레임워크에서 사용할 데이터베이스 정보(트랜잭션 관리자, 데이터 소스) 설정
mappers	SQL mapper 파일 경로

 

1) <properties>

보통 데이터베이스 연결 정보처럼 자주 변경될수 있는 값은 프로퍼티 파일에 작성한 뒤 이를 참조해서 값을 가져올 수 있도록 한다.

<properties>는 이런 용도로 사용한다.

 

프로퍼티 파일이 CLASSPATH에 있으면 resource 속성을 사용해서 설정하고 CLASSPATH 밖에 위치한다면 url 속성을 사용한다.

 

* 개별 프로퍼티 설정

프로퍼티 파일에 정의된 것 외에 추가로 프로퍼티를 정의하려면 <properties> 하위에 <property>를 설정한다.

 

<properties resource="com/atoz_develop/spms/dao/db.properties">
    <property name="username" value="lalala"/>
    <property name="password" value="lololo"/>
</properties>

 

* 프로퍼티 값 참조

프로퍼티 값은 ${프로퍼티명} 형식으로 참조한다.

 

 

2) <typeAlias>

SQL mapper 파일에서 parameterType이나 resultType을 지정할때 긴 이름의 클래스명 대신 짧은 이름의 alias를 사용할 수 있다.

<typeAlias>는 이런 SQL mapper에서 사용할 alias를 설정한다.

 

 

* SQL Mapper에서 alias 사용

MyBatis 설정 파일에 설정된 alias는 SQL mapper에서 다음과 같이 사용하면 된다.

 

 

* MyBatis Built-In Alias

MyBatis에는 int, double, boolean같은 기본 데이터 타입이나 wrapper 클래스에 대해 미리 alias가 정의되어 있다.

다음은 미리 정의된 alias 목록이다.

 

alias	type	alias	type
_byte	byte	byte	java.lang.Byte
_short	short	short	java.lang.Short
_int, _integer	int	int, integer	java.lang.Integer
_long	long	long	java.lang.Long
_float	float	float	java.lang.Float
_double	double	double	java.lang.Double
_boolean	boolean	boolean	java.lang.Boolean
string	java.lang.String	date	java.util.Date
decimal	java.math.BigDecimal	bigdecimal	java.math.BigDecimal
map	java.util.Map	hashmap	java.util.HashMap
list	java.util.list	arraylist	java.util.ArrayList
collection	java.util.Collection	iterator	java.util.Iterator
object	java.lang.Object

 

3) <environments>

데이터베이스 환경 정보를 설정할때 사용한다.

이 태그를 이용하면 여러 개의 데이터베이스 접속 정보를 설정할 수 있다.

설정된 DB 정보 중 하나를 선택할 때 default 속성을 사용한다.

 

 

<environment>에 각 데이터베이스의 트랜잭션 관리 방식, 데이터 소스를 설정한다.

 

* <transactionManager>

MyBatis에서 트랜잭션을 관리하는 방식에는 두 가지가 있다.

 

트랜잭션 관리 유형	설명
JDBC	직접 JDBC의 commit, rollback 기능을 사용하여 MyBatis 자체에서 트랜잭션을 관리
MANAGED	서버의 트랜잭션 관리 기능을 이용 즉 Java EE 서버나 서블릿 컨테이너에서 트랜잭션을 관리

 

<transactionManager>의 type 속성에 JDBC 또는 MANAGED를 지정하면 된다.

 

* <dataSource>

MyBatis는 JDBC 표준 인터페이스인 javax.sql.DataSource 구현체를 이용하여 DB 커넥션을 다룬다.

MyBatis에서 사용 가능한 데이터 소스 유형은 다음 세 가지가 있다.

 

데이터 소스 유형	설명
UNPOOLED	DB 커넥션을 요청할 때마다 커넥션 객체를 생성한다. 높은 성능을 요구하지 않는 단순한 어플리케이션에 적합하다.
POOLED	MyBatis 자체 DB 커넥션풀을 사용한다. 미리 DB 커넥션 객체를 생성해 두고 요청하면 즉시 반환한다. 데이터베이스 연결을 초기화하고 사용자를 인증하는 과정이 없기 때문에 속도가 빠르다.
JNDI	Java EE 서버, 서블릿 컨테이너에서 제공하는 데이터 소스를 사용한다.

 

<dataSource>의 type 속성에 UNPOOLED, POOLED 또는 JNDI를 지정하면 된다.

 

4) <mappers>

SQL mapper 파일들의 정보를 설정한다.

각 mapper 파일을 <mapper> 태그로 정의한다.

 

 

* resource와 url 속성

<properties>와 마찬가지로 CLASSPATH에 있을 경우 resource 속성에 경로를 지정하고 CLASSPATH 외부에 있을 경우 url 속성에 경로를 지정한다.

 

MyBatis 설정 파일 작성 가이드 문서는 라이브러리 압축 파일 내에 mybatis-x.x.x.pdf 와 같이 PDF 파일로도 제공된다.

해당 문서를 함께 참조하면 더 자세한 정보를 얻을 수 있다.

---

• 관련 글

- [JAVA/WEB] 웹 프로젝트에 MyBatis 세팅 및 적용하기

- MyBatis 설정 파일 - SQL Mapper 작성 방법

 

References

열혈강의 자바 웹 개발 워크북(프리렉, 2016, 엄진영)