@EnableConfigurationPropertiesのガイド

1. 前書き

このクイックチュートリアルでは、https://www.baeldung.com/configuration-properties-in-spring-boot [_ @ ConfigurationProperties_]注釈付きクラスで_ @ EnableConfigurationProperties_注釈を使用する方法を示します*。

2. _ @ EnableConfigurationProperties_アノテーションの目的

  • _ @ EnableConfigurationProperties_注釈は_ @ ConfiguratonPropertiesに厳密に接続されています。_*

    アプリケーションで_ @ ConfigurationProperties_注釈付きクラスのサポートを有効にします。 ただし、https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-external-config-typesafe-configuration-properties [Spring Boot documentation] *プロジェクトごとに[email protected]_*が自動的に含まれます。したがって、_ @ ConfiguratonProperties_サポートはすべてのSpring Bootアプリケーションで暗黙的にオンになります。
    プロジェクトで構成クラスを使用するには、通常のSpring Beanとして登録する必要があります。
    まず、そのようなクラスに[email protected]_アノテーションを付けます。あるいは、_ @ Bean_ファクトリーメソッドを使用できます。
    ただし、特定の状況では、* @ ConfigurationProperties_クラスを単純なPOJOとして保持することをお勧めします*。 これは、_ @ EnableConfigurationProperties_が便利な場合です。 このアノテーションですべての構成Beanを直接指定できます。
    *これは、_ @ ConfigurationProperties_注釈付きBeanをすばやく登録する便利な方法です。*

3. _ @ EnableConfigurationProperties_の使用

それでは、実際に_ @ EnableConfigurationProperties_を使用する方法を見てみましょう。
最初に、サンプル構成クラスを定義する必要があります。
@ConfigurationProperties(prefix = "additional")
public class AdditionalProperties {

    private String unit;
    private int max;

    // standard getters and setters
}
  • AdditionalProperties_に注釈を付けたのは@ConfigurationProperties._のみであることに注意してください。*これはまだ単純なPOJOです!

    最後に、@ _ EnableConfigurationProperties_を使用して構成Beanを登録しましょう。
@Configuration
@EnableConfigurationProperties(AdditionalProperties.class)
public class AdditionalConfiguration {

    @Autowired
    private AdditionalProperties additionalProperties;

    // make use of the bound properties
}
それで全部です! *他のSpring Beanと同様に_AdditionalProperties_を使用できるようになりました。*

4. 結論

このクイックチュートリアルでは、Springで@_ConfigurationProperties_注釈付きクラスをすばやく登録する便利な方法を紹介しました。*
いつものように、この記事で使用される例はすべてhttps://github.com/eugenp/tutorials/tree/master/spring-boot-properties[GitHubで利用可能]です。