MyBatis | 프로그램에서 SQL을 동적으로 생성

MyBatis 어노테이션을 사용하여 SQL을 정의하는 방법이 제공된다.

그러나 문자열 연결에서 SQL을 조립하고 쉼표 구분이라든지 AND, OR 구분 등 주의해야 하는 세세한 것들이 여러 가지가 있다.

그 부분에 대해 귀찮은 부분을 감추는 API를 제공하고 있다.

소스 코드

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을 namespace에 지정 -->
</mapper>

TestTableMapper.java

package sample.mybatis;

import java.util.List;

import org.apache.ibatis.annotations.SelectProvider;

// Mapper 인터페이스로 만든다
public interface TestTableMapper {
    // @SelectProvider으로 SQL을 생성하는 클래스 메소드를 설정한다
    @SelectProvider(type=TestTableSqlProvider.class, method="getSelectTestSql")
    List<TestTable> selectTest();
}

TestTableSqlProvider.java

package sample.mybatis;

import org.apache.ibatis.jdbc.SQL;

// SQL을 생성하는 클래스
public class TestTableSqlProvider {

    // SQL을 생성하는 메소드
    public String getSelectTestSql() {
        // SQL 클래스를 사용하여 SQL을 생성한다.
        SQL sql = new SQL() {{ // 익명의 클래스 생성
            SELECT("id, hoge_value");
            SELECT("fuga_value");
            SELECT("piyo_value");
            FROM("test_table");
        }};

        return sql.toString();
    }
}

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()) {
                TestTableMapper mapper = session.getMapper(TestTableMapper.class);
                mapper.selectTest();
            }
        }
    }
}

실행 결과

[DEBUG] s.m.T.selectTest - ==>  Preparing: SELECT id, hoge_value, fuga_value, piyo_value FROM test_table WHERE (hoge_value is not null) 
[DEBUG] s.m.T.selectTest - ==> Parameters: 

설명

  • Mapper의 메소드를 @SelectProvider에서 어노테이션을 지정한다.
    • type에 SQL을 생성하는 클래스로 하고, method에 SQL을 생성하는 메소드의 이름을 지정한다.
    • INSERT 또는 UPDATE에는 @InsertProvider과 @UpdateProvider가 있다.
  • SQL 생성에는 org.apache.ibatis.jdbc.SQL 클래스를 사용한다.
  • SQL 클래스를 익명 클래스로 new하여 인스턴스 초기화 블록에서 SELECT()와 FROM() 메소드를 사용하여 SQL을 생성한다.
    • 각 인수는 문자열에서 SQL의 항목을 전달한다.
    • 이때 쉼표 구분 등은 필요에 따라 추가되기도 한다.
  • 생성된 SQL 인스턴스의 toString() 메소드에서 생성한 SQL을 문자열로 검색할 수 있다.