Nacos笔记（初级）

参考文档：Nacos官网 博客

一，基本概述

Nacos 是阿里巴巴推出来的一个新开源项目，是一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。Nacos 致力于帮助您发现、配置和管理微服务。Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据及流量管理。Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。 Nacos 是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。

从这段话中我们发现，相较于SpringCloud这个原生的体系来讲，一个nacos它完成了Spring Cloud Eureka, Spring Cloud Config的所有工作。简化了我们的工作。

受欢迎的原因：

再上一篇博客中，我们是使用的原生的SpringCloud的组件Eureka和Config，它给我们的第一反映就是及其复杂，尤其是Config，还需要进行连接git去操作，看的人头晕眼花。

反观我们的Nacos，帮助您更敏捷和容易地构建、交付和管理微服务平台。不需要我们去手动搭建一个服务，我们只用管服务的提供者和消费这即可。最重要的一点是，它是有中英文界面的，而且官方文档也是有中文的，对于我们来说是很友好的。

官方文档

注意：
Nacos是由严格的版本依赖关系的，具体依赖如下图：

一定要按照对应的版本来配置，不然容易出莫名其妙的错误。

这里我用的版本依赖如下：

<dependencyManagement>
    <dependencies>
        <!--Spring Cloud-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Hoxton.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
		<dependency>
            <groupId>org.springframework.boot</groupId>
        	<artifactId>spring-boot-dependencies</artifactId>
        	<version>2.2.1.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>0.2.2.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

如果版本和我是一样的，那么就去找1.1.4的nacos版本，网址为 Release 1.1.4(Oct 24th, 2019) · alibaba/nacos (github.com) ，如果不一样，可以根据上面的图去找对应的版本。

下载完成之后直接解压即可，从它的目录结构和文件名称一看这就是一个Spring Boot 项目。

进入/bin目录，有两个脚本，如下：

• startup.cmd：windows平台的启动脚本
• startup.sh：Linux平台的启动脚本

由于作者本地是windows，直接双击startup.cmd启动项目，出现以下界面则启动完成：

在浏览器输入http://localhost:8848/nacos进入Nacos的登录界面。

二，服务的发现

对于服务的注册和发现，我们上一篇用的是Eureka，是需要我们字节去构建一个Eureka的微服务去充当Eureka的服务器，但是我们整合Nacos则不需要这么复杂，直接启动Nacos服务即可。

使用一张官方的架构图：

我们开始具体演示效果图

根据上面的图，我们也创建两个服务， 分别是nacos-provider(服务提供者)、nacos-consumer(服务消费者)，职责如下：

• nacos-provider：注册进入nacos-server，对外暴露服务
• nacos-consumer：注册进入nacos-server，调用nacos-provider的服务

1，nacos-provider

由于使用了多模块聚合项目，只需要创建一个nacos-provider模块即可。步骤如下：

1.1，添加依赖

需要添加spring-cloud-starter-alibaba-nacos-discovery这个依赖，如下图：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

由于父模板中指定了spring-cloud-alibaba-dependencies的版本，子模块中直接引入依赖即可，不需要指定版本号，这样才能达到版本管理的效果。

1.2，配置yml文件

再配置文件中指定服务的名称，端口号，nacos-server的地址信息等，如下：

server:
  port: 9001
spring:
  application:
    ## 指定服务名称，在nacos中的名字
    name: nacos-provider
  cloud:
    nacos:
      discovery:
        # nacos的服务地址，nacos-server中IP地址:端口号
        server-addr: 127.0.0.1:8848
management:
  endpoints:
    web:
      exposure:
        ## yml文件中存在特殊字符，必须用单引号包含，否则启动报错
        include: '*'

1.3，开启服务注册发现功能

这个和大部分Springboot功能模块是一样的，都需要使用@EnableXXX注解来开启每个功能，否则无法引入自动配置。这里需要引入SpringCloud的原生注解@EnableDiscoveryClient来开启服务注册发现的功能，如下：

@SpringBootApplication
@EnableDiscoveryClient
public class NacosProviderApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosProviderApplication.class, args);
    }

}

1.4，随意写一个服务

nacos-provider作为服务提供者注册到nacos中，肯定需要提供个服务来供消费者（nacos-consumer）调用，下面是随便写的一个接口：

@RestController
@RequestMapping("/nacos")
public class TestController {
    @GetMapping("/test/{id}")
    public String test(@PathVariable("id")Integer id) {
        return "message" + id;
    }
}

1.5，启动项目

我们就会发现多了一个nacos服务。

2，nacos-consumer

2.1，添加依赖

需要添加spring-cloud-starter-alibaba-nacos-discovery这个依赖，如下图：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

由于父模板中指定了spring-cloud-alibaba-dependencies的版本，子模块中直接引入依赖即可，不需要指定版本号，这样才能达到版本管理的效果。

2.2，配置yml文件

再配置文件中指定服务的名称，端口号，nacos-server的地址信息等，如下：

server:
  port: 9002
spring:
  application:
    name: nacos-consumer
  cloud:
    nacos:
      discovery:
        # nacos的服务地址
        server-addr: 127.0.0.1:8848
service-url:
  nacos-provider: http://nacos-provider
management:
  endpoints:
    web:
      exposure:
        ## yml文件中存在特殊字符，必须用单引号包含，否则启动报错
        include: '*'

1.3，开启服务注册发现功能

使用@EnableDiscoveryClient标注，如下图：

@SpringBootApplication
@EnableDiscoveryClient
public class NacosConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosProviderApplication.class, args);
    }

}

1.4，随意写一个演示服务

其实Nacos集成了Ribbon，何以见得呢？打开spring-cloud-starter-alibaba-nacos-discovery的依赖一看便知，如下图：

因此我们便能使用Ribbon的负载均衡来调用服务，步骤如下：

• 创建RestTemplate，使用@LoadBalanced注解标注开启负载均衡，如下图：

  

• 直接使用注册到nacos的中的服务名作为访问地址调用服务，如下图：

  

• 上图中的serviceUrl是什么东西呢？难道是IP地址？当然不是，既然nacos-provider和nacos-consumer都已经注册到nacos中，那么可能是可以直接通过服务名直接找到对应得服务，因此这个serviceUrl=http://service-name，如下图：

  

• OK，至此nacos-consumer已经准备完成，下面就可以启动项目。

2.5，启动项目

启动成功之后将会在nacos中的服务列表中查看到两个服务，分别是nacos-provider、nacos-consumer，如下图：

此时服务提供者和消费者都已成功注册到Nacos，那么接下来就是测试服务能否调的通的问题了。

直接调用nacos-consumer的接口，输入地址：http://localhost:9002/nacos/test/16。

三，启动配置管理

对于所有的微服务而言，配置管理是很重要的，因为我们不可能修改配置文件而停服更新。之前我们是用的SpringCloud的config模块，它需要搭建一个Config微服务，还要集成GitHub，十分复杂。

1，开始演示

新建一个模块nacos-config用来整合Nacos实现配置管理，项目结构如下：

Nacos配置列表在哪里能看到呢？在管理平台->配置管理->配置列表这一栏，如下图：

2，添加依赖

由于使用了模块聚合的工程，因此不需要指定版本号，依赖如下：

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

3，配置YAML文件

在bootstrap.yml文件中设置Nacos的配置，如下：

spring:
  application:
    name: nacos-config
    ## 当前环境，这个和dataId有关-> ${prefix}-${spring.profiles.active}.${file-extension}
  profiles:
    active: dev
  cloud:
    nacos:
      config:
        ## nacos的地址，作为配置中心
        server-addr: 127.0.0.1:8848
        ## 配置内容的数据格式，目前只支持 properties 和 yaml 类型，这个和dataId有关-> ${prefix}-${spring.profiles.active}.${file-extension}
        file-extension: properties
management:
  endpoints:
    web:
      exposure:
        ## yml文件中存在特殊字符，必须用单引号包含，否则启动报错
        include: '*'

4，Data ID是什么？

dataId是一个配置的唯一标识，怎么取值呢？格式如下：

${prefix}-${spring.profiles.active}.${file-extension}

• prefix：前缀，默认是spring.application.name的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
• spring.profiles.active： 即为当前环境对应的 profile。当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.${file-extension}
• file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

5，添加一个配置

下面在nacos中添加一个config.version的配置，如下图：

6，获取nacos中的配置

获取nacos中的配置很简单，使用原生注解@Value()直接读取即可，步骤如下：

• 新建一个实体类DynamicConfigEntity：

  @Component
  @Data
  public class DynamicConfigEntity {
  
      //直接读取nacos中config.version的配置
      @Value("${config.version}")
      private String version;
  }
  

• 新建一个controller测试，如下：

  @RestController
  @RequestMapping("/nacos")
  public class NacosController {
  
      @Autowired
      private DynamicConfigEntity entity;
  
  
      @GetMapping("/test/{id}")
      public String test(@PathVariable("id")Integer id){
          return "accept one msg id="+id+"----- version="+entity.getVersion();
      }
  }
  

• 运行项目成功后，在浏览器输入地址：http://localhost:9003/nacos/test/1，返回如下结果：

7，配置如何动态刷新？

设想一下：现在由于需求改变了，我需要将config.version这个配置改成2，那么我直接改变Nacos中的配置会生效吗？

不妨试一下，直接将Nacos中的配置修改成2，如下图：

此时我们再不重启项目的情况下访问：http://localhost:9003/nacos/test/1，结果如下图：

其实想要Nacos自动刷新配置还需要结合原生注解@RefreshScope，这个注解是不是很眼熟，在Config中也是用这个注解刷新配置，我们只需要将该注解标注在配置的实体类上即可，如下

@Component
@RefreshScope
@Data
public class DynamicConfigEntity {

    //直接读取nacos中config.version的配置
    @Value("${config.version}")
    private String version;
}

此时加上@RefreshScope重启之后将Nacos中config.version这个配置改成3，然后访问http://localhost:9003/nacos/test/1，结果如下图：

8，多环境如何隔离配置？（Namespace）

试想一下：正常的业务开发至少有三个环境吧，如下：

• dev：本地开发环境
• test：测试环境
• prod：生产环境

那么每个环境的配置肯定是不同的，那么问题来了，如何将以上三种不同的配置在Nacos能够很明显的区分呢？

很多人可能会问：DataId格式中不是有环境的区分吗？这个不是可以满足吗？

DataId当然能够区分，但是微服务配置可不止这几个啊？一旦多了你怎么查找呢？多种环境的配置杂糅到一起，你好辨别吗？

当然阿里巴巴的Nacos开发团队显然考虑到了这种问题，官方推荐用命名空间（namespace）来解决环境配置隔离的问题。

Namespace（命名空间）：解决多环境及多租户数据的隔离问题 在多套不同的环境下，可以根据指定的环境创建不同的Namespace，实现多环境的数据隔离

Nacos中默认提供的命名空间则是public，上述我们创建的config.version这个配置就属于public这个命名空间，如下图：

创建了三个，分别是dev、test、prod，如下图：

注意：上图中的 命名空间ID是系统自动生成的唯一ID，后续指定不同的Namespace就用这个ID。

既然Nacos中的Namespace配置好了，那么微服务中如何配置呢？前面也说过，Nacos默认指定的命名空间是public，那么如何在项目中指定命名空间呢？

其实很简单，假设在test这个命名空间中添加一个config.version=4，如下图：

此时只需要在bootstrap.yml配置中指定如下配置：

spring:
  application:
    name: nacos-config
  cloud:
    nacos:
      config:
      ## namespace的取值是命名空间ID，这里取的是test命名空间ID
        namespace: d0ffeec2-3deb-4540-9664-fdd77461fd6b

注意：Namespace必须在bootstrap.yml配置文件中指定，否则不生效。

至此，已经全部配置完毕，启动项目，浏览器访问http://localhost:9003/nacos/test/1，结果如下图：

9，不同业务配置如何隔离？(Group)

试想以下场景：有两个微服务，一个是订单系统，一个是用户系统，但是他们有着相同的配置，比如datasource-url，那么如何区分呢？

此时Group就派上用场了，顾名思义Group是分组的意思。

Group：Nacos 中的一组配置集，是组织配置的维度之一，简单的说则是不同的系统或微服务的配置文件可以放在一个组里。Nacos如果不指定Group，则默认的分组是DEFAULT_GROUP。

上述场景中订单系统、用户系统可以单独分为一个组，比如ORDER_GROUP、USER_GROUP。当然这是比较细粒度的分组，根据企业的业务也可以多个微服务分为一组。

下面在Nacos中新建一个config.version=5，命名空间为test，分组为ORDER_GROUP，如下图：

此时命名空间test中的配置如下图：

在bootstrap.yml配置文件中指定分组，配置如下：

spring:
  application:
    name: nacos-config
  cloud:
    nacos:
      config:
        ## 指定命名空间
        namespace: d0ffeec2-3deb-4540-9664-fdd77461fd6b
        ## 指定分组为ORDER_GROUP
        group: ORDER_GROUP

注意：Group配置和Namespace一样，要在bootstrap.yml文件中配置。

至此，已经全部配置完毕，启动项目，浏览器访问http://localhost:9003/nacos/test/1，结果如下图：

总结

Nacos实现配置管理和动态配置刷新很简单，总结如下步骤：

1. 添加对应spring-cloud-starter-alibaba-nacos-config依赖
2. 使用原生注解@Value()导入配置
3. 使用原生注解@RefreshScope刷新配置
4. 根据自己业务场景做好多环境配置隔离(Namespace)、不同业务配置隔离(Group)
5. 切记：命名空间和分组的配置一定要放在bootstrap.yml或者bootstrap.properties配置文件中

四，Nacos如何共享配置？

场景：一个项目的微服务数量逐渐增多，势必会有相同的配置，那么我们可以将相同的配置抽取出来作为项目中共有的配置，比如集群中的数据源信息…

Nacos的共享配置能够完美的解决上述问题，配置起来也是很简单，没办法，就是这么强大。

1，Nacos中新建共享配置

这里演示两个共享配置，DataId分别是share-config1.properties，share-config2.properties，如下图：

注意：DataId一定要带有后缀properties或者yml

share-config1.properties配置中的内容如下：

database.url=jdbc:mysql://112.111.0.135:3306/nacos_config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true

share-config2.properties配置中的内容如下：

database.user=root

2，新建模块nacos-config-share

此处新建一个模块nacos-config-share来演示效果，依赖同nacos-config

bootstrap.yml配置如下：

spring:
  application:
    name: nacos-config-share
  cloud:
    nacos:
      config:
        ## 指定命名空间
        namespace: 51f0479b-a88d-4646-902b-f2a063801502
        ## nacos的地址，作为配置中心
        server-addr: 127.0.0.1:8848
        ## 配置内容的数据格式，目前只支持 properties 和 yaml 类型，这个和dataId有关-> ${prefix}-${spring.profiles.active}.${file-extension}
        file-extension: properties
management:
  endpoints:
    web:
      exposure:
        ## yml文件中存在特殊字符，必须用单引号包含，否则启动报错
        include: '*'

以上的配置和nacos-config差不多，指定application.name、命名空间、file-extension、nacos服务地址…

当然除了以上配置肯定是不够的，要想共享配置还需要添加以下配置：

spring:
  application:
    name: nacos-config-share
  cloud:
    nacos:
      config:
        ## 共享配置，List集合，可以配置多个
        shared-configs:
          ## dataId：配置文件的dataId，必须带有后缀
          - dataId: share-config1.properties
          ## refresh：指定是否能够动态刷新，默认是false
            refresh: true
          - dataId: share-config2.properties
          ## 指定配置文件的分组，默认是DEFAULT_GROUP
            group: ORDER_GROUP
            refresh: true

想要看到效果，肯定是需要通过@Value()导入配置，如下：

@Component
@RefreshScope
@Data
public class DynamicConfigEntity {
    //获取共享配置文件中database.url
    @Value("${database.url}")
    private String databaseUrl;

    //获取共享配置文件中database.user
    @Value("${database.user}")
    private String user;
}

上面配置完毕，启动nacos-config-share这个项目，访问：http://localhost:9003/nacos/test/1，结果如下图：

五，Nacos如何持久化？

前面讲了这么多，大家有没有思考过一个问题，Nacos的一系列的配置究竟存储在哪里呢？

其实Nacos默认使用的是内嵌的数据库Derby，这个在Nacos-server文件下的/data目录下就可以验证，如下图：

那么问题来了，这些配置如何用自己的数据库存储呢？

目前Nacos仅支持Mysql数据库，且版本要求：5.6.5+

初始化数据库

首先在Mysql中新建一个数据库nacos-config（名称随意），然后执行Nacos中的SQL脚本，该脚本是Nacos-server文件夹中的nacos-mysql.sql，如下图：

执行该脚本，将会自动创建表，如下图：

修改配置文件

Nacos-server也是一个Spring Boot 项目，想要连接自己的数据库，当然要配置数据源了，那么在哪里配置呢？

配置文件同样在Nacos-server中的conf目录下，如下图：

只需要将application.properties中的Mysql配置取消注释并且配置好自己的数据源即可，如下图：

修改完毕，重新启动Nacos-server。

如何验证是否持久化呢？很简单，只需要创建一个配置，然后在his_config_info表中查看下是否存在即可，如下图：

六，Nacos集群如何搭建？

Nacos推荐集群模式部署，这样可以避免单点故障，那么如何搭建集群呢？请看官方文档：nacos.io/zh-cn/docs/…

话不多说，偷一张官网的架构图，如下：

上图什么意思呢？说实话，这文档写的真不咋的，很多除初学者一看就懵，请看陈某的架构图，如下：

请求进来先共同Nginx集群进行转发到Nacos集群中，当然为了保持高可用，数据库必须也是集群模式。

Nacos官方推荐Linux下搭建集群模式，因此陈某尝试在Linux环境下搭建。Nginx和Mysql这里集群就不再演示如何搭建了，不是今天的重点，主要演示下Nacos集群的搭建方法。

下载Linux下的Nacos

在GitHub上下载自己对应的版本，陈某用的版本是1.2.1，地址：github.com/alibaba/nac…

找到后缀为tar.gz的文件下载，如下图：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rRufXIFr-1653731106322)(Nacos%20(2)].assets/1653730938064.png)

修改配置文件

由于条件限制，陈某仅仅在一台服务器上启动三个Nacos服务演示。Nacos的端口分别为8848、8849、8850。

修改端口号

Nacos默认的端口号是8848，那么如何修改端口呢？只需要修改conf目录下的application.properties中的server.port即可，如下图：

修改集群配置

那么如何配置集群呢？在conf目录下有一个cluster.conf.example文件

只需要将cluster.conf.example这个文件复制一份为cluster.conf放在conf目录下，其中配置的内容如下：

172.16.1.84:8848
172.16.1.84:8849
172.16.1.84:8850

什么意思呢？172.16.1.84是服务器的IP地址，这里填写自己服务器的IP，:后面的是Nacos的端口号。

修改数据源

这个在持久化的那里已经讲过了，只需要将application.properties中的数据源替换掉，如下图：

启动Nacos

经过上述的步骤Nacos集群已经配置好了，现在分别启动Nacos，命令如下：

bash -f ./startup.sh
复制代码

启动成功，访问任意一个端口的Nacos服务，在集群管理->节点列表中将会看到自己搭建的三个节点，如下图：

Nginx中配置

此处就不演示Nginx集群搭建了，直接在单机的Nginx中配置。直接修改nginx的conf文件，内容如下：

upstream nacos{
		server 172.16.1.84:8848;
		server 172.16.1.84:8849;
		server 172.16.1.84:8850;
	 }
	 
	 server{
		listen 80;
		location / {
			proxy_pass http://nacos;
		}
	 }
复制代码

相信大家都能看懂，此处就不再做过多解释了…配置完成后，启动Nginx，直接访问：http://ip/nacos。

项目中配置server-addr

既然搭建了集群，那么项目中也要配置一下，有两种方式，下面分别介绍。

第一种：通过直连的方式配置，如下：

spring:
  application:
    ## 指定服务名称，在nacos中的名字
    name: nacos-provider
  cloud:
    nacos:
      discovery:
        # nacos的服务地址，nacos-server中IP地址:端口号
        server-addr: 172.16.1.84:8848,172.16.1.84:8849,172.16.1.84:8850
复制代码

第二种：直接连接Nginx，如下：

spring:
  application:
    ## 指定服务名称，在nacos中的名字
    name: nacos-provider
  cloud:
    nacos:
      discovery:
        # nacos的服务地址，nacos-server中IP地址:端口号
        server-addr: 172.16.1.84:80
复制代码

总结

Nacos集群搭建非常简单，唯一的配置就是cluster.conf中设置三个Nacos服务，这也正是Nacos的设计理念，让开发者能够尽快上手，专注业务的开发。

Nacos是CP还是AP？

先来简单复习下CAP的概念吧，如下：

• 一致性（C）：在分布式系统中的所有数据备份，在同一时刻是否同样的值。（等同于所有节点访问同一份最新的数据副本）
• 可用性（A）：在集群中一部分节点故障后，集群整体是否还能响应客户端的读写请求。（对数据更新具备高可用性）
• 分区容错性（P）：以实际效果而言，分区相当于对通信的时限要求。系统如果不能在时限内达成数据一致性，就意味着发生了分区的情况，必须就当前操作在C和A之间做出选择。

一般分布式系统中，肯定是优先保证P，剩下的就是C和A的取舍。

当然不同的注册中心遵循的CAP也是不同的，如下：

• Zookeeper：保证CP，放弃可用性；一旦zookeeper集群中master节点宕了，则会重新选举leader，这个过程可能非常漫长，在这过程中服务不可用。
• Eureka：保证AP，放弃一致性；Eureka集群中的各个节点都是平等的，一旦某个节点宕了，其他节点正常服务（一旦客户端发现注册失败，则将会连接集群中其他节点），虽然保证了可用性，但是每个节点的数据可能不是最新的。
• Nacos：同时支持CP和AP，默认是AP，可以切换；AP模式下以临时实例注册，CP模式下服务永久实例注册。