MyBatis | 動的SQL | foreach

DBテーブル

test_table

id
1
2
3
4
5

ソースコード

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">

  <select id="selectTest" resultType="sample.mybatis.TestTable">
    select *
      from test_table
     where id in
     <foreach collection="list" item="item"
              open="(" separator="," close=")">
       #{item}
     </foreach>
  </select>
</mapper>

Main.java

package sample.mybatis;

import java.io.InputStream;
import java.util.Arrays;

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()) {
                session
                    .selectList("sample.mybatis.selectTest", Arrays.asList(1, 3, 5))
                    .forEach(System.out::println);
            }
        }
    }
}

実行結果

[DEBUG] s.m.selectTest  - ==>  Preparing: select * from test_table where id in ( ? , ? , ? ) 
[DEBUG] s.m.selectTest  - ==> Parameters: 1(Integer), 3(Integer), 5(Integer)
[DEBUG] s.m.selectTest  - <==      Total: 3
TestTable [id=1]
TestTable [id=3]
TestTable [id=5]

説明

  • <foreach>タグを使用すると、コレクションを繰り返しながらSQLを作成できる。
  • collection属性には、繰り返し処理するコレクションを指定する。
    • listは、パラメータに反復可能なオブジェクトを渡すとデフォルトで使用できる参照名である。特殊パラメータ名を参照。
  • item属性では、繰り返しの各要素を参照する一時変数名を宣言する。
  • open属性は、繰り返しの開始部分に追加する文字列を指定する。
  • separator属性は、各繰り返し結果の間に挿入する文字列を指定する。
  • close属性は、繰り返しの最後に追加する文字列を指定する。
  • index属性もあり、繰り返されるインデックス値を参照するための一時変数名を宣言できる。 主にIN句の動的生成に利用する。