apollo与spring实现动态刷新配置,主要有2种刷新
- 基于普通字段刷新
- 基于bean上使用了@ConfigurationProperties刷新
一、普通字段刷新
在需刷新的字段上配置@Value注解,如:
@Value("${ve.auth-url}")
private String authUrl;
二、bean使用@ConfigurationProperties动态刷新
bean使用@ConfigurationProperties注解目前还不支持自动刷新,需要编写额外的代码。目前官方提供2种刷新方案
- 基于RefreshScope实现刷新
- 基于EnvironmentChangeEvent实现刷新
项目选用基于RefreshScope实现刷新。
1.bean上使用@RefreshScope注解
@ConfigurationProperties(prefix = "partners")
@Component("partnersConfig")
@RefreshScope
@Slf4j
@Data
public class PartnersConfig {
private List<FundProvider> fundProviders = Lists.newArrayList();
private List<LogisticsCompany> logisticsCompanies = Lists.newArrayList();
private List<InsuranceCompany> insuranceCompanies = Lists.newArrayList();
}
2.利用RefreshScope搭配@ApolloConfigChangeListener监听实现bean的动态刷新
其代码实现如下:
@Component
@Slf4j
public class ApolloRefreshConfig {
private final PartnersConfig partnersConfig;
private final AnXinSignProperty anXinSignProperty;
private final RefreshScope refreshScope;
public ApolloRefreshConfig(final PartnersConfig partnersConfig,
final AnXinSignProperty anXinSignProperty,
final RefreshScope refreshScope) {
this.partnersConfig = partnersConfig;
this.anXinSignProperty = anXinSignProperty;
this.refreshScope = refreshScope;
}
/**
* 记录配置更改事件
*
* @param changeEvent 配置更改事件
* @return void
*/
public static void printChange(ConfigChangeEvent changeEvent) {
Set<String> changeKeys = changeEvent.changedKeys();
if (!CollectionUtils.isEmpty(changeKeys)) {
for (String changeKey : changeKeys) {
ConfigChange configChange = changeEvent.getChange(changeKey);
log.info("apollo changed , key:" + changeKey + "; old value:" + configChange.getOldValue() + "; new value:" + configChange.getNewValue());
}
}
}
/**
* 监听partner配置更改,value为监听的配置文件
*
* @param configChangeEvent 配置更改事件
* @return void
*/
@ApolloConfigChangeListener(value = {"fund-provider-partners.properties", "insurance-companie-partners.properties", "logistics-company-partners.properties"})
private void refreshPartnersConfig(ConfigChangeEvent configChangeEvent) {
printChange(configChangeEvent);
log.info("before refresh {}", partnersConfig.toString());
refreshScope.refresh("partnersConfig");
log.info("after refresh {}", partnersConfig.toString());
}
/**
* 监听安心签配置更改,value默认监听application
*
* @param configChangeEvent 配置更改事件
* @return void
*/
@ApolloConfigChangeListener(interestedKeyPrefixes = "spring.cfca.anxinsign")
private void refreshAnXinSignProperty(ConfigChangeEvent configChangeEvent) {
printChange(configChangeEvent);
log.info("before refresh {}", anXinSignProperty.toString());
refreshScope.refresh("anXinSignProperty");
log.info("after refresh {}", anXinSignProperty.toString());
}
}