SpringCloud Alibaba之Nacos组件

文章目录

一、概述
二、父项目搭建
三、Nacos介绍
- 1、是什么
- 2、干什么
- 3、服务注册与发现框架对比
- 4、CP和AP
四、Nacos服务注册
- 1、Nacos服务提供者项目搭建
- 2、Nacos服务消费者项目搭建
- 3、结果分析
五、Nacos配置中心
- 1、Nacos配置中心基础配置
- 2、Nacos配置中心分类配置
- 3、Nacos集群和持久化配置（重要）

该篇博文根据B站尚硅谷课程——尚硅谷SpringCloud整理而出

一、概述

微服务各功能模块对应组件图

通过上图我们可以看到原Spring Cloud Netflix的微服务组件Eureka、Feign、Hystrix、Zuul、Config等都打了把×，这是由于原来的Spring Cloud Netflix已经进入了维护模式，在这样的一个基础上，Alibaba便和Spring联合推出了Spring Cloud Alibaba。

Spring Cloud Alibaba是阿里巴巴集团下的开源组件和云产品在Spring Cloud规范下的实现。2018年10月31日，Spring Cloud Alibaba 正式入驻Spring Cloud 官方孵化器，并发布了第一个预览版本。2019年8月1日在Alibaba 仓库发布第一个毕业版本。

Spring Cloud Alibaba 主要为微服务开发提供一站式的解决方案，使开发者通过 Spring Cloud 编程模型轻松地解决微服务框架的各类技术问题。以下是Spring Cloud Alibaba 生态下主要功能组件，这些组件包括开源组件和阿里云产品组件，云产品是需要付费使用的。

Sentinel：流量控制和服务降级
Nacos：服务注册与发现、分布式配置中心
RocketMQ：消息驱动
Seate：分布式事务
Dubbo：RPC通信
OSS：阿里云对象存储（收费的云服务器）

Spring Cloud Alibaba在2018年10月31号发布了第一个预览版本，0.2.0.RELEASE和0.1.0.RELEASE，其中0.1.0.RELEASE与Spring Boot1.5.x兼容，0.2.0.RELEASE与Spring Boot2.0.x兼容。

二、父项目搭建

创建一个maven项目，并且删除掉该项目的src目录

将该项目作为父工程，添加对应的maven依赖（建议直接拷贝，多的后文会用到）

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.sc2020</groupId><artifactId>com.springcloud</artifactId><packaging>pom</packaging><version>1.0-SNAPSHOT</version><modules></modules><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><maven.compiler.source>1.8</maven.compiler.source><maven.compiler.target>1.8</maven.compiler.target><junit.version>4.12</junit.version><log4j.version>1.2.17</log4j.version><lombok.version>1.16.18</lombok.version><mysql.version>5.1.47</mysql.version><druid.version>1.1.16</druid.version><mybatis.spring.boot.version>1.3.2</mybatis.spring.boot.version></properties><!-- 子模块继承之后，提供作用：锁定版本+子模块不用写groupId和version  --><dependencyManagement><dependencies><!--  springboot 2.2.2    --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-dependencies</artifactId><version>2.2.2.RELEASE</version><type>pom</type><scope>import</scope></dependency><!--  springcloud cloud Hoxton.SR1   --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-dependencies</artifactId><version>Hoxton.SR1</version><type>pom</type><scope>import</scope></dependency><!--  springcloud cloud alibaba 2.1.0.RELEASE    --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-alibaba-dependencies</artifactId><version>2.1.0.RELEASE</version><type>pom</type><scope>import</scope></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>${mysql.version}</version></dependency><dependency><groupId>com.alibaba</groupId><artifactId>druid</artifactId><version>${druid.version}</version></dependency><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>${mybatis.spring.boot.version}</version></dependency><dependency><groupId>log4j</groupId><artifactId>log4j</artifactId><version>${log4j.version}</version></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>${junit.version}</version></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>${lombok.version}</version><optional>true</optional></dependency></dependencies></dependencyManagement><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><fork>true</fork><addResources>true</addResources></configuration></plugin></plugins></build></project>

三、Nacos介绍

官方文档地址

GitHub下载地址

1、是什么

一个易于构建云原生应用的动态服务发现、配置管理和服务管理平台。

Nacos：Dynamic Naming and Configuration Service

Nacos就是注册中心+配置中心的组合。即Eureka + Config + Bus

2、干什么

替代Eureka做服务注册中心

替代Config做服务配置中心

一个组件能够同事完成两项功能

3、服务注册与发现框架对比

服务注册与发现框架	CAP模型	控制台管理	社区活跃度
Eureka	AP	支持	低（2.x版本闭源）
Zookeeper	CP	不持支	中
Consul	CP	支持	高
Nacos	AP	支持	高

4、CP和AP

Nacos能够在CP和AP之间进行模式切换

总所周知，分布式项目是无法同时兼顾CAP三则，只能择其二。

CAP：一致性（Consistency）、可用性（Availability）、分区容错性（Partition tolerance）。

C是在分布式系统中的所有数据备份，在同一时刻是否同样的值。（等同于所有节点访问同一份最新的数据副本）；
A是保证每个请求不管成功或者失败都有响应；
P是系统中任意信息的丢失或失败不会影响系统的继续运作。

何时选择使用何种模式？

一般来说，如果不需要存储服务级别的信息且服务实例是通过Nacos-client注册，并且能够保持心跳上报，那么就可以使用AP模式。当前主流的服务如Spring Cloud 和Dubbo服务，都适用于AP模式，AP模式为了服务的可用性而减弱了一致性，因此AP模式下只支持注册临时实例。

如果需要在服务级别编辑或者存储信息，那么必须是CP，K8S服务和DNS服务则适用于CP模式。

在CP模式下则支持注册持久化实例，此时则是以Raft协议为集群运行模式，该模式下注册实例之前必须先注册服务，如果服务不存在，则会返回错误信息。

CP与AP的切换命令

curl -X PUT '$NACOS_SERVER:8848/nacos/v1/ns/operator/switches?entry=serverMode&value=CP'

nacos服务发现模型：

四、Nacos服务注册

1、Nacos服务提供者项目搭建

服务提供者项目搭建完成最终效果展示

1、在父项目的基础上，右键创建子项目

2、引入对应的maven依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><parent><artifactId>com.springcloud</artifactId><groupId>com.sc2020</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>cloudalibaba-provider-payment9001</artifactId><dependencies><!--  SpringCloud alibaba nacos    --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency><!--  web组件      --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>com.sc2020</groupId><artifactId>cloud-api-commons</artifactId><version>1.0-SNAPSHOT</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies></project>

3、编写yml配置文件

1、配置我们的项目端口

2、配置我们项目的名字

3、配置项目注册到nacos的目标地址

4、配置启动所有的端口

server:port: 9001
spring:application:name: nacos-payment-providercloud:nacos:discovery:server-addr: localhost:8848
management:endpoints:web:exposure:include: "*"

4、编写后端接口，消费者测试需要

@RestController
public class PaymentController {// 9001@Value("${server.port}")private String serverPort;@GetMapping(value = "/payment/nacos/{id}")public String getPayment(@PathVariable("id") Integer id) {// 打印字符串+输入的数字return "nacos registry, serverPort: " + serverPort + "\t id" + id;}
}

5、重复1-4的步骤，再添加一个子项目

server:port: 9002
spring:application:name: nacos-payment-providercloud:nacos:discovery:server-addr: localhost:8848
management:endpoints:web:exposure:include: "*"

6、分别启动两个不同的服务提供者项目

不要忘记在父项目中，添加两个子模块的引用

7、在nacos客户端进行查看

此时说明我们服务提供者项目已经成功注册到了Nacos注册中心了

在这个过程中一定要注意Spring Boot、Spring Cloud Alibaba、Nacos的版本，本人在搭建过程中，就因为版本冲突，解决了很久。建议直接拷贝pom.xml，不要修改版本，否则你总会在意想不到的地方浪费时间

2、Nacos服务消费者项目搭建

有了服务提供者，那么就需要有消费者，来访问对应的端口。

服务者项目可以理解为提供接口及接口下面的方法逻辑

消费者项目可以理解为是一个转发器，接受你的请求，然后转发给对应的接口，继而达到消费服务者的状态

1、新建一个项目

2、添加maven依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><parent><artifactId>com.springcloud</artifactId><groupId>com.sc2020</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>cloudalibaba-consumer-nacos-order83</artifactId><dependencies><!--  SpringCloud alibaba nacos    --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency><!--  web组件      --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>com.sc2020</groupId><artifactId>cloud-api-commons</artifactId><version>1.0-SNAPSHOT</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies></project>

3、编写配置文件

1、配置端口为83

2、将该消费者项目注册到Nacos注册中心里面

3、配置一个字符串参数，后面controller层使用

server:port: 83
spring:application:name: nacos-order-consumercloud:nacos:discovery:server-addr: localhost:8848
service-url:nacos-user-service: http://nacos-payment-provider

4、编写RestTemplate配置类

@Configuration
public class ApplicationContextConfig {@Bean@LoadBalanced //负载均衡算法配置注解public RestTemplate getRestTemplate(){return new RestTemplate();}
}

5、编写后台接口

@RestController
public class OrderNacosController {@Resourceprivate RestTemplate restTemplate;// http://nacos-payment-provider@Value("${service-url.nacos-user-service}")private String serverURL;@GetMapping("/consumer/payment/nacos/{id}")public String paymentInfo(@PathVariable("id") Long id) {// 由consumer（消费者接口）转发到payment（服务者）// 跳转的路径：http://nacos-payment-provider/payment/nacos/+输入的字符串return restTemplate.getForObject(serverURL + "/payment/nacos/" + id, String.class);}
}

6、启动项目

7、接口访问测试

由于Nacos自带负载均衡功能，所以我们这里会在9001和9002端口直接反复横跳（根据默认的负载均衡算法跳转）

由consumer接口转发跳转到了payment接口下

3、结果分析

1、我们在浏览器输入http://localhost:83/consumer/payment/nacos/22时

2、83端口对应消费者项目，所以会跳转到消费者的项目中，根据路径映射关系找到于consumer/payment/nacos/22匹配的controller层接口

3、再通过restTemplate转发到指定的路径，这里指定的路径就是

restTemplate.getForObject(serverURL + "/payment/nacos/" + id, String.class);
// serverURL 在yml配置文件中配置
// id为我们前台传入
// 最终路径
http://nacos-payment-provider/payment/nacos/22

4、由于nacos-payment-provider对应的名字是我们服务提供者项目，也就是9001端口和9002端口对应的项目（yml配置文件中配置过），即它会根据路径映射关系，在端口为9001和9002的项目controller层下寻找于payment/nacos/22路径相匹配的接口，然后对应的结果

5、这里的返回结果根据具体的接口结果而定，此处为指定字符串+端口+前台输入id

"nacos registry, serverPort: " + serverPort + "\t id" + id;

6、由于Nacos整和了Ribbon，所以Nacos默认支持负载均衡

五、Nacos配置中心

1、Nacos配置中心基础配置

1、新建一个端口为3377的项目

2、添加对应的maven依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><parent><artifactId>com.springcloud</artifactId><groupId>com.sc2020</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>cloudalibaba-config-nacos-client3377</artifactId><dependencies><!--   nacos config   配置中心  --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId></dependency><!--  SpringCloud alibaba nacos  注册中心  --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency><!--  web组件      --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>com.sc2020</groupId><artifactId>cloud-api-commons</artifactId><version>1.0-SNAPSHOT</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies></project>

3、编写对应的配置文件

这里需要编写两个配置文件，Nacos同Spring Cloud Config一样，在项目的初始化时，要保证先从配置中心进行配置拉取，拉取配置之后，才能保证项目的正常启动。

Spring Boot中配置文件的加载是存在优先级顺序的，bootstrap配置文件优先级高于application配置文件

bootstrap配置文件：

1、配置该项目端口号为3377

2、配置项目名字

3、配置将该服务注册到Nacos注册中心地址

4、配置该服务Nacos的配置中心地址

5、配置对应配置文件的文件类型（后面nacos客户端新增服务时会使用到）

server:port: 3377
spring:application:name: nacos-config-clientcloud:nacos:discovery:server-addr: localhost:8848config:server-addr: localhost:8848file-extension: yaml

application配置文件：

配置对应的开发环境

spring:profiles:active: dev# 服务名字（bootstrap配置文件）+开发环境（application配置文件）+文件后缀（bootstrap配置文件）
# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# 后文的nacos配置中心新增服务时的，Data Id名字：nacos-config-client-dev.yaml

4、编写controller层接口

@RestController
@RefreshScope
public class ConfigClientController {// 读取nacos配置中心的信息@Value("${config.info}")private String configInfo;@GetMapping("/config/info")public String getConfigInfo(){// 打印nacos配置中心的配置信息return configInfo;}
}

5、在nacos客户端完成对应的配置

Data Id根据我们前面提到的配置文件的配置来

Group目前先使用默认的

config.info，与我们controller层接口获取的参数位置相对应

#服务名字（bootstrap配置文件）+开发环境（application配置文件）+文件后缀（bootstrap配置文件）#${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}#后文的nacos配置中心新增服务时的，Data Id名字：nacos-config-client-dev.yaml

对应配置项讲解：

Data ID：对应的配置项，都在我们的配置文件中完成了定义
配置格式：根据我们前面的id来选择，一定要注意是yaml，不是yml，这里如果后缀不匹配会报错
配置内容：配置config.info：xxxx，用于我们访问对应接口后输出

6、访问接口测试

2、Nacos配置中心分类配置

问题一：实际开发中，通常一个系统会准备

dev开发环境
test测试环境
prod生产环境

如何保证指定环境启动服务能够正确读取到Nacos上相应环境的配置文件呢？

问题二：一个大型分布式微服务系统会有很多微服务子项目，

每个微服务项目又都会有响应的开发环境、测试环境、预发环境、正式环境…

那么针对这么多微服务环境，如何进行管理呢？

就以上问题，nacos引入了下面的分组概念：namespace + Group Id + Data Id

namespace可用于区分部署环境
Group Id和Data Id用于在逻辑上区分两个目标对象

对应的包含关系，默认情况下：

namespace = PUBLIC
Group Id = DEFAULT_GROUP
Cluster（Data Id） = DEFAULT

创建不同的Data Id

1、修改我们的配置文件，切换为test环境（原来是dev环境）

2、在nacos客户端配置不同的Data Id

取名方式参考前文提及的方式：

spring.application.name−{spring.application.name}-spring.application.name−{spring.profile.active}.${spring.cloud.nacos.config.file-extension}

对应我们这里就是：nacos-config-client-test.yaml

3、对应端口访问

创建不同的Group

1、新建两个Data Id相同，但是Group不同的配置，这里Group分别设置为TEST_GROUP、DEV_GROUP（如果不设置是默认使用DEFAULT_GROUP）

2、修改配置文件，并完成访问测试

访问不同的分组，设置不同的group即可。即设置spring.cloud.nacos.config.group

创建不同的namespace

1、在nacos的客户端命名空间下新建dev和test两个命名空间

此时我们的配置列表就会多出新添加的namespace

2、在namespace对应的dev和test列表下创建服务（默认创建的在public列表下）

此处截图仅展示一个，另一个修改group和配置内容

3、修改配置文件，并完成访问测试

我们将active切换为了info

使用不同的namespace只需要使用配置spring.cloud.nacos.config.namespace的属性即可，该属性为新建namespace时的命名空间id

3、Nacos集群和持久化配置（重要）

官方文档地址

默认Nacos使用嵌入式数据库derby实现数据的存储。所以，如果启动多个默认配置下的Nacos节点，数据存储是存在一致性问题的。为了解决这个问题，Nacos采用了集中式存储的方式来支持集群化部署，目前只支持MySQL的存储。

Nacos支持三种部署模式：

单机模式：用于测试和单机试用
集群模式：用于生产环境，确保高可用
多集群模式：用于多数据中心场景

单机模式支持MySQL

在0.7版本之前，单机模式时nacos使用嵌入式数据库实现数据的存储，不方便观察数据存储的基本情况。0.7版本增加了支持MySQL数据源能力，具体的操作步骤如下：

安装数据库，版本要求:5.6.5+
初始化mysql数据库，数据库初始化文件为nacos-mysql.sql
修改conf/application.properties文件，增加支持mysql数据源配置(目前只支持mysql)，添加mysql数据源的url、用户名和密码。

由于本人在安装Nacos客户端时，由于启动Nacos客户端报错，意外的使用了单机的方式启动Nacos（后来意识到之前的错误是由于使用集群启动Nacos）。搭建MySQL下的Nacos单机模式只需要在本地新建表结构、修改对应配置即可。具体操作步骤请参考下面错误的解决步骤：

nacos启动报错 db.num is null

这就是我们之前新建的服务，数据都持久化到了数据库，默认方式这些数据库是持久化到dery数据库。

本人仅在win上搭建了单机模式，集群未搭建

最终企业在生产时若为了追求高可用需要搭建为Nacos集群，甚至是Nginx集群，MySQL集群。

详细的搭建步骤请参考：

https://www.bilibili.com/video/BV18E411x7eT?p=109

https://www.bilibili.com/video/BV18E411x7eT?p=110