com.ctrip.framework.apollo.spring.annotation

Annotation Type ApolloConfigChangeListener

@Retention(value=RUNTIME)
@Target(value=METHOD)
@Documented
public @interface ApolloConfigChangeListener

Use this annotation to register Apollo ConfigChangeListener.

Usage example:

 //Listener on namespaces of "someNamespace" and "anotherNamespace", will be notified when any key is changed
 @ApolloConfigChangeListener({"someNamespace","anotherNamespace"})
 private void onChange(ConfigChangeEvent changeEvent) {
     //handle change event
 }
 

 //The namespace could also be specified as a placeholder, e.g. ${redis.namespace:xxx}, which will use the value of the key "redis.namespace" or "xxx" if this key is not configured.
 @ApolloConfigChangeListener({"${redis.namespace:xxx}"})
 private void onChange(ConfigChangeEvent changeEvent) {
     //handle change event
 }
 

 //Listener on namespaces of "someNamespace" and "anotherNamespace", will only be notified when "someKey" or "anotherKey" is changed
 @ApolloConfigChangeListener(value = {"someNamespace","anotherNamespace"}, interestedKeys = {"someKey", "anotherKey"})
 private void onChange(ConfigChangeEvent changeEvent) {
     //handle change event
 }
 

Author:

Jason Song(song_s@ctrip.com)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	interestedKeyPrefixes The key prefixes that the listener is interested in, will be notified if and only if the changed keys start with anyone of the prefixes.
String[]	interestedKeys The keys interested by the listener, will only be notified if any of the interested keys is changed.
String[]	value Apollo namespace for the config, if not specified then default to application

Element Detail

value

public abstract String[] value

Apollo namespace for the config, if not specified then default to application

Default:

"application"

interestedKeys

public abstract String[] interestedKeys

The keys interested by the listener, will only be notified if any of the interested keys is changed.
If neither of interestedKeys and interestedKeyPrefixes is specified then the listener will be notified when any key is changed.

Default:

{}

interestedKeyPrefixes

public abstract String[] interestedKeyPrefixes

The key prefixes that the listener is interested in, will be notified if and only if the changed keys start with anyone of the prefixes. The prefixes will simply be used to determine whether the listener should be notified or not using changedKey.startsWith(prefix). e.g. "spring." means that listener is interested in keys that starts with "spring.", such as "spring.banner", "spring.jpa", etc. and "application" means that listener is interested in keys that starts with "application", such as "applicationName", "application.port", etc.
If neither of interestedKeys and interestedKeyPrefixes is specified then the listener will be notified when whatever key is changed.

Default:

{}