[JSP] MyBatis란 ?

🚀 MyBatis란?

기존 JSP에서 데이터베이스와의 통신을 하려면 JDBC를 이용하여 자바를 무조건 거쳐야 했습니다. 따라서 자바에서 불가피하게 SQL 코드가 작성되었고, 자바와 SQL이 섞이다 보면 코드가 길어지고 섞여 유지보수와 분업이 쉽지 않았습니다. 이러한 불편함을 해소하기 위해 myBatis를 이용합니다.

MyBatis 구조

myBatis는 기존의 JDBC 방식과는 달리 SQL문을 XML 파일에 작성함으로써 코드가 줄어들고, SQL문 수정이 편해집니다. 또한 DBCP(Databse Connection Pool)를 사용하여 커넥션을 여러 개 생성하기 때문에 JDBC만 사용하는 것보다 작업 효율과 가독성이 좋아집니다.

DBCP(Database Connection Pool)로 DB연결

사용자 요청이 있을 때마다 DB연결을 한다면, 많은 요청이 있을 때 연결 속도가 저하될 수 있습니다. 따라서 미리 Connection을 만들어 두고, 필요시 저장된 공간에서 가져다 쓴 후 반환하는 기법입니다.

MyBatis 작동순서

시작

1. 응용 프로그램이 SqlSessionFactoryBuilder를 통해 SqlSessionFactory를 빌드하도록 요청한다

2. SqlSessionFactoryBuilder는 SqlSessionFactory를 생성하기 위한 MyBatis 구성파일을 읽는다

3. SqlSessionFactoryBuilder는 MyBatis 구성 파일의 정의에 따라 SqlSessionFactory를 생성한다

요청

4. 클라이언트가 응용 프로그램에 대한 프로세스(실행된 프로그램, 쓰레드풀에 요청)을 요청한다.

5. 응용 프로그램은 SqlSessionFactoryBuilder를 사용하여 빌드된 SqlSessionFactory에서 SqlSession을 가져온다(메모리에 할당한다)

6. SqlSessionFactory는 SqlSession을 생성하고 이를 Application에 반환한다

7. 응용 프로그램이 SqlSession에서 매퍼 인터페이스의 구현 개체를 가져온다

8. 응용 프로그램이 매퍼 인터페이스의 메소드를 호출한다

9. 매퍼 인터페이스의 구현 개체가 SqlSession의 메소드를 호출하고 SQL실행을 요청한다

10. SqlSession은 매핑 파일에서 실행한 SQL을 가져와 SQL을 실행한다

MyBatis 작업순서 정리

1. 테이블 생성

2. VO 객체 생성

3. mapper.xml에서 쿼리문 작성

4. config.xml에 datasource 설정

5. config.xml에 mapper.xml 경로 등록

6. SqlSessionFactory에 config.xml 전달

7. DAO에서 mapper.xml에 작성한 쿼리 실행

 

위와 같은 순서로 한번 작업을 해봅시다!

1. 테이블 생성

저는 DBeaver라는 데이터베이스 관리 도구를 통해 MySQL을 연결하여 사용하고 있습니다.

이를 통해 간단한 테이블을 하나 생성해보겠습니다.

create database mybatis;
use mybatis;

create table tbl_member(
    member_id int unsigned auto_increment primary key,
    member_name varchar(500),
    member_age tinyint unsigned
);

2. VO객체 만들기

1에서 만든 테이블의 컬럼과 동일하게 필드를 가지고 있는 객체를 만들어줍니다. 이때 VO(Value Object)는 어떠한 로직도 가지지 않은 순수한 데이터 객체입니다. 위에서 회원을 관리할 테이블을 만들었기 때문에 지금 작성하는 VO이름도 MemberVO로 합니다.

📜 src/com.mybatis.vo (package) / MemberVO.java 파일

package com.mybatis.vo;

public class MemberVO {
	private Long memberId;
	private String memberName;
	private int memberAge;
	
	public MemberVO() {;}

	public Long getMemberId() {
		return memberId;
	}

	public void setMemberId(Long memberId) {
		this.memberId = memberId;
	}

	public String getMemberName() {
		return memberName;
	}

	public void setMemberName(String memberName) {
		this.memberName = memberName;
	}

	public int getMemberAge() {
		return memberAge;
	}

	public void setMemberAge(int memberAge) {
		this.memberAge = memberAge;
	}

	@Override
	public String toString() {
		return "MemberVO [memberId=" + memberId + ", memberName=" + memberName + ", memberAge=" + memberAge + "]";
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((memberId == null) ? 0 : memberId.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		MemberVO other = (MemberVO) obj;
		if (memberId == null) {
			if (other.memberId != null)
				return false;
		} else if (!memberId.equals(other.memberId))
			return false;
		return true;
	}
}

3. mapper.xml에서 쿼리문 작성

mapper.xml에서 쿼리문을 작성할 건데, 보통 서비스 카테고리 별로 mapper 파일을 생성합니다. 따라서 저는 이번에 회원관리 서비스와 관련된 로직 및 쿼리문을 작성할 것이므로 memberMapper.xml 이라는 이름으로 mapper 파일을 생성해서 작업해보도록 하겠습니다.

 

📜 src/com.mybatis.mapper (package) / memberMapper.xml 파일

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="member">
    <insert id="insert" parameterType="memberVO">
        insert into tbl_member(member_name, member_age)
        values(#{memberName}, #{memberAge})
    </insert>
    
    <select id="select" resultType="long">
        select member_id from tbl_member where member_name=#{memberName} and member_age=#{memberAge}
    </select>
    
    <select id="selectAll" resultType="memberVO">
        select member_id, member_name, member_age from tbl_member
    </select>
</mapper>

4, 5. config.xml에 datasource 설정 & mapper.xml 경로 등록

📜 src/com.mybatis.config (package) / config.xml 파일

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "https://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
	<settings>
		<setting name="mapUnderscoreToCamelCase" value="true"/>
	</settings>

	<typeAliases>
		<typeAlias type="com.mybatis.vo.MemberVO" alias="memberVO"/>
	</typeAliases>

	<environments default="mysql">
		<environment id="mysql">
			<transactionManager type="JDBC"/>
			<dataSource type="POOLED">
				<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
				<property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
				<property name="username" value="root"/>
				<property name="password" value="1234"/>
			</dataSource>
		</environment>
	</environments>
	
	<mappers>
		<mapper resource="com/mybatis/mapper/memberMapper.xml"/>
	</mappers>
</configuration>

6. SqlSessionFactory에 config.xml 전달

📜 src/com.mybatis.config (package) / MyBatisConfig.java 파일

package com.mybatis.config;

import java.io.IOException;
import java.io.Reader;

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

public class MyBatisConfig {
	private static SqlSessionFactory sqlSessionFactory;
	
	static {
		String resource = "com/mybatis/config/config.xml";
		try {
			Reader reader = Resources.getResourceAsReader(resource);
			sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
	
	public static SqlSessionFactory getSqlSessionFactory() {
		return sqlSessionFactory;
	}
}

7. DAO에서 mapper에 작성한 쿼리 실행하는 로직 함수 작성

📜 src/com.mybatis.dao (package) / MemberDAO.java 파일

package com.mybatis.dao;

public class MemberDAO {
    public SqlSession sqlSession;
    
    public MemberDAO() {
        sqlSession = MyBatisConfig.getSqlSessionFactory().openSession(true);
    }
    
    // 회원 가입
    public void insert(MemberVO memberVO) {
        sqlSession.insert("member.insert", memberVO);
    }
    
    // 전체 조회
    public List<MemberVO> selectAll() {
        return sqlSession.selectAll("member.selectAll");
    }
}

8. 실행해보자

📜 src/ com.mybatis.dao (package) / Test.java 파일

package com.mybatis.dao;

public class Test {
    public static void main(String[] args) {
        MemberDAO memberDAO = new MemberDAO();
        MemberVO memberVO = new MemberVO();
        
        memberVO.setMemberName("이순신");
        memberVO.setMemberAge(20);
        
        memberDAO.insert(memberVO);
    }
}

실행하고 데이터베이스를 확인하면 insert 되어 있음을 확인할 수 있었습니다 :)