SpringのApplication.ymlで定義した内容をMapperで参照したい

Question

SpringのApplication.ymlに定義した値を、MyBatisのMapperのxmlファイルに記述したSQLで使用したいです。

現在、Application.ymlには以下のような記述があります。

appl_name:
  key1: value1
  key2: value2

このvalue1やvalue2をMyBatisのMapperのSQLにおける、WHERE句の条件指定に使うことはできますか？

Answer 1

MybatisのMapper定義xmlから直接参照することはできませんが、RepositoryなどのJavaクラスからMybatisのSqlSessionTemplateに渡す引数で指定できます。

application:
  key1: ITEM名
  key2: 詳細ITEM名

としたとき、これに対応するConfigurationPropertiesを作成します。

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import lombok.Getter;
import lombok.Setter;

@Component
@ConfigurationProperties("application")
@Getter @Setter
public class ApplicationProperties {
	private String key1;
	private String key2;
}

これを利用するRepositoryクラスにて、例えば以下のようになるでしょう。以下の例では、直接ApplicationPropertiesを渡していますが、もちろん何らかのValueObjectやjava.util.HashMapに格納しなおして、SQLのパラメータにもできます。

import java.util.List;

import org.mybatis.spring.SqlSessionTemplate;
import org.springframework.stereotype.Repository;

import com.github.apz.springsample.component.ApplicationProperties;
import com.github.apz.springsample.model.Item;

import lombok.RequiredArgsConstructor;

@Repository
@RequiredArgsConstructor
public class ItemSearchRepository {
	private final SqlSessionTemplate sqlSessionTemplate;
	private final ApplicationProperties applicationProperties;

	public List<Item> searchAllItems() {
		return sqlSessionTemplate.selectList("items.selectItem", applicationProperties);
	}
}

これを用いるMybatisのmapper定義は以下のようになります。

<?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="items">
	<select id="selectItem" resultMap="itemResult">
		SELECT
			item.ID AS id,
			item.NAME AS name,
			detail.DETAIL_ID AS detailId,
			detail.DETAIL_NAME AS detailName,
			detail.PRICE AS price,
			detail.SALE_START AS saleStart,
			detail.SALE_END AS saleEnd
		FROM
			ITEM item
		INNER JOIN
			ITEM_DETAIL detail
		ON
			item.ID = detail.ID
		<where>
			<if test="!key1.isBlank()">
				item.NAME = #{key1}
			</if>
			<if test="!key2.isBlank()">
				AND detail.DETAIL_NAME = #{key2}
			</if>
		</where>
	</select>
</mapper>

Answer 2

appl_name.key1, appl_name.key2 のようなキーの指定でそこに記載された値を文字列の変数として読み込むことはできるので、それを動的SQLに使用するイメージでしょうか

@Valueを使用する方法

キー毎に値を読み込みます。

@Component
public class AppProperties {

    @Value("${appl_name.key1:}")  // :の後にはキーがない場合のデフォルト値を指定します
    private String key1;          // Stringの場合:の後ろに何も書かなければ "" になります。
    @Value("${appl_name.key2:}") 
    private String key2;

    // key1,key2には setterが必要ですが省略します
}

@ConfigurationPropertiesを使用する方法

ある階層以下のキーの値を読み込みます

@Component
@ConfigurationProperties(prefix="appl_name")
static class AppProperties {

    private String key1 = ""; // ← "appl_name.key1"の設定値が読み込まれます
    private String key2 = ""; // ← "appl_name.key2"の設定値が読み込まれます

    // key1,key2には setterが必要ですが省略します

}

MyBatis のMapper

MyBatis詳しくないですが、こんな感じでしょうか？

<select id="findActiveBlogLike" 
     resultType="Blog">
  SELECT * FROM BLOG 
  <where>
    1 = 1
    <if test="key1 != null">
        AND #{key1}
    </if> 
    <if test="key2 != null">
        AND #{key2}
    </if>
  </where>
</select>

【参考】

• Qiita-Spring Bootの外部設定値の扱い方を理解する
• MyBatis-動的SQL