mybatis 설치 예제

기존의 아파치프로젝트로 존재하던 iBatis가 2.xx 버전에서 3.xx로 버전을 업그레이드 뒤, 아파치 프로젝트에서 코드 구글로 이동하면서 이름도 MyBatis로 변경되었습니다. 제가 직접 사용해 본 결과 iBatis와 비교해 보았을때 많은 부분이 변경되어 튜토리얼을 작성하게 되었습니다. ( 기존에 ibatis를 많이 사용해 보셨던 분이라면 무난하게 세팅하고 사용하실수 있을테지만 처음 접하는 분들을 위해 초기설정을 해보도록 하겠습니다.)

저는 eclipse와 mysql 5.5를 통해 튜토리얼을 진행해 보겠습니다.

작업방법
1. MyBatis 라이브러리와 Mysql connector library를 다운받습니다.
자바 프로그래밍의 시작은 라이브러리의 추가입니다.(ㅎㅎ) 다음의 라이브러리를 다운 받습니다.
- mybatis-3.0.4 [다운로드]
- mysql-java-connector-5.1.14 [다운로드] 

2. eclipse에서 JavaProject를 생성합니다.
저는 간단하게 MyBatis만을 세팅하고 DB의 데이터를 긁어와 콘솔창에 뿌려주는 테스트를 할것임으로, Java Project를 생성하겠습니다. 목적에 따라서 Dynamic Web Project를 하셔도 상관이 없습니다.

3. 해당 프로젝트를 생성후 build path에 mybatis 라이브러리와 mysql connector 라이브러리를 추가해 줍니다.
위에서 다운받은 두개의 파일을 압축푸시면 jar파일이 나옵니다. 해당 jar파일을 build path에 추가해 줍니다.

4. 테이블을 생성합니다.
간단하게 테스트 하기 위해서 다음과 같은 쿼리로 테이블을 생성했습니다.

1. CREATE TABLE `mybatis` (  
2.   `idx` int(10) NOT NULL AUTO_INCREMENT,  
3.   `title` text,  
4.   `contents` text,  
5.   PRIMARY KEY (`idx`)  
6. ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;<SPAN id=tx_marker_caret></SPAN>  

5. MyBatis 세팅파일인 Configuration.xml파일을 생성합니다.
net.mybatis.tutorial.conf 패키지를 생성한후 아래와 같이 Configuration.xml 파일을 생성했습니다.

1. <?xml version="1.0" encoding="UTF-8" ?>  
2. <!-- Valid 한 설정 xml을 만들기 위해 DTD를 추가해 줍니다. -->  
3. <!DOCTYPE configuration  
4.     PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  
5.     "http://mybatis.org/dtd/mybatis-3-config.dtd">  
6. <configuration>  
7.     <!--  
8.         properties : 해당위치의 properties파일을 참조하여 현재 xml내에서   
9.         ${name} 으로 값을 사용할 수 있습니다.  
10.         즉 properties에 선언된 db.properties에 username=xxxxx 라고 설정되어 있으면  
11.         아래의 <property name="username" value="${username}"/> 부분의 value에 xxxx가  
12.         치환되어 들어갑니다.  
13.     -->  
14.     <properties resource="net/mybatis/tutorial/conf/db.properties"/>  
15.     <!--  
16.         SQL이 선언되어 있는 xml( ibatis에서는 SqlMap이라고 불렀지만, myBatis에서는   
17.         mapper 라고 불리고 있습니다)에서 사용할 VO객체의 별명을 붙여 줍니다.  
18.   
19.         기존의 ibatis에서는 해당설정이 SqlMap쪽에 존재 했던 반면 myBatis에서는 설정쪽으로  
20.         이동한 것이 달라진 점이라 하겠네요~^^   
21.     -->  
22.     <typeAliases>  
23.         <typeAlias alias="Mybatis" type="net.mybatis.tutorial.vo.MybatisVO"/>  
24.     </typeAliases>  
25.     <!--   
26.         DB Connection을 맺기 위한 정보들을 입력해 줍니다. ${}는 위에 선언한 properties의   
27.         데이터로 치환됩니다.  
28.   
29.         이부분에서 보아야 할부분은 dataSource 부분입니다. 지금은 type="POOLED"라고 설정되어  
30.         있습니다. 이 설정은 Connection pool을 사용하겠다는 뜻입니다.  
31.         이부분의 설정은 좀더 있지만 나중에 알아보도록 하겠습니다.  
32.     -->  
33.     <environments default="development">  
34.         <environment id="development">  
35.             <transactionManager type="JDBC" />  
36.             <dataSource type="POOLED">  
37.                 <property name="driver" value="${driver}" />  
38.                 <property name="url" value="${url}" />  
39.                 <property name="username" value="${username}" />  
40.                 <property name="password" value="${password}" />  
41.             </dataSource>  
42.         </environment>  
43.     </environments>  
44.     <!--  
45.         위에서도 말했듯 mapper.xml은 실질적으로 query문이 선언되어 있는 부분입니다. 
46.     -->  
47.     <mappers>  
48.         <mapper resource="net/mybatis/tutorial/mapper/MybatisMapper.xml" />  
49.     </mappers>  
50. </configuration>  

6. properties 파일을 생성합니다.
위에서도 설정하였듯 해당 위치에 db.properties파일을 생성합니다.

1. driver=com.mysql.jdbc.Driver  
2. url=jdbc:mysql://localhost:3306/db이름  
3. username=아이디  
4. password=비밀번호  

자신의 환경에 맞게 다음과 같이 설정합니다.

7. 실질적인 query문이 선언되어 있는 mapper.xml을 만들어 보겠습니다.

1. <?xml version="1.0" encoding="UTF-8" ?>  
2. <!DOCTYPE mapper  
3.     PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"  
4.     "http://mybatis.org/dtd/mybatis-3-mapper.dtd">  
5. <!--   
6.     root 엘리먼트 이름은 mapper입니다.   
7.     ibatis에서는 SqlMap이었습니다.  
8.     namespace는 지정을 해도 되고 안해도 됩니다. ibatis에서는 네임스페이스 사용여부를  
9.     설정에서 명시적으로 선언해줘야 했지만, myBatis에서는 따로 설정할 필요가 없이, namespace attribute  
10.     가 없으면 네임스페이스 안쓰는걸로, 있으면 쓰는걸로 자동으로 되는듯 싶습니다.  
11. -->  
12. <mapper namespace="net.mybatis.tutorial.mapper.MyBatisMapper">  
13.     <!--  
14.         select 태그를 사용하여 select 쿼리를 만듭니다.  
15.         parameterType: iBatis의 parameterClass의 역할로 전달 인자의 타입을 선언합니다  
16.         resultType : iBatis의 resultClass와 같은 역할로 처음 선언했던 Configuration.xml의   
17.         typeAlias를 나타냅니다.  
18.     -->  
19.     <select id="selectMybatis" parameterType="int" resultType="Mybatis">  
20.         select * from mybatis where idx = #{idx}  
21.     </select>  
22. </mapper>  

8. query를 실행하기 위해 myBatis의 핵심 인스턴스인 SqlSessionFactory 인스턴스를 생성하는 Util클래스를 작성합니다.
iBatis의 SqlMapClient클래스가 있다면 MyBatis에는 SqlSessionFactory라는 클래스가 있습니다. query를 실행하기 위해서는 SqlSessionFactory를 통해 SqlSession 객체를 생성하여 query를 실행 할 수 있습니다.

1. <SPAN id=tx_marker_caret>public class SqlSessionManager {  
2.     public static SqlSessionFactory sqlSession;  
3.     static {  
4.         String resource = "net/mybatis/tutorial/conf/Configuration.xml";  
5.         Reader reader;  
6.         try {  
7.             reader = Resources.getResourceAsReader( resource );  
8.             sqlSession = new SqlSessionFactoryBuilder().build( reader );  
9.         } catch (IOException e) {  
10.             e.printStackTrace();  
11.         }  
12.     }  
13.     public static SqlSessionFactory getSqlSession() {  
14.         return sqlSession;  
15.     }  
16. }</SPAN>  

위와같이 Configuration.xml 을 읽어 SqlSessionFactory 인스턴스를 생성합니다. myBatis는 SqlSessionFactory를 싱글톤 패턴으로 단 하나의 인스턴스만 생성하게 해줍니다

9. DB에 접근할 DAO클래스를 생성합니다.
SqlSessionFactory를 통해 SqlSession을 얻어와서 SqlSession을 통해 query문을 실행합니다. 
selectOne는 select query를 실행하여 하나의 Object를 가져오는 method입니다. 
쿼리의 선택은 selectOne 첫번째 전달인자로 선택합니다. 첫번째 전달인자는 "mapper xml의 namespace" + "query id" 입니다. 두번째 전달인자는 해당 쿼리로 전달될 값입니다.

1. public class MybatisDAO {  
2.     private SqlSessionFactory sqlSessionFactory = SqlSessionManager.getSqlSession();  
3.     public MybatisVO getMyBatis( int id ){  
4.         SqlSession session = sqlSessionFactory.openSession();  
5.         try {  
6.             MybatisVO mybatis = ( MybatisVO ) session.selectOne( "net.mybatis.tutorial.mapper.MyBatisMapper.selectMybatis" , id );  
7.             return mybatis;  
8.         } finally {  
9.             session.close();  
10.         }  
11.     }  
12. }  

테스트케이스를 작성하신후 junit으로 실행을 하시던, main method를 하나 만들어 테스트를 하시던 데이터를 잘 가져오는것을 확인 할 수 있습니다.

위와 같은 설정이 default입니다. 

위의 5, 7번 설정과 같이 Configuration.xml, mapper.xml 과 같이 설정과 query문을 xml로 선언합니다. 하지만 프레임웍을 처음 써보시는 분이나, xml설정방법이 익숙하지 않으신 분들, 그리고 저렇게 복잡한 설정을 거치지 않아도 되는 쿼리를 실행해야 하는 분들은 5, 7번 단계를 only java로 대체할수가 있습니다

1. only java로 설정하실 분들은 5번 단계를 뛰어넘고 8번 단계에서 다음과 같은 class를 작성합니다.

1. public class SqlSessionManager {  
2.     public static SqlSessionFactory sqlSession;  
3.     static {  
4.         DataSource dataSource = new PooledDataSource("com.mysql.jdbc.Driver","jdbc:mysql://localhost:3306/디비이름","아이디","비밀번호");  
5.         TransactionFactory transactionFactory = new JdbcTransactionFactory();  
6.         Environment environment = new Environment( "development", transactionFactory, dataSource );  
7.         Configuration configuration = new Configuration( environment );  
8.         //아래의 2번에 설정된 인터페이스를 지정합니다.  
9.         configuration.addMapper( MybatisMapper.class );  
10.         sqlSession = new SqlSessionFactoryBuilder().build( configuration );  
11.     }  
12.     public static SqlSessionFactory getSqlSession() {  
13.         return sqlSession;  
14.     }  
15. }  

2. mapper.xml도 xml대신 java interface로 대체합니다.
아래와 같이 어노테이션을 통해 간단한 쿼리 문을 대체 합니다.

1. public interface MybatisMapper {  
2.     @Select("SELECT * FROM mybatis WHERE idx = #{idx}")  
3.     MybatisVO getMybatis( int id );  
4. }  

3. dao를 작성합니다.

1. public class MybatisDAO {  
2.     private SqlSessionFactory sqlSessionFactory = SqlSessionManager.getSqlSession();  
3.     public MybatisVO getMyBatis( int id ){  
4.         SqlSession session = sqlSessionFactory.openSession();  
5.         try {  
6.             MybatisMapper mapper = session.getMapper( MybatisMapper.class );  
7.             MybatisVO mybatis = mapper.getMybatis( id );  
8.             return mybatis;  
9.         } finally {  
10.             session.close();  
11.         }  
12.     }  
13. }  

위와 같이 작성하시면 설정 xml없이 myBatis를 사용할수 있습니다.

이상으로 myBatis의 기본설정을 알아봤습니다.

다음에 기회가 된다면 좀더 알아봐야 겠네요~^^ 

출처 -  http://khpower.tistory.com/entry/MyBatis-MyBatis%EB%A5%BC-%EC%82%AC%EC%9A%A9%ED%95%98%EC%9E%90-MyBatis-%EC%B4%88%EA%B8%B0-%EC%84%A4%EC%A0%95