Spring Bootがプロパティファイルを読み込む方法に一同驚愕！！

こんにちは、インターン生の古家です。

今回はSpring Bootのプロパティファイルの理解を深めるために調査を行い、まとめてみました。

プロパティとは？

SpringBootではアプリケーションコードの外に設定値を持つことができます。

この設定値がプロパティと呼ばれています。

ファイル形式は.propertiesと.ymlを使用でき、その他にも環境変数やコマンドライン引数を用いて設定値を与えることができます。

以下のアノテーションを使うとBeanに対して直接プロパティ値を与えることができます。

フィールドを＠Valueアノテーションで装飾して直接値をBeanに注入することができます。

@Value("${name}")
    private String name;

POJOクラスを@ConfigurationPropertiesで装飾し、その属性でプロパティのprefixを指定すると、そのprefixを持ったプロパティをまるっとオブジェクトにぶっこむこともできます。

例えば

spring.datasource.username=hoge
spring.datasource.password=hogehoge

というプロパティがあったら、

@ConfigurationProperties(prefix = "spring.datasource")
public class DataSource {
    String username;
    String password;
}

とすると、usernameにはhoge、passwordにはhogehogeを入れてくれます。

よく使われるのはapplication.propertiesやapplication.ymlファイルですよね。

SpringApplicationは、これらのプロパティファイルを以下の場所から探し出します（優先順位高い順）：

１．/configという名前のサブディレクトリ（file:./config/）

２．カレントディレクトリ（file:./）

３．クラスパスの/configパッケージ（classpath:/config/）

４．クラスパスルート（classpath:/）

...あれ？src/main/resources/じゃないの？

もしそう思ったら、あなたは一人じゃありません。僕も思いました。

実はsrc/main/resourcesディレクトリはMavenのデフォルトのクラスパスの一つです。

そのためsrc/main/resourcesディレクトリは４．クラスパスルートに含まれ、その配下にあるapplication.propertiesファイルはSpring Bootが自動で読み込んでくれます。

もし上記４つ以外の場所からプロパティを読み込ませたい場合は、@Configurationクラスに@PropertySourceアノテーションを付与し、任意のクラスパスを指定してあげるとそこにもプロパティを探しに行ってくれます。

 @Configuration
 @PropertySource("classpath:/com/myco/app.properties")
 public class AppConfig {

ローカル、テスト環境、本番環境でプロパティを分けたいときもありますよね。

そんな時のために、

application-{profile}.properties

という命名規則に従ってプロパティファイルを作成することで、プロファイル別に作ることもできます。

プロファイルが設定されている時は、そのプロファイルにあったプロパティファイルが優先的に読み込まれます。

もしプロファイルがデフォルトのままであれば、デフォルトの

application-default.properties

か

application.properties

が読み込まれます。

これらは以下の通りの優先順位に沿って読み込まれます：