質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.91%

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

受付中

回答 2

投稿

  • 評価
  • クリップ 0
  • VIEW 3,229

score 11

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

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

appl_name:
  key1: value1
  key2: value2

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

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

0

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>

【参考】

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

0

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>

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.91%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る