apollo提供了基础数据库存储的配置管理中心,服务分client、adminService、configService、portal等模块。其中client服务在configService获取配置数据,监听配置数据,提供给具体应用的配置初始化以及配置动态更新操作,apollo提供了两种类型的配置数据模型,config、configFile;Config已经分析过,下面主要看configFile
配置文件模型接口
/**
* 配置文件模型接口,用于提供配置文件的相关信息以及内容信息
* @author Jason Song(song_s@ctrip.com)
*/
public interface ConfigFile {
/**
* 获取配置文件的内容信息
* Get file content of the namespace
* @return file content, {@code null} if there is no content
*/
String getContent();
/**
* 判断是否含有内容信息
* Whether the config file has any content
* @return true if it has content, false otherwise.
*/
boolean hasContent();
/**
* 获取当前配置的命名空间
* Get the namespace of this config file instance
* @return the namespace
*/
String getNamespace();
/**
* 获取当前配置文件格式
* Get the file format of this config file instance
* @return the config file format enum
*/
ConfigFileFormat getConfigFileFormat();
/**
* 添加文件改变监听器
* Add change listener to this config file instance.
*
* @param listener the config file change listener
*/
void addChangeListener(ConfigFileChangeListener listener);
}
ConfigFile 接口与config接口的差异是,ConfigFile接口获取是配置的整个文本内容,Config是根据key获取配置文本里具体KEY的值。其它基本一致。
ConfigFile 提供以下功能:
- 获取配置所有内容以字符串返回
- 获取配置文件的格式(json、yml、xml....)
- 添加配置改变监听
ConfigFile
/**
* 抽象的配置文件实现
* @author Jason Song(song_s@ctrip.com)
*/
public abstract class AbstractConfigFile implements ConfigFile, RepositoryChangeListener {
private static ExecutorService m_executorService;
/**
* 配置仓库服务
*/
protected ConfigRepository m_configRepository;
/**
* 命名空间
*/
protected String m_namespace;
/**
* 仓库配置本地缓存
*/
protected AtomicReference<Properties> m_configProperties;
/**
* 监听器集合
*/
private List<ConfigFileChangeListener> m_listeners = Lists.newCopyOnWriteArrayList();
/**
* 初始化加载配置信息
*/
private void initialize() {
try {
m_configProperties.set(m_configRepository.getConfig());
} catch (Throwable ex) {
Tracer.logError(ex);
logger.warn("Init Apollo Config File failed - namespace: {}, reason: {}.",
m_namespace, ExceptionUtil.getDetailMessage(ex));
} finally {
//注册当前实例到配置仓库服务上,用于监听配置仓库上的配置变化
//register the change listener no matter config repository is working or not
//so that whenever config repository is recovered, config could get changed
m_configRepository.addChangeListener(this);
}
}
@Override
public String getNamespace() {
return m_namespace;
}
protected abstract void update(Properties newProperties);
/**
* 配置仓库中配置改变监听器回调函数
* @param namespace the namespace of this repository change
* @param newProperties the properties after change
*/
@Override
public synchronized void onRepositoryChange(String namespace, Properties newProperties) {
if (newProperties.equals(m_configProperties.get())) {
return;
}
Properties newConfigProperties = new Properties();
newConfigProperties.putAll(newProperties);
String oldValue = getContent();
update(newProperties);
String newValue = getContent();
PropertyChangeType changeType = PropertyChangeType.MODIFIED;
if (oldValue == null) {
changeType = PropertyChangeType.ADDED;
} else if (newValue == null) {
changeType = PropertyChangeType.DELETED;
}
this.fireConfigChange(new ConfigFileChangeEvent(m_namespace, oldValue, newValue, changeType));
Tracer.logEvent("Apollo.Client.ConfigChanges", m_namespace);
}
@Override
public void addChangeListener(ConfigFileChangeListener listener) {
if (!m_listeners.contains(listener)) {
m_listeners.add(listener);
}
}
/**
* 配置改变触发配置文件监听器,回调
* @param changeEvent
*/
private void fireConfigChange(final ConfigFileChangeEvent changeEvent) {
for (final ConfigFileChangeListener listener : m_listeners) {
m_executorService.submit(new Runnable() {
@Override
public void run() {
String listenerName = listener.getClass().getName();
Transaction transaction = Tracer.newTransaction("Apollo.ConfigFileChangeListener", listenerName);
try {
listener.onChange(changeEvent);
transaction.setStatus(Transaction.SUCCESS);
} catch (Throwable ex) {
transaction.setStatus(ex);
Tracer.logError(ex);
logger.error("Failed to invoke config file change listener {}", listenerName, ex);
} finally {
transaction.complete();
}
}
});
}
}
}
AbstractConfigFile与Config模型中的DefaultConfig类实现原理基本一致,都是在配置仓库获取配置信息,同时监听配置仓库的改变。具体分析可见DefaultConfig类。
同时PlainTextConfigFile、PropertiesConfigFile等都比较简单实现,在此就不再描述