パッケージ org.springframework.boot.context.properties

アノテーションインターフェース ConfigurationPropertiesScan

@TargetSE(TYPESE) @RetentionSE(RUNTIMESE) @DocumentedSE @Import(org.springframework.boot.context.properties.ConfigurationPropertiesScanRegistrar.class) @EnableConfigurationProperties public @interface ConfigurationPropertiesScan
@ConfigurationProperties クラスをスキャンするときに使用される基本パッケージを構成します。basePackageClasses()、basePackages()、そのエイリアス value() のいずれかを指定して、スキャンする特定のパッケージを定義できます。特定のパッケージが定義されていない場合、このアノテーションが付いているクラスのパッケージからスキャンが行われます。

メモ: @Component でアノテーションが付けられたクラスまたはメタアノテーションが付けられたクラスは、このアノテーションによって取得されません。

導入:
2.2.0
作成者:
Madhura Bhave

  • 要素の詳細

    • value

      @AliasFor("basePackages") StringSE[] value
      basePackages() 属性のエイリアス。より簡潔なアノテーション宣言を許可します（例: @ConfigurationPropertiesScan(basePackages="org.my.pkg") の代わりに @ConfigurationPropertiesScan("org.my.pkg")）。
      戻り値:
      スキャンする基本パッケージ
      デフォルト:
      {}

    • basePackages

      @AliasFor("value") StringSE[] basePackages
      構成プロパティをスキャンする基本パッケージ。value() は、この属性のエイリアスです（相互に排他的です）。

      文字列ベースのパッケージ名に代わる型安全な代替手段として basePackageClasses() を使用します。

      戻り値:
      スキャンする基本パッケージ
      デフォルト:
      {}

    • basePackageClasses

      ClassSE<?>[] basePackageClasses
      構成プロパティをスキャンするパッケージを指定するための、basePackages() の型安全な代替手段。指定された各クラスのパッケージがスキャンされます。

      この属性によって参照される以外の目的を果たさない特別なノーオペレーションマーカークラスまたはインターフェースを各パッケージに作成することを検討してください。

      戻り値:
      スキャンする基本パッケージのクラス
      デフォルト:
      {}