Package com.alibaba.nacos.api.config.annotation

Annotation Type NacosConfigListener

@Retention(RUNTIME)
@Target(METHOD)
@Documented
public @interface NacosConfigListener

Annotation that marks a method as a listener for Nacos Config change.

Since:

0.2.0

Author:

Mercy

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	dataId	Nacos Data ID

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends NacosConfigConverter>	converter	Specify Nacos configuraion convertor class to convert target type instance.
String	groupId	Nacos Group ID
NacosProperties	properties	The NacosProperties attribute, If not specified, it will use global Nacos Properties.
long	timeout	Maximum timeout value of execution in milliseconds, which is used to prevent long-time blocking execution impacting others.

Element Detail

dataId

String dataId

Nacos Data ID

Returns:

required value.

groupId

String groupId

Nacos Group ID

Returns:

default value Constants.DEFAULT_GROUP;

Default:

"DEFAULT_GROUP"

converter

Class<? extends NacosConfigConverter> converter

Specify Nacos configuraion convertor class to convert target type instance.

Returns:

The implementation class of NacosConfigConverter

Default:

com.alibaba.nacos.api.config.convert.NacosConfigConverter.class

properties

NacosProperties properties

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

Returns:

the default value is NacosProperties

Default:

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

timeout

long timeout

Maximum timeout value of execution in milliseconds, which is used to prevent long-time blocking execution impacting others.

Returns:

default value is 1000

Default:

1000L