MyBatis | プログラムでSQLを動的に生成

Tags:

MyBatisには、アノテーションを使用してSQLを定義する方法が用意されている。

しかし、文字列連結でSQLを組み立てる場合、カンマ区切りやAND、ORの区切りなど、注意すべき細かな点がいくつもある。

MyBatisは、そのような面倒な部分を隠す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"> <!-- namespaceにMapperを指定 -->
</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を文字列として取得できる。