程序包 org.springframework.boot.context.properties

批注接口 ConfigurationProperties

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Documented
@Indexed
public @interface ConfigurationProperties

Annotation for externalized configuration. Add this to a class definition or a @Bean method in a @Configuration class if you want to bind and validate some external Properties (e.g. from a .properties file).

Binding is either performed by calling setters on the annotated class or, if @ConstructorBinding is in use, by binding to the constructor parameters.

Note that contrary to @Value, SpEL expressions are not evaluated since property values are externalized.

从以下版本开始:

1.0.0

作者:

Dave Syer

另请参阅:

• ConfigurationPropertiesScan
• ConstructorBinding
• ConfigurationPropertiesBindingPostProcessor
• EnableConfigurationProperties

可选元素概要

可选元素

修饰符和类型	可选元素	说明
boolean	ignoreInvalidFields	Flag to indicate that when binding to this object invalid fields should be ignored.
boolean	ignoreUnknownFields	Flag to indicate that when binding to this object unknown fields should be ignored.
String	prefix	The prefix of the properties that are valid to bind to this object.
String	value	The prefix of the properties that are valid to bind to this object.

元素详细资料

value

@AliasFor("prefix")
String value

The prefix of the properties that are valid to bind to this object. Synonym for prefix(). A valid prefix is defined by one or more words separated with dots (e.g. "acme.system.feature").

返回:

the prefix of the properties to bind

默认值:

""

prefix

@AliasFor("value")
String prefix

The prefix of the properties that are valid to bind to this object. Synonym for value(). A valid prefix is defined by one or more words separated with dots (e.g. "acme.system.feature").

返回:

the prefix of the properties to bind

默认值:

""

ignoreInvalidFields

boolean ignoreInvalidFields

Flag to indicate that when binding to this object invalid fields should be ignored. Invalid means invalid according to the binder that is used, and usually this means fields of the wrong type (or that cannot be coerced into the correct type).

返回:

the flag value (default false)

默认值:

false

ignoreUnknownFields

boolean ignoreUnknownFields

Flag to indicate that when binding to this object unknown fields should be ignored. An unknown field could be a sign of a mistake in the Properties.

返回:

the flag value (default true)

默认值:

true