Mybatis 프로젝트

 

Spring Quick Start(책)의 Day5 class01~02 실습을 진행하면서 기록한 내용입니다.

실습한 코드의 링크입니다.

---

Mybatis 프레임워크의 중요한 특징

1. 한 두줄의 자바 코드로 dB 연동을 처리한다

2. SQL 명령어를 java 코드에서 분리하여 XML 파일에 따로 관리한다.

Mybatis 프레임워크를 Data Mapper라고 부른다.

Mybatis는 xmL 파일에 저장된 SQL 명령어를 대신 실행하고 실행 결과를 VO 같은 객체에 자동으로 매핑까지 해준다.

---

====Mybatis 프로젝트 작성방법====

1. pom.xml에 dependency 등록하기

<!-- MySQL -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.21</version>
</dependency>
<!-- Mybatis -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.6</version>
</dependency>
<!-- Ibatis -->
<dependency>
    <groupId>org.apache.ibatis</groupId>
    <artifactId>ibatis-core</artifactId>
    <version>3.0</version>
</dependency>

2. VO 클래스 작성하기

XML 파일에 저장된 SQL 명령어에서 사용자가 입력한 값들을 전달하고 실행 결과를 매핑하는데 쓰인다.

package com.springbook.biz.board;

import java.util.Date;

public class BoardVO {
	private int seq;
	private String title;
	private String writer;
	private String content;
	private Date regDate;
	private int cnt;
	private String searchCondition;
	private String searchKeyword;

	// getter, setter, toString
}

3. SQL Mapper XML 파일 작성하기

SQL Mapper XML은 DB 연동에 필요한 SQL 명령어들이 저장되는 Mybatis에서 가장 중요한 파일이다.

SQL문은 대소문자를 구분하지 않는데 식별성을 높이기 위해 일반적으로 대문자로 작성한다.

[resource/mappings/board-mapping.xml]

<mapper namespace="BoardDAO">
    <insert id="insertBoard1">
		SET @mymax := (SELECT MAX(SEQ) FROM BOARD);
	</insert>
    <insert id="insertBoard2">
		INSERT INTO BOARD(SEQ, TITLE, WRITER, CONTENT)
		VALUES (IFNULL(@mymax, 0)+1,#{title},#{writer},#{content});
	</insert>

    <update id="updateBoard">
		UDDATE BOARD SET TITLE=#{title}, CONTENT=#{content} WHERE SEQ=#{seq}
	</update>

    <delete id="deleteBoard">
		DELETE BOARD WHERE SEQ=#{seq}
	</delete>

    <select id="getBoard" resultType="board">
		SELECT * FROM BOARD WHERE SEQ=#{seq}
	</select>

    <select id="getBoardList" resultType="board">
		SELECT * FROM BOARD
		WHERE TITLE LIKE '%'||#{searchKeyword}||'%'
		ORDER BY SEQ DESC
	</select>
</mapper>

1줄: 나는 xml 파일이다.

2줄: DTD 선언이다.

 

<mapper>: 루트 엘리먼트이고 namespace 속성으로 DAO 클래스에서 참조할 때 이 값을 쓴다.

 

<select>의 속성에는 id, parameterType, resultType이 있다.

• id: 필수 속성으로 <mapper>의 namespace 가 같은 파일 "안"에서 유일한 아이디를 등록해야 한다.

• parameterType: sql 실행에 필요한 데이터를 외부로부터 받아야할 때 사용한다.

  • parameterType="com.springbook.biz.board.BoardVO" 으로 사용할 수 있고 위와 같이 #{변수명} 사용자 입력값을 설정할 수 있다.

  • 가장 중요한 건 parameterType 속성은 생략할 수 있으며 대부분 생략한다는 것이다.

• resultType: 검색 결과로 ResultSet이 리턴되는데, 어떤 자바 객체에 매핑할지 지정할 때 사용한다.

예시 코드에서 resultType="board"가 가능한 이유는 sql-map-config.xml 파일에서 alias로 등록해놓았기 때문이다.

 

<insert> 구문은 자식 요소로 <selectKey>를 가질 수 있다. 이는 기본 키 필드를 쉽게 가져올 수 있는 방법이다.

검색 결과를 정확하게 하나의 자바 객체로 매핑할 수 없는 경우에 ( 예를 들면 JOIN 구문을 사용할 때) mapper 밑에 <resultMap>엘리먼트를 사용하여 매핑 규칙을 지정하여 사용할 수 있다.

 

SQL 안에서 "WHERE SEQ < #{seq}" 와 같이 부등호를 쓰고 싶다면 CDATA Section을 사용하면 된다.

 

4. Mybatis 메인 환경설정 파일 작성하기

[resource/sql-map-config.xml]

<?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">
<configuration>
	<!-- Properties 파일 설정 -->
	<properties resource="db.properties" />
	<!-- Alias 설정 -->
	<typeAliases>
		<typeAlias alias="board" type="com.springbook.biz.board.BoardVO" />
	</typeAliases>
	<!-- DataSource 설정 -->
	<environments default="development">
		<environment id="development">
			<transactionManager type="JDBC" />
			<dataSource type="POOLED">
				<property name="driver" value="${jdbc.driverClassName}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" value="${jdbc.username}" />
				<property name="password" value="${jdbc.password}" />
			</dataSource>
		</environment>
	</environments>
	<!-- Sql Mapper 설정 -->
	<mappers>
		<mapper resource="mappings/board-mapping.xml" />
	</mappers>
</configuration>

 

5. db.properties 파일 작성하기

데이터베이스 커넥션 관리 프로퍼티 정보가 들어있는 파일이다.

[resource/db.properties]

jdbc.driverClassName=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/springquickstart?serverTimezone=Asia/Seoul&useSSL=false&allowPublicKeyRetrieval=true
jdbc.username=jueun
jdbc.password=jueun

6. SqlSession 객체 생성하기

Mybatis를 이용하여 DAO를 구현하려면 SqlSession 객체가 필요하다.

또 SqlSession 객체를 얻으려면 SqlSessionFactory 객체가 필요하다.

package com.springbook.biz.util;

import java.io.Reader;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class SqlSessionFactoryBean {
	private static SqlSessionFactory sessionFactory = null;
	static {
		try {
			if (sessionFactory == null) {
				// 여기가 핵심코드
				// sql-map-config.xml에서 설정 정보를 읽어들이기 위하 입력 스트림을 생성하고
				// 이 입력 스트림을 통해 SqlSessionFactory 객체를 생성한다.
				Reader reader = Resources.getResourceAsReader("sql-map-config.xml");
				sessionFactory = new SqlSessionFactoryBuilder().build(reader);
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	public static SqlSession getSqlSessionInstance() {
		return sessionFactory.openSession();
	}
}

7. DAO 클래스 작성하기

SqlSession 객체는 Mapper XML에 등록된 SQL을 실행하기 위한 다양한 API를 제공한다.

selectOne(), selectList(), insert(), update(), delete() 메소드이다.

package com.springbook.biz.board.impl;

import java.util.List;

import org.apache.ibatis.session.SqlSession;

import com.springbook.biz.board.BoardVO;
import com.springbook.biz.util.SqlSessionFactoryBean;

public class BoardDAO {
	private SqlSession mybatis;

	public BoardDAO() {
		mybatis = SqlSessionFactoryBean.getSqlSessionInstance();
	}

	public void insertBoard(BoardVO vo) {
		mybatis.insert("BoardDAO.insertBoard", vo);
		mybatis.commit();
	}

	public void updateBoard(BoardVO vo) {
		mybatis.update("BoardDAO.updateBoard", vo);
		mybatis.commit();
	}

	public void deleteBoard(BoardVO vo) {
		mybatis.delete("BoardDAO.deleteBoard", vo);
		mybatis.commit();
	}

	public BoardVO getBoard(BoardVO vo) {
		return (BoardVO) mybatis.selectOne("BoardDAO.getBoard", vo);
	}

	public List<BoardVO> getBoardList(BoardVO vo) {
		return mybatis.selectList("BoardDAO.getBoardList", vo);
	}
}

8. 테스트해보는 클라이언트 작성해서 실행해보기

main > test 폴더 밑에 해당한다.

package com.springbook.biz.board;

import com.springbook.biz.board.impl.BoardDAO;

import java.util.List;

public class BoardServiceClient {
    public static void main(String[] args) {
        BoardDAO boardDAO = new BoardDAO();

        BoardVO vo = new BoardVO();
        vo.setTitle("myBatis 제목");
        vo.setWriter("홍길동");
        vo.setContent("myBatis 내용입니다......");
        boardDAO.insertBoard(vo);

        vo.setSearchCondition("TITLE");
        vo.setSearchKeyword("");
        List<BoardVO> boardVOList = boardDAO.getBoardList(vo);
        for (BoardVO board: boardVOList)
            System.out.println("---> " + board.toString());
    }
}

밑은 잘 실행된 화면이다.

출력 결과