投稿日： 2019年4月27日

【SpringBoot2】メッセージプロパティファイルをロジック内部から呼び出すための設定【他言語化対応】

YouTubeも見てね♪

ねこじゃすり

ワタオカねこじゃすりライトグレー

created by Rinker

PEPPY(ペピイ)

¥3,850 (2025/01/05 12:56:12時点 Amazon調べ-詳細)

猫を魅了する魔法の装備品！

Anker PowerCor

Anker PowerCore モバイルバッテリー 20000mAh iPhone iPad Android

created by Rinker

Anker

¥3,990 (2025/01/05 12:09:11時点 Amazon調べ-詳細)

旅行には必須の大容量モバイルバッテリー！

レッドブルエナジードリンク 250ml×24本

created by Rinker

Red Bull(レッドブル)

¥4,000 (2025/01/05 12:33:39時点 Amazon調べ-詳細)

翼を授けよう！

ドラゴンクエストメタリックモンスターズギャラリーメタルキング

created by Rinker

スクウェア・エニックス(SQUARE ENIX)

¥3,940 (2025/01/05 12:41:47時点 Amazon調べ-詳細)

みんな大好き経験値の塊をデスクに常備しておこう！

Bauhutte ( バウヒュッテ ) 昇降式 L字デスクブラック BHD-670H-BK

created by Rinker

Bauhutte(バウヒュッテ)

¥15,855 (2025/01/05 12:09:12時点 Amazon調べ-詳細)

メインデスクの横に置くのにぴったりなおしゃれな可動式ラック！

BANDAI SPIRITS ULTIMAGEAR 遊戯王千年パズル 1/1スケール

created by Rinker

BANDAI SPIRITS(バンダイスピリッツ)

¥10,429 (2025/01/05 12:09:13時点 Amazon調べ-詳細)

もう一人の僕を呼び覚ませ！！

MOFT X 【新型ミニマム版】 iPhone対応スマホスタンド

created by Rinker

MOFT

Amazon一番人気のスマホスタンド！カード類も収納出来てかさ張らないのでオススメです！

1 独自プロパティファイルをソースから読み込みたい
2 手順
3 オススメの商品
- 3.1 現場至上主義 Spring Boot2 徹底活用
- 3.2 日清カップヌードル 77g×20個
4 終わりに

独自プロパティファイルをソースから読み込みたい

SpringBootではエラーメッセージなどをプロパティファイルなどに外出しして管理することが可能になります。

呼び出すためには専用の設定を行う必要があるため、今回はその方法についてご紹介していきます。

手順

message.propertiesの用意

まずは読み込ませたいプロパティファイルを用意しましょう。

hoge=fuga

hoge=fuga

メッセージファイルの読み込み設定

次に、上記で作成したプロパティファイルを読み取れるようにするための設定クラスを用意しましょう。

package tech.blogenist.service.account.api.infrastructure.message;

import java.nio.charset.StandardCharsets;

import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.MessageSourceAccessor;
import org.springframework.context.support.ResourceBundleMessageSource;

@Configuration
public class MessageSourceBean
{
    private String[] BASE_NAMES =
    {
            "custom/message"
    };

    @Bean
    public MessageSource messageSource()
    {
        ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
        messageSource.setBasenames( BASE_NAMES );
        messageSource.setDefaultEncoding( StandardCharsets.UTF_8.name() );
        return messageSource;
    }

    @Bean
    public MessageSourceAccessor messageSourceAccessor()
    {
        return new MessageSourceAccessor( messageSource() );
    }

}

package tech.blogenist.service.account.api.infrastructure.message;

import java.nio.charset.StandardCharsets;

import org.springframework.context.MessageSource;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.context.support.MessageSourceAccessor;

import org.springframework.context.support.ResourceBundleMessageSource;

@Configuration

public class MessageSourceBean

{

private String[] BASE_NAMES =

{

"custom/message"

};

@Bean

public MessageSource messageSource()

{

ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();

messageSource.setBasenames( BASE_NAMES );

messageSource.setDefaultEncoding( StandardCharsets.UTF_8.name() );

return messageSource;

}

@Bean

public MessageSourceAccessor messageSourceAccessor()

{

return new MessageSourceAccessor( messageSource() );

}

確認

では、実際に以下のように読み出した値を標準出力に出してみましょう。

    @Autowired
    private MessageSource        messageSource;// 準備

   ...

        String value = messageSource
                .getMessage(
                        "hoge", //Keyを指定
                        null, //　とりあえずnullで良い
                        Locale.getDefault() );// Localもとりあえずはデフォルトで良い

        System.out.println( value ); // fuga

@Autowired

private MessageSource messageSource;// 準備

...

String value = messageSource

.getMessage(

"hoge", //Keyを指定

null, //　とりあえずnullで良い

Locale.getDefault() );// Localもとりあえずはデフォルトで良い

System.out.println( value ); // fuga

では、これで実際にリクエストを投げてみましょう。

2019-04-27 10:42:02.075  INFO 4380 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2019-04-27 10:42:02.076  INFO 4380 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2019-04-27 10:42:02.096  INFO 4380 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 20 ms
fuga

2019-04-27 10:42:02.075 INFO 4380 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring DispatcherServlet 'dispatcherServlet'

2019-04-27 10:42:02.076 INFO 4380 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Initializing Servlet 'dispatcherServlet'

2019-04-27 10:42:02.096 INFO 4380 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Completed initialization in 20 ms

fuga

正しく取得出来ましたね♪

他言語化対応

プロパティファイル名に{ファイル名}_{言語コード}とすることでLocaleに合わせたファイルを自動で読み込んでくれるようになります。

以下のようなファイルを用意したとしましょう。

api/src/main/resources/custom
├── message.properties
├── message.properties
└── message.properties

api/src/main/resources/custom

├── message.properties

└── message.properties

その上で、メッセージを取得する際の第三引数にLocaleを指定することで対応したプロパティファイルから値を取ってきてくれます。

...
        String jaValue = messageSource
                .getMessage(
                        "hoge",
                        null,
                        Locale.JAPANESE );
        System.out.println( jaValue );// ふが

        String enValue = messageSource
                .getMessage(
                        "hoge",
                        null,
                        Locale.ENGLISH );
        System.out.println( enValue );//fuga

        String zhValue = messageSource
                .getMessage(
                        "hoge",
                        null,
                        Locale.CHINA );// ふが
        System.out.println( zhValue );