MyBatis

My-Batis

---

MyBatis란?

Mybatis는 자바 오브젝트와 SQL사이의 자동 매핑 기능을 지원하는 ORM(Object relational Mapping)프레임워크이다.

SQL을 별도의 파일로 분리해서 관리하게 해준다. Hibernate나 JAP(Java Persistence Api)처럼 새로운 DB프로그래밍 패러다임을 익혀야하는 부담 없이 SQL을 그대로 이용하면서
JDBC코드 작성의 불편함도 제거해주고 도메인 객체나 VO객체를 중심으로 개발이 가능하다는 장점이 있다

java 에서 mybatis 를 사용한 독립적인 DB접근 클래스 개발을 할 수 있도록 해준다.

• 자바에서 제공하는 JDBC를 보다 편리하게 사용할 수 있도록 해주는 프레임워크
• SQL 쿼리문을 코드 내에서 쓰지 않고 Mapper 파일에서 관리함으로써 코드와 SQL 쿼리를 분리
• SQL 쿼리 수정 시 코드를 직접 수정하지 않아도 돼 유지보수 시 안정성을 높임
• 코드를 간소화하여 가시성을 높여줌

Spring-FrameWork에서 또한 JDBC를 지원하지만 My-Batis가 코드를 더 간결하게
작성할 수 있는 장점을 가지고 있어 My-Batis를 더 많이 사용한다.

쉽게 말하자면 DB와 연결하는 Connection과 sql을 작성하는 부분을 mybatis에서 나눠 관리해주는 것이다.

아파치 톰켓에 라이브러리로 ibatis로 시작해서 3.0버젼부터 MyBatis라는 이름으로 독립했다.

Spring-FrameWork는 Open-Source로 다른 FrameWork를 확장하여 사용이 가능하다.

MyBatis 설치

---

MyBatis 라이브러리를 다운받아 사용 할 수 있다.

https://blog.mybatis.org/ 의 사이트를 이용하여 다운로드 할 수 있다.
한글로 번역된 https://mybatis.org/mybatis-3/ko/index.html도 있다.

MyBatis 연동

---

MyBatis의 핵심 MetaDate로 DB의 연결 정보를 담은 config.xml을 사용하여 Connection을 한다.

<?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">
  						
<!--	
	mybatis-config.xml :: MyBatis Framework 의 핵심 MetaData 로 아래의 설정
	- properties 관리 : 애플리케이션 배포시 공통부분, 각 환경별 다른 값들은 Properties
	                           파일에 독립적으로 관리.
	- ClassName 관리 : FQCN(Full Qualified Class Name) 을 별칭(Alias)관리
	- 기타 설정 : 트랜잭션처리, 커넥션풀 설정, SQL 등 여러 환경설정을 등록,설정...   
-->	  						

<!-- config.xml -->
<configuration>

  <properties resource="sql/jdbc.properties"/>
	
  <settings>
  <setting name="callSettersOnNulls" value="false"/>
  </settings>
	
  <typeAliases>
	<typeAlias alias="user" type="mybatis.service.domain.User"/>
  </typeAliases>

  <environments default="development">
  
    <environment id="development">
      <!-- Transaction Definition -->
      <transactionManager type="JDBC"/>
 	   <!-- javax.sql.DataSource Definition -->      
      <dataSource type="POOLED">
        <property name="driver"  value="oracle.jdbc.driver.OracleDriver"/>
        <property name="url" value="jdbc:oracle:thin:@127.0.0.1:1521:xe"/>
        <property name="username"  value="ibatis"/>
        <property name="password" value="ibatis"/>
      </dataSource>
    </environment>
    
  </environments>

  <!-- SQL Definition :: file include -->
  <!-- 각각 sql에 맞는 MetaData를 작성하여 개별적 독립 개발을 할 수 있게 함 -->
  <mappers>
    <mapper resource="sql/UserMapper.xml"/>
    <mapper resource="sql/UserMapper01.xml"/>
    <mapper resource="sql/UserMapper02.xml"/>
    <mapper resource="sql/UserMapper03.xml"/>
    <mapper resource="sql/UserMapper04.xml"/>
    <mapper resource="sql/UserMapper05.xml"/>
    <mapper resource="sql/UserMapper06.xml"/>
    <mapper resource="sql/UserMapper07.xml"/>
    <mapper resource="sql/UserMapper08.xml"/>
    <mapper resource="sql/UserMapper09.xml"/>
    <mapper resource="sql/UserMapper10.xml"/>
  </mappers>
</configuration>

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE mapper
		PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
		"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!--	
	UserMapper.xml :: SQL 를 갖는 MetaData 
	
	- MyBatis Framework 은 XML MetaData 를 사용 SQL구문을 관리
	  (SQL은 xml 을 통해 적절히 캡슐화 되어 애플리케이선 외부로 분리함)
	- SQL문의 입력(?) / 출력(?)을 매핑한다.  <== 아래의 select element 참조
 -->		

<!-- UserMapper.xml -->			
<mapper namespace="UserMapper">

	<!-- 위의  namespace 이용 Application 에서 UserMapper.~~ 로 아래의 SQL 을 참조  
	 	  :: 아래의 query 수행 후 결과 resultType 에 선언된 User Domain Object 
	 	   	  Field ( property )에 자동연결(?,바인딩)
	 	  :: SQL / Query 의 Alias 와 User Domain Object 의 Field 이름 동일한 것 확인.  -->
  	
  	<select 	id="getUserList" 	resultType="mybatis.service.domain.User">
		SELECT
		user_id 			AS userId,
		user_name 	AS userName,
		password 		AS password,
		age 					AS age,
		grade				AS grade,
		reg_date 		AS regDate
		FROM users   											
  	</select>
  	
</mapper>

위와 같이 쉽게 sql을 다룰줄 안다면 코드를 작성하여 MetaData로 관리 할 수 있다.

쿼리문 작성

---

CRUD

	뜻	SQL
C	CREATE	<select>
R	READ	<insert>
U	UPDATE	<update>
D	DELETE	<delete>

CRUD모두 각각에 맞는 SQL 쿼리문을 작성하여 tag안에 넣어주면 된다.

CRUD 속성

속성
id	쿼리문의 식별자
resultType	select시 결과의 데이터 타입
resultMap	resultMap으로 맵핑된 데이터를 select시 결과의 데이터 타입
parameterType	매개변수의 데이터 타입

동적SQL

MyBatis는 동적 sql로 태그를 통해 상황에 따라 여러가지 케이스를 처리할 수 있다.

<if test=”조건”>SQL</if>	조건이 참일 경우 SQL문을 반환한다.
<choose> <when test=”조건1”>SQL</when> <when test=”조건2”>SQL</when> <otherwise>SQL</otherwise> <choose>	검사할 조건이 여러개일 경우 사용 자바의 switch문과 유사하다. 일치하는 조건이 없으면 <otherwise>반환된다.
<where> <if test=”조건1”>SQL</if> <if test=”조건2”>SQL</if> </where>	SQL문의 WHERE절을 만들때 사용한다. <where> 안의 조건식에서 일치하는 조건이 있으면 WHERE절을 만들어 반환하고 없으면 만들지 않는다.
<trim prefix=”접두어” prefixOverrides=”문자열|문자열”> <if test=”조건1”>SQL</if> <if test=”조건2”>SQL</if></trim>	prefix=”where(set)” 속성을 사용하여 WHERE와 SET을 구현 prefixOverrides에 지정된 문자열과 일치하는 문자열을 제거하고 prefix로 지정한 접두어를 붙인다.
<set> <if test=”조건1”>SQL</if> <if test=”조건2”>SQL</if> </set>	UPDATE문의 SET절을 만들때 사용한다. <set> 안의 조건식에서 일치하는 조건이 있으면 SET절을 만들어 반환하고 없으면 만들지 않는다. SET절의 항목이 여러 개일 경우 자동으로 콤마(,)를 붙인다.
<foreach item=”항목” index=”인덱스” collection=”목록” open=”시작문자열” close=”종료문자열” separator=”구분자”> </foreach>	목록형 데이터로 SQL문을 만들때 사용한다. 특히 IN(값, 값, …) 조건을 만들때 편리하다. item : 한 개의 항목을 가리키는 변수 이름 지정 index : 인덱스 값을 꺼낼때 사용할 변수 이름 지정 collection : java.util.List 구현체나 배열 객체 지정 open : 최종 반환값의 접두어 지정 close : 최종 반환값의 접미어 지정 separator : 구분자 문자열 지정
<bind name=”변수명” value=”값”/>	변수를 생성할때 사용

참고: https://atoz-develop.tistory.com/entry/MyBatis-%EB%8F%99%EC%A0%81-SQL-choose%EC%99%80-set%EC%9D%84-%EC%82%AC%EC%9A%A9%ED%95%98%EC%97%AC-%EB%8F%99%EC%A0%81-SQL-%EB%A7%8C%EB%93%A4%EA%B8%B0

그외 알아 두면 좋은 Tag

<sql id=”식별자”>	자주쓰이는 sql문을 콤퍼넌트 모듈화(?)하여 재사용성을 줌
<include refid=”sql태그”>	<sql>로 만들어둔 쿼리문을 불러옴

예제

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE mapper
		PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
		"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="UserMapper10">

  	<resultMap id="userSelectMap" type="user">
  		<result property="userId" column="user_id" jdbcType="VARCHAR" />
  		<result property="userName" column="user_name" jdbcType="VARCHAR" />
  		<result property="password" column="password" jdbcType="VARCHAR" />
  		<result property="age" column="age" jdbcType="INTEGER" />
  		<result property="grade" column="grade" jdbcType="NUMERIC" />
  		<result property="regDate" column="regDate" jdbcType="DATE" />
  	</resultMap>
  	
   	<insert 	id="addUser" 	parameterType="user">
		INSERT
		INTO users(user_id, user_name, password,age, grade ,reg_date)
		VALUES( #{userId},
				#{userName},
				#{password},
				#{age:INTEGER},
				<if test="grade==0">null</if>
				<if test="grade!=0">#{grade}</if>,
				#{regDate:DATE})    											
  	</insert>
  	
  	<select id="getUser" parameterType="string" resultMap="userSelectMap">
  		SELECT
  		user_id	,user_name ,password ,age ,grade ,reg_date 
  		FROM users
  		WHERE user_id = #{value}
  	</select>
  	
  	<update id="updateUser" parameterType="user">
  		UPDATE users
  		<set>
  			<if test="userName != null">user_name = #{userName},</if>
  			<if test="password != null">password = #{password},</if>
  										age = #{age:INTEGER},
  										grade = <if test="grade == 0">null</if>
  												<if test="grade != 0">#{grade}</if>
  		</set>
  		WHERE user_id = #{userId}
  	</update>
  	
  	<delete id="removeUser" parameterType="java.lang.String">
  		DELETE
  		FROM users
  		WHERE user_id = #{value}
  	</delete>
  	 
  	<sql id="select-users">
  		SELECT
  		user_id , user_name , password , age , grade , reg_date
  		FROM users
  	</sql>
  	
  	<sql id="orderby-userId-desc">
  		ORDER BY user_id DESC
  	</sql>
  	
  	<select id="getUserList" parameterType="mybatis.service.domain.Search" resultMap="userSelectMap">
  		<include refid="select-users"/>
  		<where>
  			<choose>
  				<when test="searchCondition == 'userId'">
  					<if test="userId.size != 0">
						user_id IN
						<foreach item="value" collection="userId" open="(" separator="," close=")">
							#{value}
						</foreach>
  					</if>
  				</when>
  				<when test="searchCondition == 'userName'">
  					<if test="userName[0] != null">
						user_name IN
					<foreach item="value" collection="userName" open="(" separator="," close=")">
						#{value}
					</foreach>
  					</if>
  				</when>
  			</choose>
  			
  			<!-- trim 과 where 사용 가능 
  			<if test="searchCondition == 'userId'">
  				<if test="userId.size != 0">
					user_id IN
					<foreach item="value" collection="userId" open="(" separator="," close=")">
						#{value}
					</foreach>
  				</if>
  			</if>
  			<if test="searchCondition == 'userName'">
  				<if test="userName[0] != null">
					user_name IN
				<foreach item="value" collection="userName" open="(" separator="," close=")">
					#{value}
				</foreach>
  				</if>
  			</if>
  			 -->
		</where>
  		<include refid="orderby-userId-desc"/>
  	</select>
  	
</mapper>