如安在Spring Cloud中实现Nacos客户端登录密码加密

背景

公司规范要求配置文件里不能出现明文的密码。近来项目引入了Nacos作为服务的配置中心，使用的是spring-cloud-starter-alibaba-nacos-config这个包。
基本的bootstrap.yaml配置如下：

1. spring:
2.   cloud:
3.     nacos:
4.       config:
5.         server-addr: <host>:<port>
6.         prefix: application
7.         group: shared
8.         namespace: xxx
9.         file-extension: yaml
10.         username: user
11.         password: plain_text_password
12. ......

复制代码

那么如何将spring.cloud.nacos.config.password换为公司内部加密算法加密后的密码呢？
研究

打开spring-cloud-starter-alibaba-nacos-config的jar包，我们可以在META-INF/spring.factories这个文件中看到以下内容：

1. org.springframework.cloud.bootstrap.BootstrapConfiguration=\
2. com.alibaba.cloud.nacos.NacosConfigBootstrapConfiguration
3. ......

复制代码

Nacos在Spring Cloud的bootstrap阶段可以进行自动配置就是在这里指定的。接下来找到NacosConfigBootstrapConfiguration这个类，发现它获取配置的地方如下：

1. @Configuration(proxyBeanMethods = false)
2. @ConditionalOnProperty(name = "spring.cloud.nacos.config.enabled", matchIfMissing = true)
3. public class NacosConfigBootstrapConfiguration {
5.         @Bean
6.         @ConditionalOnMissingBean
7.         public NacosConfigProperties nacosConfigProperties() {
8.                 return new NacosConfigProperties();
9.         }
10. ......
11. }

复制代码

我们可以注意到，它的配置读取靠的是NacosConfigProperties这个类，而且在注入的方法上还添加了@ConditionalOnMissingBean，这就给我们自定义配置读取提供了可能。
按图索骥，我们观察NacosConfigProperties的实现：

1. @ConfigurationProperties(NacosConfigProperties.PREFIX)
2. public class NacosConfigProperties {
4.         public static final String PREFIX = "spring.cloud.nacos.config";
6.         ......
8.         @Autowired
9.         @JsonIgnore
10.         private Environment environment;
12.         @PostConstruct
13.         public void init() {
14.                 this.overrideFromEnv();
15.         }
17.         private void overrideFromEnv() {
18.                 if (StringUtils.isEmpty(this.getServerAddr())) {
19.                         String serverAddr = environment
20.                                         .resolvePlaceholders("${spring.cloud.nacos.config.server-addr:}");
21.                         if (StringUtils.isEmpty(serverAddr)) {
22.                                 serverAddr = environment.resolvePlaceholders(
23.                                                 "${spring.cloud.nacos.server-addr:localhost:8848}");
24.                         }
25.                         this.setServerAddr(serverAddr);
26.                 }
27.                 if (StringUtils.isEmpty(this.getUsername())) {
28.                         this.setUsername(
29.                                         environment.resolvePlaceholders("${spring.cloud.nacos.username:}"));
30.                 }
31.                 if (StringUtils.isEmpty(this.getPassword())) {
32.                         this.setPassword(
33.                                         environment.resolvePlaceholders("${spring.cloud.nacos.password:}"));
34.                 }
35.         }
36. ......
37. }

复制代码

这里的后处理方法init调用了一个从Spring Environment中读取配置的overrideFromEnv。我的想法简单粗暴，即继承这个NacosConfigProperties，重写init，在调用完父类方法之后执行公司的密码解密逻辑。因为这已经是在bean的后处理方法中添加的逻辑了，可以说是最后一道配置处理。
实现

话不多说，实现自己的配置类CustomNacosConfigProperties。

1. @ConfigurationProperties(NacosConfigProperties.PREFIX)
2. public class CustomNacosConfigProperties extends NacosConfigProperties {
4.     @Override
5.     @PostConstruct
6.     public void init() {
7.         super.init();
8.         if (!StringUtils.isEmpty(this.getPassword())) {
9.             // 调用你的密码解密逻辑
10.             this.setPassword(yourDecryptAlgorithm(this.getPassword()));
11.         }
12.     }
13. }

复制代码

接下来我们需要将默认的配置类替换成我们自己的实现，编写一个CustomNacosBootstrapAutoConfig。

1. @Configuration
2. @ConditionalOnProperty(name = "spring.cloud.nacos.config.enabled", matchIfMissing = true)
3. @Order(Ordered.HIGHEST_PRECEDENCE)
4. public class CustomNacosBootstrapAutoConfig {
6.     @Bean
7.     @ConditionalOnMissingBean
8.     public NacosConfigProperties nacosConfigProperties() {
9.         return new CustomNacosConfigProperties();
10.     }
11. }

复制代码

我们使用@Order(Ordered.HIGHEST_PRECEDENCE)注解来保证这个配置类优先于Nacos默认的NacosConfigBootstrapConfiguration。这样一来，Spring容器中的NacosConfigPropertiesbean就替换成了能自动解密密码的实现。
最后，我们只需将bootstrap.yaml中的spring.cloud.nacos.config.password配置项换为加密后的密码即可。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。