MyBatis | 동적 SQL | where, trim

DB 테이블

test_table

id	string	number
1	hoge	100
2	hoge	200
3	fuga	200
4	piyo	400

소스 코드

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>
      <if test="string != null">
        and string = #{string}
      </if>
      <if test="number != null">
        and number = #{number}
      </if>
    </where>
  </select>
</mapper>

Main.java

package sample.mybatis;

import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;

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()) {
                // 매개 변수를 빈 오브젝트로 실행
                Map<String, Object> param = new HashMap<>();
                selectAndPrint(session, param);

                // 매개 변수를 string만 지정해서 실행
                param = new HashMap<>();
                param.put("string", "hoge");
                selectAndPrint(session, param);

                // 매개 변수를 string과 number를 지정해서 실행
                param = new HashMap<>();
                param.put("string", "hoge");
                param.put("number", 200);
                selectAndPrint(session, param);
            }
        }
    }

    private static void selectAndPrint(SqlSession session, Map<String, Object> param) {
        session
            .selectList("sample.mybatis.selectTest", param)
            .forEach(System.out::println);
        System.out.println();
    }
}

실행 결과

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

[DEBUG] s.m.selectTest  - ==>  Preparing: select * from test_table WHERE string = ? 
[DEBUG] s.m.selectTest  - ==> Parameters: hoge(String)
[DEBUG] s.m.selectTest  - <==      Total: 2
TestTable [id=1, string=hoge, number=100]
TestTable [id=2, string=hoge, number=200]

[DEBUG] s.m.selectTest  - ==>  Preparing: select * from test_table WHERE string = ? and number = ? 
[DEBUG] s.m.selectTest  - ==> Parameters: hoge(String), 200(Integer)
[DEBUG] s.m.selectTest  - <==      Total: 1
TestTable [id=2, string=hoge, number=200]

설명

<where> 태그를 사용하면, 자식 요소가 어떤 문자열이 존재하는 경우에만 WHERE 절을 선두에 추가해주게 된다.
또한 <where> 태그 내의 문자열이 AND 또는 OR로 시작하면 자동으로 그 조건 연결문이 제거된다.
이 동작은 <if> 등 만으로 작성하게 되면 상당히 복잡한 작성이 되어 버리지만, 이 <where> 태그를 사용해서 간단히 작성할 수 있다.

trim 태그로 대체

위의 <where>를 사용한 정의는 <trim> 태그를 사용하여 다음과 같이 바꿀 수 있다.

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
    <trim prefix="where" prefixOverrides="AND|OR">
      <if test="string != null">
        and string = #{string}
      </if>
      <if test="number != null">
        and number = #{number}
      </if>
    </trim>
  </select>
</mapper>

prefix 속성에 앞에 추가할 문자열를 추가한다.
prefixOverrides 속성에 처음부터 제거하는 문자열을 파이프 (|)로 구분한다.

최종 수정 : 2021-08-26