com.ctrip.framework.apollo.spring.annotation

Annotation Type EnableApolloConfig

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
 @Import(value=ApolloConfigRegistrar.class)
public @interface EnableApolloConfig

Use this annotation to register Apollo property sources when using Java Config.

Configuration example with multiple namespaces:

 @Configuration
 @EnableApolloConfig({"someNamespace","anotherNamespace"})
 public class AppConfig {

 }
 

Configuration example with placeholder:

 // 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.
 // Please note that this placeholder could not be configured in Apollo as Apollo is not activated during this phase.
 @Configuration
 @EnableApolloConfig({"${redis.namespace:xxx}"})
 public class AppConfig {

 }
 

Author:

Jason Song(song_s@ctrip.com)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
MultipleConfig[]	multipleConfigs Additional appId and namespace configurations.
int	order The order of the apollo config, default is Ordered.LOWEST_PRECEDENCE, which is Integer.MAX_VALUE.
String[]	value Apollo namespaces to inject configuration into Spring Property Sources.

Element Detail

value

public abstract String[] value

Apollo namespaces to inject configuration into Spring Property Sources.

Default:

"application"

order

public abstract int order

The order of the apollo config, default is Ordered.LOWEST_PRECEDENCE, which is Integer.MAX_VALUE. If there are properties with the same name in different apollo configs, the apollo config with smaller order wins.

Returns:

Default:

2147483647

multipleConfigs

public abstract MultipleConfig[] multipleConfigs

Additional appId and namespace configurations. Will not participate in bootstrap e.g.

Since:

2.4.0

Default:

{}