apollo实例配置热更新
# apollo配置中心修改配置之后,如何通知到springboot应用(apollo客户端),也就是实现应用配置的热更新(不重启就对应用生效)。因此我们还需要思考几个问题:
- 是不是所有的配置都可以热更新?先给出答案:不是
- 那么哪些配置可以热更新?
# 一、哪些配置可以热更新
在谈配置热更新以前,我们先将配置分成两类:
- 第一类是影响应用运行状态的配置,这一类的配置通常会影响Spring Bean的自动装载。比如:数据库连接配置,在应用启动的时候会自动根据数据库配置初始化一个数据库连接池,连接池中保存着n个激活的数据库连接,以供业务持久化操作调用。**这一类的配置是不能热更新的,或者准确的说即使配置数据本身更新了也没有用,数据库用户名密码配置更新了不等于数据库连接池里面的连接对象也更新了。**配置背后的应用对象重构工作,apollo是无法帮你做到的(配置更新后只有应用重启才能生效)
第一类配置的热更新也不是完全无法做到,可以自己写程序对配置数据变化进行监听,然后重新初始化其关联对象就可以实现。
- 第二类是业务运行所需的数据,比如:新建用户时的默认密码,重置用户时的默认密码。这一类的配置发生变更修改的就是配置数据本身,它不去影响程序的其他对象,不产生其他的连锁反应。(下面我们会举一个实际案例说明)
# 二、支持哪些配置注解
Spring Boot中最常用的配置注解,Apollo都可以实现配置自动更新。下面两个例子都可以将"user.init.password"键对应的值热更新到password和defaultPwd对象上。
@RefreshScope //这里需要加上RefreshScope注解,结合ConfigurationProperties一起使用
@ConfigurationProperties(prefix = "user.init")
public class User{
private String password;
}
1
2
3
4
5
2
3
4
5
对于bean的属性实时更新也可以添加监听类
@Component
@Slf4j
public class ApolloPropertiesChangedListener implements ApplicationContextAware {
private ApplicationContext applicationContext;
@ApolloConfigChangeListener
private void someChangeHandler(ConfigChangeEvent changeEvent) {
for (String key : changeEvent.changedKeys()) {
ConfigChange change = changeEvent.getChange(key);
log.info("Found change - {}", change.toString());
}
// 更新相应的bean的属性值,主要是存在@ConfigurationProperties注解的bean
this.applicationContext.publishEvent(new EnvironmentChangeEvent(changeEvent.changedKeys()));
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
下文中会针对这种@Value注解的方法为例进行讲解。
public class Xxxxx{
@Value("${user.init.password}")
private String defaultPwd;
}
1
2
3
4
2
3
4
# 三、代码业务实战
我们在《第一个微服务》调用章节,就介绍了aservice-rbac下面的服务:为用户重置密码的服务,前面的章节我们多次用到。其中红色的部分:从数据库的sys_config表里面加载param_key="user.init.password"对应的param_value(也就是用户的默认密码)。
现在我们有了apollo服务配置中心,这个sys_config数据库表我们就完全可以放弃了。首先,我们去apollo服务配置中心,增加配置:user.init.password,并将其发布
然后我们修改代码,使用@Value注解,当apollo配置中心配置发生修改的时候会自动刷新defaultPwd数据
@Service
public class SysuserService {
/*@Resource
private DbLoadSysConfig dbLoadSysConfig;*/
@Value("${user.init.password}")
private String defaultPwd;
public void pwdreset(Integer userId){
if(userId == null){
throw new CustomException(CustomExceptionType.USER_INPUT_ERROR,
"重置密码必须带主键");
}else{
SysUser sysUser = sysUserMapper.selectByPrimaryKey(userId);
//String defaultPwd = dbLoadSysConfig.getConfigItem("user.init.password");
sysUser.setPassword(passwordEncoder.encode(defaultPwd));
sysUserMapper.updateByPrimaryKeySelective(sysUser);
smsService.send(sysUser.getPhone(),"您好,管理员已经将您的密码重置为" + defaultPwd);
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
启动aservice-rbac服务,并使用postman像其“/pwd/reset端口发送重置密码请求”
下断点,查看defaultPwd的值为:12345678,说明启动加载配置成功
去Apollo将user.init.password值改为Abcd1234,并发布
可以看到如上的日志输出,说明我们的apollo配置热更新成功了。再次postman发送请求,下断点defaultPwd的值为:Abcd1234,同样可以印证配置热更新成功。
上次更新: 2022/06/13, 18:30:58