之前,笔者详细探讨了如何使用 Spring Cloud Config 管理配置,详见:
- 跟我学Spring Cloud(Finchley版)-19-Spring Cloud Config
- 跟我学Spring Cloud(Finchley版)-20-Spring Cloud Config-Git
- 跟我学Spring Cloud(Finchley版)-21Spring Cloud Config加解密
本节来探讨如何使用Nacos管理配置。
Nacos配置
1 进入Nacos控制台,点击导航栏的“配置列表”,然后点击右侧的“+” 按钮,如下图所示:
2 即可看到类似下图的界面:
其中,dataId 的完整格式为:${prefix}-${spring.profile.active}.${file-extension} 。
- prefix 默认为 spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
- spring.profile.active 即为当前环境对应的 profile,详情可以参考 Spring Boot文档。 注意:当 spring.profile.active 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成{file-extension}
- file-exetension 为配置内容的数据格式,可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。
编码
1 添依赖:
org.springframework.boot spring-boot-starter-web org.springframework.cloud spring-cloud-starter-alibaba-nacos-config org.springframework.cloud spring-cloud-dependencies Greenwich.RELEASEpomimportorg.springframework.cloud spring-cloud-starter-alibaba-nacos-config 0.2.1.RELEASE
2 加注解:
@SpringBootApplicationpublic class ConfigClientApplication { public static void main(String[] args) { SpringApplication.run(ConfigClientApplication.class, args); }}
3 写配置:bootstrap.yml
spring: application: name: microservice-foo cloud: nacos: config: server-addr: 127.0.0.1:8848 # 指定group group: DEFAULT_GROUP # 文件后缀,默认为properties file-extension: properties profiles: active: dev
4 写配置:application.yml
server: port: 8081
5 编写Controller:
@RestController@RefreshScopepublic class ConfigClientController { @Value("${profile}") private String profile; @GetMapping("/profile") public String hello() { return this.profile; }}
如代码所示,这里使用@Value("${profile}") 引用了一个名为profile 的配置属性。该配置属性使用Nacos进行管理。(dev-1.0)
测试1:配置管理
1 启动应用,可看到类似如下的日志:
2019-02-15 22:13:14.472 INFO 4474 --- [ main] o.s.c.a.n.c.NacosPropertySourceBuilder : Loading nacos data, dataId: 'microservice-foo-dev.properties', group: 'DEFAULT_GROUP'2019-02-15 22:13:14.473 INFO 4474 --- [ main] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource {name='NACOS', propertySources=[NacosPropertySource {name='microservice-foo-dev.properties'}, NacosPropertySource {name='microservice-foo.properties'}]}
这两行日志比较重要,它告诉我们当前应用获取了Nacos中的哪些配置文件。
2 访问http://localhost:8081/profile ,返回dev-1.0
测试2:配置刷新
1 将配置修改为dev-2.0 ,并发布,如下图:
2 再次访问http://localhost:8081/profile ,返回dev-2.0
3 可打印类似如下的日志:
2019-02-15 22:16:07.237 INFO 4474 --- [-127.0.0.1_8848] o.s.c.e.event.RefreshEventListener : Refresh keys changed: [profile]
该日志也比较重要,它告诉我们哪些配置属性刷新了。
注意点
- Nacos中的Data ID的格式务必写对,和应用对应,否则无法正确找到相应配置文件;
- 要想刷新配置属性,@RefreshScope 不能少,否则配置无法正常刷新。