プロプログラマ

プログラマーを職業としてます。 Flex,Air,C#,Oracle,HTML+JSの言語ノウハウを中心に情報発信していきます

[SpringBoot] application.propertiesに独自プロパティを追加する

application.propertiesでは定義されているプロパティ以外を指定すると警告表示されます。


独自のプロパティを追加したい場合は、

プロパティについている電球マークを右クリックして、 Create metadata for  ‘プロパティ名’を選択します。




すると、META-INFにadditional-spring-configuration-metadata.jsonが生成され、中にプロパティに対しての定義が記載されます。


これで、警告は消えます。descriptionやtypeを変更すれば、application.properties編集時にもわかりやすく表示できます。

 
 

参照必要なところで、

  @Value(${test.value})

  private String testValue;

のようにしてアクセス可能になります。

 
 

これだけでもアクセスは可能ですが、別途定義クラスを作ると、設定をグループ化して取得したりできるようになります

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

import org.springframework.stereotype.Component;

 
 

import lombok.Data;

 
 

/**

* application.properties用独自プロパティ定義

*/

@Component

@ConfigurationProperties(prefix = “test”)

@Data

public class TestConfiguration {

 
 


private String value;

}

※lombok使っていますので@Dataアノテーション指定で省略していますが、本来はgetter, setterが必要です。

 
 

@Autowired

  TestConfiguration conf;

 
 


 
 

  

conf.value() で設定を参照可能になります。

value以外にも複数の設定をしている場合でも、confオブジェクトでまとめて取得できます。

 
 

 

== ランキングに参加しています。ぜひクリックお願いします ==

プログラム ブログランキングへ
にほんブログ村 IT技術ブログへ
にほんブログ村

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください