使用 Nacos 作为注册中心和配置中心
大家好，我是悟空呀，上次我们讲解了 OpenFeign 的架构原理，这次我们要来进入 Nacos 帝国了，Nacos 作为服务注册中心、配置中心，已经非常成熟了，业界的标杆，在讲解 Nacos 的架构原理之前，我先给大家来一篇开胃菜：讲解 Nacos 如何使用，涉及到如下两个话题：
- 用 Nacos 作为注册中心。
- 用 Nacos 作为配置中心。
由于本篇是针对 Nacos 的使用和配置教程，可能会略显枯燥，建议大家快速浏览一遍，然后收藏转发下，以后说不定就会用上了～～
本篇主要内容如下：
老规矩，本篇所有示例代码都是用我的开源 SpringCloud 项目 PassJava 作为示例。
开源地址: https://github.com/Jackson0714/PassJava-Platform
喜欢的小伙伴来点个 Star 吧，冲 2K Star。
PassJava 架构图如下所示：
Nacos 是阿里巴巴开源的一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。
一、Nacos 作为注册中心
1.1 引入 Nacos 服务发现组件
passjava-common模块的pom.xml文件引入Nacos 服务发现组件
<!-- nacos discovery 服务发现组件-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
1.2 下载 Nacos Server 工具包并启动
注意：我在 Windows 和 Mac 上都测试过，都可以正常使用。
- 下载Nacos Server 压缩包
https://github.com/alibaba/nacos/releases
启动 Server，进入解压后文件夹或编译打包好的文件夹，找到如下相对文件夹 nacos/bin，并对照操作系统实际情况之下如下命令。
- Linux/Unix/Mac 操作系统，执行命令
sh startup.sh -m standalone - Windows 操作系统，执行命令
cmd startup.cmd
windows执行startupm.cmd遇到问题：
λ startup.cmd
Please set the JAVA_HOME variable in your environment, We need java(x64)! jdk8 or later is better!
解决方案：
修改startup.cmd文件中的 %JAVA_HOME%
%JAVA_HOME% 替换为 C:\Program Files\Java\jdk1.8.0_131
启动成功：
1.3 每个微服务都配置 Nacos Server 地址
- 配置Nacos Server 地址
在passjava-question、passjava-channel、passjava-content、passjava-member、passjava-study 应用的 /src/main/resources/application.yml配置文件中配置 Nacos Server 地址
spring:
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
1.4 添加注解
为每个服务使用 @EnableDiscoveryClient 注解开启服务注册与发现功能
@EnableDiscoveryClient
@MapperScan("com.jackson0714.passjava.question.dao")
@SpringBootApplication
public class PassjavaQuestionApplication {
public static void main(String[] args) {
SpringApplication.run(PassjavaQuestionApplication.class, args);
}
}
1.5 配置微服务的名称
spring:
application:
name: passjava-question
1.6 访问nacos server后台
- 登录后台
http://localhost:8848/nacos/index.html#/login
用户名：nacos
密码：nacos
-
查看已注册的服务
passjava-channel 渠道微服务 passjava-member 用户微服务 passjava-study 学习微服务 passjava-question 问题微服务 passjava-content 内容微服务
二、Nacos 作为配置中心
2.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.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>
2.3 配置Nacos元数据
-
passjava-member 添加 /src/main/resources/bootstrap.properties 配置文件（注意：bootstrap.properties 优先级高于其他配置文件）
-
配置 Nacos Config 元数据
spring.application.name=passjava-member
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
2.4 Nacos后台新增配置
Data ID: passjava-member.properties
Group: DEFAULT_GROUP
配置格式:
member.nick="悟空"
member.age=10
2.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
2.6 测试结果
访问：http://localhost:10000/member/sample/test-local-config
结果：nickname和age和Nacos后台配置一致
结论：只用在Nacos后台改配置即可实时修改配置。
注意：Nacos的配置项优先级高于application.propertite里面的配置。
2.7 命名空间
我们现在有5个微服务，每个微服务用到的配置可能都不一样，那不同微服务怎么样获取自己微服务的配置呢？
这里可以用到命名空间，我们针对每个微服务，都创建一个命名空间。
-
创建命名空间
# 创建5个命名空间
passjava-channel
passjava-content
passjava-member
passjava-question
passjava-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命名空间的配置
2.8 分组
如果我们有多套环境，比如开发环境，测试环境，生产环境，每一套环境的配置参数不一样，那配置中心该如何配置呢？
我们可以使用配置中心的分组功能。每一套环境都是一套分组。
- 首先创建一套dev环境配置项，然后克隆配置到test和prod环境
- bootstrap.properties配置当前使用的分组：prod
spring.cloud.nacos.config.group=prod
-
测试获取生产环境配置
{ "msg": "success", "code": 0, "nickname": "\"悟空-prod\"", "age": 10 }可以看到获取到的是prod分组的配置
2.9 多配置集
我们可以将application.yml文件中的datasource、mybatis-plus等配置进行拆解，放到配置中心。group可以创建3套，dev/test/prod。
2.9.1 配置中心新建datasource.yml 配置
2.9.2 配置中心新建mybatis.yml 配置
2.9.3 配置中心新建more.yml 配置
2.9.4 克隆dev环境配置到test和prod环境
2.9.5 bootstrap.properties增加nacos配置，application.yml注释配置
spring.application.name=passjava-member
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.namespace=passjava-member
spring.cloud.nacos.config.group=prod
spring.cloud.nacos.config.extension-configs[0].data-id=datasource.yml
spring.cloud.nacos.config.extension-configs[0].group=dev
spring.cloud.nacos.config.extension-configs[0].refresh=true
spring.cloud.nacos.config.extension-configs[1].data-id=mybatis.yml
spring.cloud.nacos.config.extension-configs[1].group=dev
spring.cloud.nacos.config.extension-configs[1].refresh=true
spring.cloud.nacos.config.extension-configs[2].data-id=more.yml
spring.cloud.nacos.config.extension-configs[2].group=dev
spring.cloud.nacos.config.extension-configs[2].refresh=true
2.9.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
}
}
说明以上配置都生效了。
更多配置项
| 配置项 | key | 默认值 | 说明 |
|---|---|---|---|
| 服务端地址 | spring.cloud.nacos.config.server-addr | ||
| DataId前缀 | spring.cloud.nacos.config.prefix | spring.application.name | |
| Group | spring.cloud.nacos.config.group | DEFAULT_GROUP | |
| dataID后缀及内容文件格式 | spring.cloud.nacos.config.file-extension | properties | dataId的后缀，同时也是配置内容的文件格式，目前只支持 properties |
| 配置内容的编码方式 | spring.cloud.nacos.config.encode | UTF-8 | 配置的编码 |
| 获取配置的超时时间 | spring.cloud.nacos.config.timeout | 3000 | 单位为 ms |
| 配置的命名空间 | spring.cloud.nacos.config.namespace | 常用场景之一是不同环境的配置的区分隔离，例如开发测试环境和生产环境的资源隔离等。 | |
| AccessKey | spring.cloud.nacos.config.access-key | ||
| SecretKey | spring.cloud.nacos.config.secret-key | ||
| 相对路径 | spring.cloud.nacos.config.context-path | 服务端 API 的相对路径 | |
| 接入点 | spring.cloud.nacos.config.endpoint | UTF-8 | 地域的某个服务的入口域名，通过此域名可以动态地拿到服务端地址 |
| 是否开启监听和自动刷新 | spring.cloud.nacos.config.refresh-enabled | true |
2.9.10 使用Nacos总结
-
1.引入Nacos依赖
-
2.配置Nacos数据源
-
3.配置中心配置数据集
DataId和配置内容 -
4.开启动态刷新配置
@RefreshScope -
5.获取配置项的值
@value -
6.优先使用配置中心的配置
-
7.使用命名空间
namespace来创建各服务的配置 -
8.使用分组
group来区分不同环境 -
9.使用多配置集
extension-configs区分不同类型的配置
后记
Nacos 的底层原理正在更新中，祝大家新年快乐啊，可不要太卷哦～
Spring Cloud 底层原理文章汇总：
[10000字 | 深入理解 OpenFeign 的架构原理](
扫一扫
2001
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
