org.apache.dubbo.configcenter

接口 DynamicConfiguration

所有超级接口:

Configuration

所有已知实现类:

ApolloDynamicConfiguration, ConsulDynamicConfiguration, EtcdDynamicConfiguration, NacosDynamicConfiguration, NopDynamicConfiguration, ZookeeperDynamicConfiguration

public interface DynamicConfiguration
extends Configuration

Dynamic Configuration
From the use scenario internally in framework, there're mainly three kinds of methods:

• 1. getConfig, get governance rules or single config item from Config Center.
• 2. getConfigFile, get configuration file from Config Center at start up.
• 3. addListener/removeListener, add or remove listeners for governance rules or config items that need to watch.

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_GROUP

方法概要

限定符和类型	方法和说明
default void	addListener(String key, ConfigurationListener listener) addListener(String, String, ConfigurationListener)
void	addListener(String key, String group, ConfigurationListener listener) Register a configuration listener for a specified key The listener only works for service governance purpose, so the target group would always be the value user specifies at startup or 'dubbo' by default.
default String	getConfig(String key) Get the configuration mapped to the given key
default String	getConfig(String key, String group) Get the configuration mapped to the given key and the given group
String	getConfig(String key, String group, long timeout) Get the configuration mapped to the given key and the given group.
default String	getConfigs(String key, String group) getConfig(String, String, long) This method are mostly used to get a compound config file, such as a complete dubbo.properties file.
String	getConfigs(String key, String group, long timeout) getConfig(String, String, long) This method are mostly used to get a compound config file, such as a complete dubbo.properties file.
static DynamicConfiguration	getDynamicConfiguration() Find DynamicConfiguration instance
default void	removeListener(String key, ConfigurationListener listener) removeListener(String, String, ConfigurationListener)
void	removeListener(String key, String group, ConfigurationListener listener) Stops one listener from listening to value changes in the specified key.

从接口继承的方法 org.apache.dubbo.common.config.Configuration

containsKey, convert, getInternalProperty, getProperty, getProperty, getString, getString

字段详细资料

DEFAULT_GROUP

static final String DEFAULT_GROUP

另请参阅:

常量字段值

方法详细资料

addListener

default void addListener(String key,
                         ConfigurationListener listener)

addListener(String, String, ConfigurationListener)

参数:

key - the key to represent a configuration

listener - configuration listener

removeListener

default void removeListener(String key,
                            ConfigurationListener listener)

removeListener(String, String, ConfigurationListener)

参数:

key - the key to represent a configuration

listener - configuration listener

addListener

void addListener(String key,
                 String group,
                 ConfigurationListener listener)

Register a configuration listener for a specified key The listener only works for service governance purpose, so the target group would always be the value user specifies at startup or 'dubbo' by default. This method will only register listener, which means it will not trigger a notification that contains the current value.

参数:

key - the key to represent a configuration

group - the group where the key belongs to

listener - configuration listener

removeListener

void removeListener(String key,
                    String group,
                    ConfigurationListener listener)

Stops one listener from listening to value changes in the specified key.

参数:

key - the key to represent a configuration

group - the group where the key belongs to

listener - configuration listener

getConfig

default String getConfig(String key)

Get the configuration mapped to the given key

参数:

key - the key to represent a configuration

返回:

target configuration mapped to the given key

getConfig

default String getConfig(String key,
                         String group)

Get the configuration mapped to the given key and the given group

参数:

key - the key to represent a configuration

group - the group where the key belongs to

返回:

target configuration mapped to the given key and the given group

getConfig

String getConfig(String key,
                 String group,
                 long timeout)
          throws IllegalStateException

Get the configuration mapped to the given key and the given group. If the configuration fails to fetch after timeout exceeds, IllegalStateException will be thrown.

参数:

key - the key to represent a configuration

group - the group where the key belongs to

timeout - timeout value for fetching the target config

返回:

target configuration mapped to the given key and the given group, IllegalStateException will be thrown if timeout exceeds.

抛出:

IllegalStateException

getConfigs

default String getConfigs(String key,
                          String group)
                   throws IllegalStateException

getConfig(String, String, long) This method are mostly used to get a compound config file, such as a complete dubbo.properties file.

抛出:

IllegalStateException

getConfigs

String getConfigs(String key,
                  String group,
                  long timeout)
           throws IllegalStateException

getConfig(String, String, long) This method are mostly used to get a compound config file, such as a complete dubbo.properties file.

抛出:

IllegalStateException

getDynamicConfiguration

static DynamicConfiguration getDynamicConfiguration()

Find DynamicConfiguration instance

返回:

DynamicConfiguration instance