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

• 관련 글

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

- MyBatis 설정 파일 작성 방법

---

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

환경 및 버전 정보

IntelliJ IDEA 2019.3 Ultimate, JDK 11, Tomcat 9, MyBatis 3

 

MyBatis

Persistence framework 중 하나인 MyBatis를 사용하면 JDBC 프로그래밍 없이 DB와 연동할 수 있다. 개발자가 JDBC API를 직접 호출하지 않고 MyBatis가 대신 호출하는 방식이다.

MyBatis의 핵심은 개발과 유지보수가 쉽도록 소스 코드에 내장돼있는 SQL을 별도의 파일로 분리하는 것이다. 또한 단순하고 반복적인 JDBC 코드를 캡슐화하여 데이터베이스 프로그래밍을 간결하게 만든다.

 

1. MyBatis 라이브러리 준비

https://github.com/mybatis 에 접속한다.

 

Pinned repositories에서 mybatis-3을 클릭한다.

 

README.md에서 Download Latest를 클릭한다.

 

Assets에서 mybatis-3.5.4.zip을 클릭한다.

 

압축을 풀면 JAR 파일과 사용 설명 PDF 파일, 의존 라이브러리 JAR파일이 있다.

 

mybatis-3.5.4.jar 파일과 의존 라이브러리 파일들을 웹 프로젝트에 추가한다.

 

IntelliJ IDEA Project Structure - dependencies

 

2. DAO 변경

MyBatis 프레임워크를 사용함으로써 이제 DB 연동은 MyBatis가 대신한다.

JDBC 프로그래밍 대신, MyBatis의 SqlSessionFactory 컴포넌트를 사용하도록 변경하고 DAO의 SQL문을 별도의 파일로 분리할 차례이다.

 

1) SqlSessionFactory

// myBatis - SqlSessionFactory: SqlSession 객체 생성
private SqlSessionFactory sqlSessionFactory;
 
public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
    this.sqlSessionFactory = sqlSessionFactory;
}

우선 DAO 클래스에 SqlSessionFactory 인스턴스 변수와 setter를 선언한다.

MyBatis에서는 SqlSession 객체가 실제 SQL을 실행하는데, SqlSession 객체는 SqlSessionFactory로부터 얻을 수 있다.

DAO가 필요로하는 SqlSessionFactory는 외부에서 주입될 수 있도록 setter를 선언하는 것이다.

 

2) Select

먼저 MyBatis를 이용한 select 구현 방법을 알아보자.

 

selectList()

@Override
public List<Project> selectList() throws SQLException {
 
    // myBatis - SqlSession: SQL 실행
    // openSession(): SqlSession 얻기
    SqlSession sqlSession = sqlSessionFactory.openSession();
 
    try {
        // selectList(): SELECT
        // 파라미터: SQL 맵퍼의 네임 스페이스(com.atoz_develop.spms.dao.ProjectDao) + SQL문 ID(selectList)
        return sqlSession.selectList("com.atoz_develop.spms.dao.ProjectDao.selectList");
    } finally {
        sqlSession.close();
    }
}

SqlSessionFactory 객체의 openSession()을 호출해서 SqlSession을 얻는다.

SqlSession은 MyBatis에서 실제 SQL 실행을 담당하는 컴포넌트이다. 즉 SQL을 실행하려면 SqlSession이 필요하며, 이 객체가 JDBC 드라이버를 사용한다.

 

SqlSession 객체의 selectList()를 호출해서 select문을 실행할 수 있다.

파라미터로는 SQL mapper의 네임 스페이스와 SQL문 id를 합친 문자열을 넘긴다.

위 코드에서 com.atoz_develop.spms.dao.ProjectDao가 네임 스페이스, selectList가 SQL문 id에 해당한다.

 

마지막으로 finally 블록에서 SqlSession 객체의 close()를 호출해서 SQL문을 실행할 때 사용한 자원을 해제해준다.

 

selectOne()

@Override
public Project selectOne(int no) throws SQLException {
 
    SqlSession sqlSession = sqlSessionFactory.openSession();
    try {
        return sqlSession.selectOne("com.atoz_develop.spms.dao.ProjectDao.selectOne", no);
    } finally {
        sqlSession.close();
    }
}

한 개 데이터를 select 해올 때는 selectOne() 메소드를 호출한다.

selectList()와 달리 두 번째 파라미터에 조건절에서 사용할 데이터를 넘긴다.

이 두 번째 파라미터의 타입은 Object, 즉 객체를 넘겨야 하지만 int와 같은 기본 데이터 타입을 넘겨도 컴파일 시 auto boxing이 수행돼서 변환 없이 그대로 넘겨도 된다.

 

3) Insert

insert()

@Override
public int insert(Project project) throws SQLException {
//        SqlSession sqlSession = sqlSessionFactory.openSession(true);  // auto commit
    SqlSession sqlSession = sqlSessionFactory.openSession();
 
    try {
        // insert(): INSERT
        int count = sqlSession.insert("com.atoz_develop.spms.dao.ProjectDao.insert", project);
        sqlSession.commit();
 
        return count;
    } finally {
        sqlSession.close();
    }
}

Insert문은 SqlSession 객체의 insert()를 호출해서 실행할 수 있다.

selectList()와 마찬가지로 첫 번째 파라미터는 SQL mapper의 네임 스페이스와 SQL id를 합친 문자열을 넘긴다.

두 번째 파라미터로는 insert문을 실행할 때 필요한 프로퍼티를 가진 VO 객체를 넘긴다.

 

insert() 호출 후 commit()을 호출한다.

SqlSession 객체를 얻을 때 openSession(true)와 같이 호출하면 INSERT, UPDATE, DELETE문 실행 시 auto commit을 수행하는 SqlSession 객체를 얻을 수 있다.

 

4) Update

update()

@Override
public int update(Project project) throws SQLException {
 
    SqlSession sqlSession = sqlSessionFactory.openSession();
    try {
        int count = sqlSession.update("com.atoz_develop.spms.dao.ProjectDao.update", project);
        sqlSession.commit();
        return count;
    } finally {
        sqlSession.close();
    }
}

UPDATE문은 SqlSession 객체의 update()를 호출해서 실행할 수 있다.

문법은 이전과 동일하므로 생략한다.

 

5) Delete

delete()

@Override
public int delete(int no) throws SQLException {
 
    SqlSession sqlSession = sqlSessionFactory.openSession();
    try {
        int count = sqlSession.delete("com.atoz_develop.spms.dao.ProjectDao.delete", no);
        sqlSession.commit();
        return count;
    } finally {
        sqlSession.close();
    }
}

DELETE문은 SqlSession 객체의 delete()를 호출해서 실행할 수 있다.

문법은 이전과 동일하므로 생략한다.

 

이렇게 SQL문 명령어와 SqlSession 객체의 메소드명이 거의 동일해서 호출 시 파라미터만 유의해서 넘겨주면 크게 어려움 없이 DAO를 변경할 수 있다.

 

3. SQL Mapper 파일 작성

SqlSession이 SQL문을 실행할때 참조하는 SQL mapper 파일을 작성한다.

즉 원래 DAO 클래스에 내장돼있던 SQL문을 이 SQL mapper 파일로 분리해주는 것이다.

DAO 패키지에 xml 파일을 생성하고 아래와 같이 작성한다.

필요한 resultMap과 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="com.atoz_develop.spms.dao.ProjectDao">
    <resultMap type="project" id="projectResultMap">
        <id column="PNO" property="no" />
        <result column="PNAME" property="title" />
        <result column="CONTENT" property="content" />
        <result column="STA_DATE" property="startDate" javaType="java.sql.Date" />
        <result column="END_DATE" property="endDate" javaType="java.sql.Date" />
        <result column="STATE" property="state" />
        <result column="CRE_DATE" property="createdDate" javaType="java.sql.Date" />
        <result column="TAGS" property="tags" />
    </resultMap>
 
    <select id="selectList" resultMap="projectResultMap">
        select PNO, PNAME, STA_DATE, END_DATE, STATE
        from PROJECTS
        order by PNO desc
    </select>
 
    <insert id="insert" parameterType="project">
        insert into PROJECTS(PNAME, CONTENT, STA_DATE, END_DATE, STATE, CRE_DATE, TAGS)
        values (#{title}, #{content}, #{startDate}, #{endDate}, 0, NOW(), #{tags})
    </insert>
 
    <select id="selectOne" parameterType="int" resultMap="projectResultMap">
        select PNO, PNAME, CONTENT, STA_DATE, END_DATE, STATE, CRE_DATE, TAGS
        from PROJECTS
        where PNO = #{no}
    </select>
 
    <update id="update" parameterType="project">
        update PROJECTS set
            PNAME = #{title},
            CONTENT = #{content},
            STA_DATE = #{startDate},
            END_DATE = #{endDate},
            STATE = #{state},
            TAGS = #{tags}
        where PNO = #{no}
    </update>
 
    <delete id="delete" parameterType="int">
        delete from PROJECTS
        where PNO = #{no}
    </delete>
</mapper>

 

자세한 작성 방법은 MyBatis 설정 파일 - SQL Mapper 작성 방법 포스트를 참고한다.

 

SQL mapper 파일에서 <mapper>의 namespace값 과 <select>, <insert>, <update>, <delete>의 id 값은 SqlSession 객체가 SQL문을 찾을 때 사용한다.

DAO 클래스에서 SqlSession의 selectList(), selectOne(), insert(), update(), delete() 메소드를 호출할 때 넘기는 문자열 값과 매핑되는 것이다.

 

4. MyBatis 설정 파일 작성

MyBatis 설정 파일에는 DB 커넥션을 생성하는 data source에 대한 정보, 트랜잭션 관리자, MyBatis 동작을 제어하는 환경값, SQL mapper 파일 경로 등을 설정한다.

DAO 패키지에 xml 파일을 생성하고 다음과 같이 작성한다.

상세한 설정값은 각자 프로젝트에 맞게 변경한다.

 

<?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>

 

5. 프로퍼티 파일 작성

MyBatis 설정 파일의 <properties resource="...">에 지정한 프로퍼티 파일을 작성한다.

이 파일은 DB 접속 정보를 담는다.

 

driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3307/spms
username=username
password=password

 

6. SqlSessionFactory 객체 생성

DAO에서 SqlSessionFactory의 setter를 선언해 주었다.

외부에서 SqlSessionFactory 객체를 생성하고 주입해주어야 한다.

SqlSessionFactory는 SqlSessionFactoryBuilder 객체를 통해 생성할 수 있는데 build()를 호출해서 위에서 작성한 MyBatis 설정 파일의 입력 스트림을 넘겨주어야 한다.

 

String resource = "com/atoz_develop/spms/dao/mybatis-config.xml";
// Resources.getResourceAsStream(): ClASSPATH 경로에 있는 파일의 입력 스트림 얻음
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

 

MyBatis 설정 파일은 보통 CLASSPATH에 위치시키는데, CLASSPATH에 있는 파일의 입력스트림은 Resources 클래스의 getResourceAsStream()을 이용해서 손쉽게 얻을 수 있다.

 

이렇게 생성한 sqlSessionFactory를 DAO에 주입시켜주면 MyBatis 사용에 필요한 모든 구현이 완료된다.

서버 기동 후 이전과 동일하게 모든 기능이 정상 동작하는지 확인해보자.

 

#MyBatis 설정파일

#MyBatis SQL Mapper

---

• 관련 글

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

- MyBatis 설정 파일 작성 방법

 

References

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