MyBatis | Mapper | パラメータを複数の引数に分けて渡す

ソースコード

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

  <select id="selectByStringOrNumber" resultType="sample.mybatis.TestTable">
    select *
      from test_table
     where string = #{string}
        or number = #{number}
  </select>
</mapper>

TestTableMapper.java

package sample.mybatis;

import java.util.List;

import org.apache.ibatis.annotations.Param;

public interface TestTableMapper {

    List<TestTable> selectByStringOrNumber(
        @Param("string") String string,
        @Param("number") int number
    );
}

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.selectByStringOrNumber("hoge", 300).forEach(System.out::println);
            }
        }
    }
}

実行結果

[DEBUG] s.m.T.selectByStringOrNumber - ==>  Preparing: select * from test_table where string = ? or number = ? 
[DEBUG] s.m.T.selectByStringOrNumber - ==> Parameters: hoge(String), 300(Integer)
[DEBUG] s.m.T.selectByStringOrNumber - <==      Total: 2
TestTable [id=1, string=hoge, number=100]
TestTable [id=3, string=piyo, number=300]

説明

  • パラメータが存在する場合に、メソッドの引数をそれぞれ分けて定義するには、引数に@Paramアノテーションを付ける。
  • @Paramのvalueにはパラメータ名を指定する。