com.alibaba.nacos.api.config.annotation

注释类型 NacosConfigurationProperties

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface NacosConfigurationProperties

An annotation for Nacos configuration Properties for binding POJO as Properties Object.

从以下版本开始:

0.2.0

作者:

Mercy

另请参阅:

PropertyKeyConst

必需元素概要

所需元素

限定符和类型	必需的元素和说明
String	dataId Nacos Data ID.

可选元素概要

可选元素

限定符和类型	可选元素和说明
boolean	autoRefreshed It indicates the properties of current doBind bean is auto-refreshed when Nacos configuration is changed.
boolean	exceptionIfInvalid Flag to indicate that an exception should be raised if a Validator is available and validation fails.
String	groupId Nacos Group ID.
boolean	ignoreInvalidFields Flag to indicate that when binding to this object invalid fields should be ignored.
boolean	ignoreNestedProperties Flag to indicate that when binding to this object fields with periods in their names should be ignored.
boolean	ignoreUnknownFields Flag to indicate that when binding to this object unknown fields should be ignored.
String	prefix config prefix name.
NacosProperties	properties The NacosProperties attribute, If not specified, it will use global Nacos Properties.
ConfigType	type config style.
boolean	yaml 已过时。

元素详细资料

dataId

public abstract String dataId

Nacos Data ID.

返回:

required value.

prefix

public abstract String prefix

config prefix name.

返回:

default value is ""

默认值:

""

groupId

public abstract String groupId

Nacos Group ID.

返回:

default value Constants.DEFAULT_GROUP;

默认值:

"DEFAULT_GROUP"

yaml

@Deprecated
public abstract boolean yaml

已过时。

set config type is yaml this method is deprecated, we support you use type() to set config type.

返回:

default value false

默认值:

false

type

public abstract ConfigType type

config style.

返回:

default value is ConfigType.PROPERTIES

默认值:

com.alibaba.nacos.api.config.ConfigType.PROPERTIES

autoRefreshed

public abstract boolean autoRefreshed

It indicates the properties of current doBind bean is auto-refreshed when Nacos configuration is changed.

返回:

default value is false

默认值:

false

ignoreInvalidFields

public abstract 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

ignoreNestedProperties

public abstract boolean ignoreNestedProperties

Flag to indicate that when binding to this object fields with periods in their names should be ignored.

返回:

the flag value (default false)

默认值:

false

ignoreUnknownFields

public abstract 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

exceptionIfInvalid

public abstract boolean exceptionIfInvalid

Flag to indicate that an exception should be raised if a Validator is available and validation fails. If it is set to false, validation errors will be swallowed. They will be logged, but not propagated to the caller.

返回:

the flag value (default true)

默认值:

true

properties

public abstract NacosProperties properties

The NacosProperties attribute, If not specified, it will use global Nacos Properties.

返回:

the default value is NacosProperties

默认值:

@com.alibaba.nacos.api.annotation.NacosProperties