20 图｜Nacos 手摸手教程

女爷i 2023-09-30 09:38 34阅读 0赞

![b258558b2c023076420271620a4fe628.png][]

Nacos 作为服务注册中心、配置中心，已经非常成熟了，业界的标杆，在讲解 Nacos 的架构原理之前，我先给大家来一篇开胃菜：讲解 Nacos 如何使用。

涉及到如下两个话题：

*  用 Nacos 作为注册中心。
 *  用 Nacos 作为配置中心。

由于本篇是针对 Nacos 的使用和配置教程，可能会略显枯燥，建议大家快速浏览一遍，然后收藏转发下，以后说不定就会用上了～～

本篇主要内容如下：

![2325d683dcdfada0c08271b4c3eabb2d.png][]

Nacos 是阿里巴巴开源的一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。

### 一、Nacos 作为注册中心 ###

#### 1.1 引入 Nacos 服务发现组件 ####

passjava-common模块的pom.xml文件引入Nacos 服务发现组件

<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，并对照操作系统实际情况之下如下命令。

1.  Linux/Unix/Mac 操作系统，执行命令 `sh startup.sh -m standalone`
2.  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

启动成功：

![bb74c10589f372ac3e5ef7c653f9375f.png][]

#### 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

![8bc9aeb94eaa92fa8f44b6e6f73b9486.png][]

*  查看已注册的服务
    
        passjava-channel 渠道微服务
        passjava-member 用户微服务
        passjava-study 学习微服务
        passjava-question 问题微服务
        passjava-content 内容微服务
    
    ![60f0891f60b6a389be696ecc3e2f897b.png][]

### 二、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);
    }

*  测试结果

![36339e1a05f206877d6ea1c69e600ac7.png][] mark

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

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

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

答案：有的，用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 元数据

![3e8a43c339552263340717a2b5d14fd8.png][] bootstrap.properties

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

![36d3169c11544fc7ec9a77b8a58d3d12.png][] Nacos后台新增配置

#### 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里面的配置。

![7bd363936c11c200fecc9b8caf70a28d.png][] 测试结果

#### 2.7 命名空间 ####

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

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

*  创建命名空间
    
    ![ff0224cc086ece90aa33fec961686c88.png][] 创建命名空间

# 创建5个命名空间
    passjava-channel
    passjava-content
    passjava-member
    passjava-question
    passjava-study

![f6ce3ce10000df416c833d5d2327fde2.png][] 命名空间

*  命名空间下创建配置
    
    我们打开配置列表菜单，可以看到有五个命名空间。
    
    ![d3fdfc94e85a5e88ba2452b747ebc2df.png][] 命名空间下创建配置

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

![eacfd73684efc797f296ee7d57c826a6.png][] 克隆配置

*  修改指定的命名空间
    
    bootstrap.properties配置命名空间
    
        spring.cloud.nacos.config.namespace=passjava-member
 *  测试配置是否生效
    
    修改passjava-member.properties的配置内容
    
    ![8a6f6de6ade37dbe111d2ee0bff621d0.png][] passjava-member.properties
    
    重启member服务
    
    访问方法：/member/sample/test-local-config
    
    执行结果：
    
        {
            "msg": "success",
            "code": 0,
            "nickname": "\"悟空member\"",
            "age": 30
        }
    
    说明获取的是passjava-member命名空间的配置

#### 2.8 分组 ####

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

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

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

![5ab022999cad3ad79715193e26c3c2c3.png][] dev环境 ![93a5032e45a181e711ca5da73058ee4b.png][] 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` 配置 #####

![6591b06e57b37ec93352646cefea99a6.png][] datasource.yml 配置

##### 2.9.2 配置中心新建`mybatis.yml` 配置 #####

![bd09886cb774a0640aa94e041703829d.png][] mybatis.yml配置

##### 2.9.3 配置中心新建`more.yml` 配置 #####

![e552eccbce1598fce85e95f1ff048b14.png][] more.yml配置

##### 2.9.4 克隆dev环境配置到test和prod环境 #####

![308b9f97ab1c300c6425b68d9494ebb8.png][] mark

##### 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
        }
    }

说明以上配置都生效了。

##### 更多配置项 #####

![c1923d47ac8bb2ff1497c60726d1f360.png][]

##### 2.9.10 使用Nacos总结 #####

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

![1e483ce25a78cdd8939f4427759cedc9.gif][]

往期推荐

![3aaba414cccabfc0dcf537691c0b0418.png][]

SpringCloud Ribbon中的7种负载均衡策略！

![dd8aff0798f8a2b91f34b0393c4c63c7.png][]

SpringCloud Nacos + Ribbon 调用服务的 2 种方法！

![b33b5fa7e74d0396b7d84e242c4d352e.png][]

Spring Cloud Alibaba Nacos 的 2 种健康检查机制！

![d2d30fda5e722937e3e63002796456b6.gif][]

[b258558b2c023076420271620a4fe628.png]: https://img-blog.csdnimg.cn/img_convert/b258558b2c023076420271620a4fe628.png
[2325d683dcdfada0c08271b4c3eabb2d.png]: https://img-blog.csdnimg.cn/img_convert/2325d683dcdfada0c08271b4c3eabb2d.png
[bb74c10589f372ac3e5ef7c653f9375f.png]: https://img-blog.csdnimg.cn/img_convert/bb74c10589f372ac3e5ef7c653f9375f.png
[8bc9aeb94eaa92fa8f44b6e6f73b9486.png]: https://img-blog.csdnimg.cn/img_convert/8bc9aeb94eaa92fa8f44b6e6f73b9486.png
[60f0891f60b6a389be696ecc3e2f897b.png]: https://img-blog.csdnimg.cn/img_convert/60f0891f60b6a389be696ecc3e2f897b.png
[36339e1a05f206877d6ea1c69e600ac7.png]: https://img-blog.csdnimg.cn/img_convert/36339e1a05f206877d6ea1c69e600ac7.png
[3e8a43c339552263340717a2b5d14fd8.png]: https://img-blog.csdnimg.cn/img_convert/3e8a43c339552263340717a2b5d14fd8.png
[36d3169c11544fc7ec9a77b8a58d3d12.png]: https://img-blog.csdnimg.cn/img_convert/36d3169c11544fc7ec9a77b8a58d3d12.png
[7bd363936c11c200fecc9b8caf70a28d.png]: https://img-blog.csdnimg.cn/img_convert/7bd363936c11c200fecc9b8caf70a28d.png
[ff0224cc086ece90aa33fec961686c88.png]: https://img-blog.csdnimg.cn/img_convert/ff0224cc086ece90aa33fec961686c88.png
[f6ce3ce10000df416c833d5d2327fde2.png]: https://img-blog.csdnimg.cn/img_convert/f6ce3ce10000df416c833d5d2327fde2.png
[d3fdfc94e85a5e88ba2452b747ebc2df.png]: https://img-blog.csdnimg.cn/img_convert/d3fdfc94e85a5e88ba2452b747ebc2df.png
[eacfd73684efc797f296ee7d57c826a6.png]: https://img-blog.csdnimg.cn/img_convert/eacfd73684efc797f296ee7d57c826a6.png
[8a6f6de6ade37dbe111d2ee0bff621d0.png]: https://img-blog.csdnimg.cn/img_convert/8a6f6de6ade37dbe111d2ee0bff621d0.png
[5ab022999cad3ad79715193e26c3c2c3.png]: https://img-blog.csdnimg.cn/img_convert/5ab022999cad3ad79715193e26c3c2c3.png
[93a5032e45a181e711ca5da73058ee4b.png]: https://img-blog.csdnimg.cn/img_convert/93a5032e45a181e711ca5da73058ee4b.png
[6591b06e57b37ec93352646cefea99a6.png]: https://img-blog.csdnimg.cn/img_convert/6591b06e57b37ec93352646cefea99a6.png
[bd09886cb774a0640aa94e041703829d.png]: https://img-blog.csdnimg.cn/img_convert/bd09886cb774a0640aa94e041703829d.png
[e552eccbce1598fce85e95f1ff048b14.png]: https://img-blog.csdnimg.cn/img_convert/e552eccbce1598fce85e95f1ff048b14.png
[308b9f97ab1c300c6425b68d9494ebb8.png]: https://img-blog.csdnimg.cn/img_convert/308b9f97ab1c300c6425b68d9494ebb8.png
[c1923d47ac8bb2ff1497c60726d1f360.png]: https://img-blog.csdnimg.cn/img_convert/c1923d47ac8bb2ff1497c60726d1f360.png
[1e483ce25a78cdd8939f4427759cedc9.gif]: https://img-blog.csdnimg.cn/img_convert/1e483ce25a78cdd8939f4427759cedc9.gif
[3aaba414cccabfc0dcf537691c0b0418.png]: https://img-blog.csdnimg.cn/img_convert/3aaba414cccabfc0dcf537691c0b0418.png
[dd8aff0798f8a2b91f34b0393c4c63c7.png]: https://img-blog.csdnimg.cn/img_convert/dd8aff0798f8a2b91f34b0393c4c63c7.png
[b33b5fa7e74d0396b7d84e242c4d352e.png]: https://img-blog.csdnimg.cn/img_convert/b33b5fa7e74d0396b7d84e242c4d352e.png
[d2d30fda5e722937e3e63002796456b6.gif]: https://img-blog.csdnimg.cn/img_convert/d2d30fda5e722937e3e63002796456b6.gif