PassJava 开源 (八) ：Spring Cloud 整合 Nacos 配置中心

2021 年 12 月 27 日
本文字数：3056 字
阅读完需：约 10 分钟

PassJava (佳必过) 项目全套学习教程连载中。

文档在线地址：www.passjava.cn

Spring Cloud 整合 Nacos 配置中心

1.传统配置方式

application.properties 文件中定义两个配置：

member.nickname = "悟空聊架构"member.age = "18"

复制代码

示例控制器中定义私有变量 nickname 和 age，@value 代表从配置中取值

@Value("${member.nickname}")private  String nickname;
@Value("$member.age")private  Integer age;

复制代码

示例控制器中定义方法：获取 nick 和 age 的值

@RequestMapping("/test-local-config")public R testLocalConfig() {    return R.ok().put("nickname", nickname).put("age", age);}

复制代码

测试结果

总结：从配置文件中获取配置。

这种方式的缺点是什么呢？如果要修改配置参数，则需要重新启动服务。如果服务很多，则需要重启所有服务，非常不方便。

有没有什么办法不停服务修改配置而且使其生效呢？

答案：有的，用 Spring Cloud Alibaba 的 Nacos 组件就可以完成。

2.引入 Nacos 依赖

PassJava-Common 项目的 pom.xml 文件引入 Spring Cloud Alibaba Nacos Config 依赖

<dependency>    <groupId>com.alibaba.cloud</groupId>    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId></dependency>

复制代码

3.配置 Nacos 元数据

passjava-member 添加 /src/main/resources/bootstrap.properties 配置文件（注意：bootstrap.properties 优先级高于其他配置文件）
配置 Nacos Config 元数据

spring.application.name=passjava-memberspring.cloud.nacos.config.server-addr=127.0.0.1:8848

复制代码

4.Nacos 后台新增配置

Data ID: passjava-member.properties

Group: DEFAULT_GROUP

配置格式:

member.nick="悟空"member.age=10

复制代码

5.开启动态刷新配置功能

添加注解 @RefreshScope 开启动态刷新配置功能

@RefreshScope@RestController@RequestMapping("member/sample")public class SampleController {}

复制代码

可以从控制台看到日志信息：

Refresh keys changed: [member.age]2020-04-19 23:34:07.154  INFO 8796 --- [-127.0.0.1_8848] c.a.nacos.client.config.impl.CacheData   : [fixed-127.0.0.1_8848] [notify-ok] dataId=passjava-member.properties, group=DEFAULT_GROUP, md5=df136e146c83cbf857567e75acb11e2b, listener=com.alibaba.cloud.nacos.refresh.NacosContextRefresher$1@4f49b78b 2020-04-19 23:34:07.154  INFO 8796 --- [-127.0.0.1_8848] c.a.nacos.client.config.impl.CacheData   : [fixed-127.0.0.1_8848] [notify-listener] time cost=529ms in ClientWorker, dataId=passjava-member.properties, group=DEFAULT_GROUP, md5=df136e146c83cbf857567e75acb11e2b, listener=com.alibaba.cloud.nacos.refresh.NacosContextRefresher$1@4f49b78b

复制代码

member.age 更新了，通知了 member 服务，刷新了配置。对应的配置 id 为passjava-member.properties，分组为DEFAULT_GROUP。监听器为com.alibaba.cloud.nacos.refresh.NacosContextRefresher

6.测试结果

访问：http://localhost:10000/member/sample/test-local-config

结果：nickname 和 age 和 Nacos 后台配置一致

结论：只用在 Nacos 后台改配置即可实时修改配置。

注意：Nacos 的配置项优先级高于 application.propertite 里面的配置。

7.命名空间

我们现在有 5 个微服务，每个微服务用到的配置可能都不一样，那不同微服务怎么样获取自己微服务的配置呢？

这里可以用到命名空间，我们针对每个微服务，都创建一个命名空间。

创建命名空间

# 创建5个命名空间passjava-channelpassjava-contentpassjava-memberpassjava-questionpassjava-study

复制代码

命名空间下创建配置
我们打开配置列表菜单，可以看到有五个命名空间。

选中 passjava-channel 命名空间，然后新增配置项，与之前新增配置的步骤一致，也可以通过克隆命名空间来克隆配置。

修改指定的命名空间
bootstrap.properties 配置命名空间

  spring.cloud.nacos.config.namespace=passjava-member

复制代码

测试配置是否生效
修改 passjava-member.properties 的配置内容
重启 member 服务
访问方法：/member/sample/test-local-config
执行结果：

  {      "msg": "success",      "code": 0,      "nickname": "\"悟空member\"",      "age": 30  }

复制代码

说明获取的是 passjava-member 命名空间的配置

8.分组

如果我们有多套环境，比如开发环境，测试环境，生产环境，每一套环境的配置参数不一样，那配置中心该如何配置呢？

我们可以使用配置中心的分组功能。每一套环境都是一套分组。

首先创建一套 dev 环境配置项，然后克隆配置到 test 和 prod 环境

bootstrap.properties 配置当前使用的分组：prod

spring.cloud.nacos.config.group=prod

复制代码

测试获取生产环境配置

  {      "msg": "success",      "code": 0,      "nickname": "\"悟空-prod\"",      "age": 10  }

复制代码

可以看到获取到的是 prod 分组的配置

9.多配置集

我们可以将 application.yml 文件中的 datasource、mybatis-plus 等配置进行拆解，放到配置中心。group 可以创建 3 套，dev/test/prod。

1.配置中心新建datasource.yml 配置

2.配置中心新建mybatis.yml 配置

3.配置中心新建more.yml 配置

4.克隆 dev 环境配置到 test 和 prod 环境

5.bootstrap.properties 增加 nacos 配置，application.yml 注释配置

spring.application.name=passjava-memberspring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.namespace=passjava-memberspring.cloud.nacos.config.group=prod
spring.cloud.nacos.config.extension-configs[0].data-id=datasource.ymlspring.cloud.nacos.config.extension-configs[0].group=devspring.cloud.nacos.config.extension-configs[0].refresh=true
spring.cloud.nacos.config.extension-configs[1].data-id=mybatis.ymlspring.cloud.nacos.config.extension-configs[1].group=devspring.cloud.nacos.config.extension-configs[1].refresh=true
spring.cloud.nacos.config.extension-configs[2].data-id=more.ymlspring.cloud.nacos.config.extension-configs[2].group=devspring.cloud.nacos.config.extension-configs[2].refresh=true

复制代码

6.测试配置是否生效

测试 passjava-member.properties 和 more.yml 配置是否生效

请求 url:http://localhost:10000/member/sample/test-local-config

返回配置的 nick 和 age，且端口是 10000，且 member 服务注册到注册中心

{    "msg": "success",    "code": 0,    "nickname": "\"悟空-prod1\"",    "age": 22}

复制代码

测试 datasource.yml 和 mybatis.yml 配置是否生效

请求 url:http://localhost:10000/member/member/list

返回数据库查询结果

{    "msg": "success",    "code": 0,    "page": {        "totalCount": 0,        "pageSize": 10,        "totalPage": 0,        "currPage": 1,        "list": []j    }}

复制代码

说明以上配置都生效了。

10.使用 Nacos 总结

1.引入 Nacos 依赖
2.配置 Nacos 数据源
3.配置中心配置数据集DataId和配置内容
4.开启动态刷新配置@RefreshScope
5.获取配置项的值@value
6.优先使用配置中心的配置
7.使用命名空间namespace来创建各服务的配置
8.使用分组group来区分不同环境
9.使用多配置集extension-configs区分不同类型的配置

代码地址

https://github.com/Jackson0714/PassJava-Platform

作者简介：悟空，8 年一线互联网开发和架构经验，用故事讲解分布式、架构设计、Java 核心技术。《JVM 性能优化实战》专栏作者，开源了《Spring Cloud 实战 PassJava》项目，公众号：悟空聊架构。个人网站：www.passjava.cn

发布于: 2 小时前

原文链接:【http://xie.infoq.cn/article/e945f3b1a5f70fb6c3c817887】。文章转载请联系作者。

悟空聊架构

关注

用故事、大白话讲解Java、分布式、架构设计 2018.05.06 加入

公众号：「悟空聊架构」【个人博客】www.passjava.cn 【开源项目】基于 SpringCloud 的一套面试刷题系统【Github】https://github.com/Jackson0714/PassJava-Platform

发布

暂无评论

创作场景

PassJava 开源 (八) ：Spring Cloud 整合 Nacos 配置中心

Spring Cloud 整合 Nacos 配置中心

1.传统配置方式

2.引入 Nacos 依赖

3.配置 Nacos 元数据

4.Nacos 后台新增配置

5.开启动态刷新配置功能

6.测试结果

7.命名空间

8.分组

9.多配置集

更多配置项

10.使用 Nacos 总结

代码地址

悟空聊架构

评论