MyBatis | Mapper | 기본

DB 테이블

test_table

id string number
1 hoge 100
2 fuga 200
3 piyo 300

소스 코드

TestTable.java

package sample.mybatis;

public class TestTable {
    private int id;
    private String string;
    private int number;

    @Override
    public String toString() {
        return "TestTable [id=" + id + ", string=" + string + ", number=" + number + "]";
    }
}

sample_mapper.xml

<?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="sample.mybatis.TestTableMapper"> <!-- Mapper의 FQCN을 namespace으로 한다. -->

  <select id="selectAll" resultType="sample.mybatis.TestTable">
    select *
      from test_table
  </select>
</mapper>

TestTableMapper.java

package sample.mybatis;

import java.util.List;

// Mapper 인터페이스
public interface TestTableMapper {

    // Statement ID와 같은 이름의 메소드 정의
    List<TestTable> selectAll();
}

Main.java

package sample.mybatis;

import java.io.InputStream;

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

public class Main {

    public static void main(String[] args) throws Exception {
        try (InputStream in = Main.class.getResourceAsStream("/mybatis-config.xml")) {
            SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);

            try (SqlSession session = factory.openSession()) {
                // Mapper의 인스턴스를 얻는다.
                TestTableMapper mapper = session.getMapper(TestTableMapper.class);

                mapper.selectAll().forEach(System.out::println);
            }
        }
    }
}

실행 결과

[DEBUG] s.m.T.selectAll - ==>  Preparing: select * from test_table 
[DEBUG] s.m.T.selectAll - ==> Parameters: 
[DEBUG] s.m.T.selectAll - <==      Total: 3
TestTable [id=1, string=hoge, number=100]
TestTable [id=2, string=fuga, number=200]
TestTable [id=3, string=piyo, number=300]

설명

  • Mapper를 사용하는 경우, 전용 인터페이스를 정의한다(TestTableMapper).
    • 이 인터페이스의 메소드와 설정 파일의 각 Statement에 대응되도록 하여 각각을 정의한다.
    • Statement에서는 namespace를 인터페이스의 FQCN한다(sample.mybatis.TestTableMapper).
    • Statement ID와 인터페이스의 메소드 이름과 일치시킨다(selectAll).
    • 매개 변수가 존재하는 경우는 메소드에 인수를 전달하도록 정의한다.
  • Mapper 인스턴스는 SqlSession의 getMapper() 메소드로 취득한다.