ibatis vs MyBatis

원래 마이그레이션 포스팅부터 다룰려고 했으나.. 이게 공식위키에서는 엄청 쉽게 이야기 한것과 달리 그냥 라이브러리 교체 정도로 끝나는게 아니라서 일단 바뀐 용어와 개요부터 정리를 좀 해야 할 필요성을 느꼈다. 

myBatis로 바뀌면서 기본 용어들이 조금씩 차이가 나기 때문에.. 주의가 필요하다. 

기존 SqlMapConfig은 Configration로 변경되었고 sqlMap은 mapper로 변경되었다. 다른 용어들이 변경된 상황이나.. 내부적으로 사용하는 것들(ex. isEqual 을 아에 if 로 바꾼거라던지)을 보면 좀더 범용적으로 알아보기 쉽게 바꿔가는 것을 목표로 가고있는 듯 하다. 
익숙해지면 아무래도 코드 읽기도 만들기도 쉬울것으로 보인다. 

큰 변화중 하나는 자바 애노테이션을 사용해서 xml을 사용하지 않고 모든것을 자바로만 할수 있게 되었다. 
물론 Configration.xml 도 자바에서 직접 DataSource,  Environment 등을 선언해서 클래스화 시킬수 있다. xml 스트링으로 설정값등을 저장해야 한다는 것에 부담을 느꼈다면 좋은 변화라고 할수 있겠다.

주의할점은 xml로 Configure를 만들고 환경변수와 property를 클래스로도 만들었다면.. 클래스쪽이 나중에 읽어지게 되서 xml로 되어있는 세팅이 자바 클래스에서 선언해놓은것으로 덮어써지게 된다. 혼란을 줄수 있으니 한가지 방법만으로 프로젝트를 구성하는것이 좋을것이다. 

그리고 Configuration configuration = new Con.... 형식으로 선언을 하고 나서는 mapper도 xml이 아니고 configuration.addMapper(UserMapper.class) 형식으로 추가 해야 하기 때문에 어느쪽으로 할것인지 확실하게 결정을 하고 나서 진행해야 한다.

네임스페이스 방식도 변경되었는데.. sqlMap 파일별로 줄여놓은 이름을 사용했다면 이제 풀경로로 사용하게 된다. 공식 설명서에서는 혼란을 줄이고 어떤것이 호출되는지 정확하게 알수 있으니 좋다라고 해놨지만 아무래도 길어지니 쓰기에 불편하기는 하다.. 
기존에 <sqlMap namespace="User"> 이렇게 쓰던것을 
<mapper namespace="myBatis.mapper.UserMapper"> 이렇게 풀 경로로 쓰게 된다.

실제 자바쪽에서 호출할때도 

1	list = session.selectList("myBatis.mappers.UserMapper.getUserList");

이렇게 길게 호출 하게 되는데.. 그냥 string 이라서 입력이 여간 불편하다.

이런 경우에 위에서 이야기한 자바 애노테이션 (@Select)을 사용해서 mapper 파일을 xml이 아니고 자바로 만들어놓으면 코드힌트까지 사용해서 편하게 쓸수있다.

1	UserMapper mapper = session.getMapper(UserMapper.class);

2	list = mapper.selectUserList();

권장사항은 xml 이라고 되어있었던거 같은데.. 편하기는 자바쪽이 편한 구조랄까..;;

---

기본 용어

SqlSessionFactory :  SqlMapClient가 SqlSessionFactory로 변경되었다. 어플리케이션과 같은 라이프사이클을 가지게 된다. 한번만 생성되면 되므로 Manager 클래스에서 싱글톤으로 구현하면 된다.

SqlSessionFactoryBuilder : 환경 값(디비 및 트랜잭션 설정등..)을 읽어와서 SqlSessionFactory 인스턴스를 만들어준다. 기존의 SqlMapClientBuilder 대신 사용된다.

1	String resource = "org/mybatis/example/Configuration.xml";

2	Reader reader = Resources.getResourceAsReader(resource);

3	sqlMapper = new SqlSessionFactoryBuilder().build(reader);

SqlSession : SqlSessionFactory 에서 세션을 하나씩 열어서 개별 쓰레드 별로 사용한다. 세션을 열고나서 실제 쿼리를 수행하게 된다. 하나의 리퀘스트에 하나의 세션을 가지게 되고 사용후에는 꼭 닫아줘야 한다. 

mapper : 기존의 sqlMap이 변경된 것이다. 실제 쿼리들이 들어있게 되고 위의 SqlSession을 열어야 호출할 수 있다. method scope를 가지게 되고 해당 메서드가 사용되고나면 사라진다. 별도로 닫거나 할 필요는 없고 SqlSession이 함께 관리 한다. 

1	SqlSession session = sqlSessionFactory.openSession();

2

try {

3	UserMapper mapper = session.getMapper(UserMapper.class);

4	// do work

5	} finally {

6	session.close();

7

}

---

변경되거나 추가된 속성들

기존에 조건에 따라 변하는 쿼리를 만들기 위해서 사용되던 태그들이 변경되었다. 조금더 직관적으로 바뀌었고 해당상황(Update, Select)등에 맞춰서 사용할 수 있는 태그들도 추가되었다. 

parameterMap은 더이상 사용하지 않게 되었다. parameterMap과 parameterClass 대신 parameterType 하나로 사용한다.
resultMap은 여전히 남아있지만 resultClass 는 resultType 으로 변경되었다.
parameterType과 resultType에는 기본형(int, byte, .... )부터 클래스 명까지 기존처럼 사용할 수 있다.

기존에 procedure를 호출하기 위해 사용하던 <procedure>가 사라지고 statementType 속성이 생겼다. PREPARED, STATEMENT, CALLABLE 중에 하나를 선택할 수 있고 기본값은 PREPARED이다. 

파라미터를 매핑하기위해서 사용하던 #var# 형태는 #{var} 로 바뀌었다. $var$ 역시 ${var} 형태로 사용하면 된다.
  

참고) #{var}와 ${var}의 차이는 prepredStatement의 파라미터로 사용할 것인가.. 그냥 String 값으로 때려박을것인가 하는 것이다. order by 같은 경우에 사용하기 위해서는 order by ${orderParam} 처럼 사용해야 한다. 이 방법을 사용하는 경우 myBatis가 자체적으로 쿼리의 적합성여부를 판단할 수 없기 때문에 사용자의 입력값을 그대로 사용하는 것보다는 개발자가 미리 정해놓은 값등으로 변경하도록 해서 정확한값이 들어올수 있도록 해야 한다. 

sqlMap쪽에서 사용하던 typeAlias가 sqlMap이 바뀐 mapper 에서 사용되지 않고 Configration 파일에서 정의하도록 변경되었다. 

<typeAliases>
    <typeAlias type="vo.UserVO" alias="User"/>
</typeAliases>

Configration 파일에 위의 형식처럼 Aliase를 정의하면 전체 mapper 에서 사용할 수 있다. 

---

Dynamic Statement의 변화

<isEqual> , <isNull> 등의 구문이 <if>로 통합되었다. 이전보다는 확실히 직관적으로 쓸수 있을듯 하다. 
<if test="userID != null"> 형태로 간단하게 사용할 수 있다. (스트럿츠2에서 사용하는 형태 처럼 보이는데..;;)

<dynamic > 형태로 해서 where 조건절이나 and , or 를 동적으로 만들던것이 <where>나 update에서 사용할 수 있는 <set> 등으로 변경되었다. 

<select id="getUserList" resultType="User>
    SELECT * FROM TR_USER
        <where>
            <if test="isAdmin != null">
                authLevel = '1'
             </if>
          </where>
</select>

trim, foreach 태그가 새로 추가 되었다. 
trim은 쿼리를 동적생성할때에 쿼리를 연결하기 위해서 컴마(,)를 사용한경우 마지막항목이 조건을 만족하지 못해서 생성된 쿼리 끝에 컴마가 붙어있다던가 하는 경우에 잘라낼 수 있다. 
foreach는 반복적인 항목을 동적으로 넣을때 사용할 수 있다. ( ex. where 조건절에서 in 을 사용하는 경우)

공식홈페이지의 위키에 기존 iBatis를 myBatis로 바꿀때 확인해야 할 부분들이 있으니 꼭 참고 하자.
http://code.google.com/p/mybatis/wiki/DocUpgrade3

ps.
지금 있는것도 못하고 있는데 항상 새로운 버전이 쏟아지니 미칠꺼같다 -ㅅ-;;
Flex4도 정식으로 손대보지 못했는데 5 소식이라니.. ㅠㅠ 

==============================================================================================


저번 포스팅에서 iBatis 에서 myBatis로 넘어오면서 바뀐점들에 대해 적었었다. 
2010/11/05 - [Java & iBatis] - iBatis에서 myBatis로 개요 및 변경점

이 포스트에서는 이전에 바뀐 것들을 바탕으로 기본 환경 설정을 확인 해본다. 

프로젝트 환경 설정은 그림과 같다. 

플렉스쪽이 더 있기는 하지만 그건 여기서는 중요한건 아니므로 패스 하고. Java, MyBatis 만 확인 해보자.

Configration.xml

01	<configuration>

02

03	<typealiases>

04	<typealias type="vo.UserVO" alias="User">

05	</typealias></typealiases>

06

07	<environments default="development">

08	<environment id="development">

09	<transactionmanager type="JDBC">

10	<datasource type="POOLED">

11	<property value="oracle.jdbc.driver.OracleDriver" name="driver"></property>

12	<property value="db_url" name="url"></property>

13	<property value="user" name="username"></property>

14	<property value="passwd" name="password"></property>

15	</datasource>

16	</transactionmanager></environment>

17	</environments>

18

19

<mappers>

20	<mapper resource="myBatis/mappers/UserMapper.xml">

21	</mapper></mappers>

22

23	</configuration>

빈즈(여기서는 플렉스와 맞추기위해서 VO로 작업했다)의 typeAlias 가 먼저 나오고 환경설정 그다음에 mapper가 나온다.  이 순서대로 넣지 않고 typeAlias를 environments 다음에 넣거나 하면 에러가 발생한다. 
에러내용에 보면 순서 정의가 되어있고 그 순서에 맞춰서 넣어야 한다고 되어있다. 

Description Resource Path Location Type
The content of element type "configuration" must match "(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,plugins?,environments?,mappers?)". Configuration.xml taskManager/WebContent/WEB-INF/classes/myBatis line 6 XML Problem

properties 에서 시작해서 mapper 까지 순서가 정해져 있는데 xml을 위에서 부터 읽어서 뒤에정의된 내용은 덮어 쓰게 되므로 설정파일에서는 미리정의 해놓은것 같다. (이전포스트에서 속성을 덮어쓰는 순서에 대해서 이야기 한적이 있다)

MyBatisManager.java

01	public class MyBatisManager {

02

03	public static SqlSessionFactory sqlMapper = null;

04

05	public static SqlSessionFactory getInstance(){

06	if(sqlMapper == null) {

07

try {

08	String resource = "myBatis/Configuration.xml";

09	Reader reader = Resources.getResourceAsReader(resource);

10	sqlMapper = new SqlSessionFactoryBuilder().build(reader);

11	reader.close();

12

13	}catch(Exception e){

14	e.printStackTrace();

15

}

16

}

17	return sqlMapper;

18

}

19

}

SqlSessionFactory는 어플리케이션과 같은 라이프사이클을 가지게 되므로 싱글톤으로 간단하게 구현해놓는다. 
이후에 getInstance()를 호출해서 클래스의 참조를 받아오게 된다. 
매니저로 구현하지 않고 그냥 java 파일의 상단에서 생성시켜도 별 상관은없다. 

UserDao.java

01	public class UserDao {

02

03	public static SqlSessionFactory sqlMapper = MyBatisManager.getInstance();

04

05	public List<uservo> getUserList() {

06

07	List<uservo> list = new ArrayList<uservo>();

08

09	SqlSession session = sqlMapper.openSession();

10

try {

11	list = session.selectList("myBatis.mappers.UserMapper.getUserList");

12

13	} catch (Exception e){

14	e.printStackTrace();

15	} finally {

16	session.close();

17

}

18

19	return list;

20

}

21	}</uservo></uservo></uservo>

상단에서 SqlSessionFactory 객체를 가져오고 SqlSession을 오픈하고 mapper의 네임스페이스를 호출해서 쿼리를 실행시킨다. 

UserMapper.xml

1	<mapper namespace="myBatis.mapper.UserMapper">

2

3	<select id="getUserList" resulttype="User"> SELECT userID, name, phone, email, TO_CHAR(regdate,'YYYY-MM-DD HH24:MI') regdate, isuse, auth FROM TR_USER ORDER BY REGDATE DESC</select>

4

5

</mapper>

nameSpace가 풀 경로인것을 확인한다.  resultType에는 Configure.xml 에서 typeAlias에서 지정해놓은 shortName 으로 설정한다. 네임스페이스와 실행시킬 쿼리아이디를 합해서 UserDao.java에서 호출하게 된다.

순서를 살펴 보면.. 

UserDao가 실행되면서 MyBatisManager 에서 Configure.xml 파일의 설정을 참조해서 SqlSessionFactory를 생성하고 Factory에서 session을 열고 UserMapper의 쿼리를 실행시킨다.

플렉스에서 받아들이는쪽은 기존의 iBatis 설정과 같으니 패스 하기로 하고 마무리~
첨부된 소스는 위에서 설명된 파일들이다. 


출처 -  http://rinn.kr/49