アノテーションインターフェース ConfigurationProperties
@TargetSE({TYPESE,METHODSE})
@RetentionSE(RUNTIMESE)
@DocumentedSE
@Indexed
public @interface ConfigurationProperties
外部化された設定のアノテーション。いくつかの外部プロパティ(.properties ファイルなど)をバインドおよび検証する場合は、これをクラス定義または
@Configuration
クラスの @Bean
メソッドに追加します。 バインドは、アノテーション付きクラスで setter を呼び出すか、@ConstructorBinding
が使用されている場合はコンストラクターパラメーターにバインドすることによって実行されます。
@Value
に反して、プロパティ値は外部化されているため、SpEL 式は評価されないことに注意してください。
オプション要素のサマリー
修飾子と型オプションの要素説明boolean
このオブジェクトにバインドするときに無効なフィールドを無視する必要があることを示すフラグ。boolean
このオブジェクトへのバインド時に不明なフィールドを無視する必要があることを示すフラグ。このオブジェクトにバインドするのに有効なプロパティのプレフィックス。このオブジェクトにバインドするのに有効なプロパティのプレフィックス。
要素の詳細
value
このオブジェクトにバインドするのに有効なプロパティのプレフィックス。prefix()
のシノニム。有効なプレフィックスは、ドットで区切られた 1 つ以上の単語(例:"acme.system.feature"
)によって定義されます。- 戻り値:
- バインドするプロパティのプレフィックス
- デフォルト:
- ""
prefix
このオブジェクトにバインドするのに有効なプロパティのプレフィックス。value()
のシノニム。有効なプレフィックスは、ドットで区切られた 1 つ以上の単語(例:"acme.system.feature"
)によって定義されます。- 戻り値:
- バインドするプロパティのプレフィックス
- デフォルト:
- ""
ignoreInvalidFields
boolean ignoreInvalidFieldsこのオブジェクトにバインドするときに無効なフィールドを無視する必要があることを示すフラグ。無効とは、使用されるバインダーに応じて無効であることを意味し、通常、これは間違った型のフィールド(または正しい型に強制できないフィールド)を意味します。- 戻り値:
- フラグ値 (デフォルトは false)
- デフォルト:
- false
ignoreUnknownFields
boolean ignoreUnknownFieldsこのオブジェクトへのバインド時に不明なフィールドを無視する必要があることを示すフラグ。不明なフィールドは、プロパティの間違いの兆候である可能性があります。- 戻り値:
- フラグ値 (デフォルト true)
- デフォルト:
- true