SpringCloud Alibaba之Nacos服务注册和配置中心

（学习笔记）nacos-server版本：2.2.3

总体介绍：

1、Nacos介绍

官网：Nacos官网| Nacos 配置中心 | Nacos 下载| Nacos 官方社区 | Nacos 官网

Nacos /nɑ:kəʊs/ 是 Dynamic Naming and Configuration Service的首字母简称，一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。

Nacos = Eureka+Config +Bus

Nacos = Spring Cloud Consul

能干什么？

替代Eureka/Consul做服务注册中心

替代(Config+Bus)/Consul 做服务配置中心和满足动态刷新广播通知

各个注册中心比较

据说 Nacos 在阿里巴巴内部有超过 10 万的实例运行，已经过了类似双十一等各种大型流量的考验，Nacos默认是AP模式，但也可以调整切换为CP，我们一般用默认AP即可。

2、下载安装运行

github：https://github.com/alibaba/nacos/releases

官网下载：Nacos Server 下载 | Nacos 官网

运行：解压安装包，直接运行bin目录下的startup.cmd

startup.cmd -m standalone

windows运行出现异常：

Please set the JAVA_HOME variable in your environment, We need java(x64)! jdk8 or later is better!

解决运行异常：配置JAVA_HOME环境变量

运行结果：

访问地址：http://localhost:8848/nacos

默认账号密码都是nacos

3、Nacos Discovery服务注册中心

官网：Nacos 融合 Spring Cloud，成为注册配置中心 | Nacos 官网

概述：

开发参考文档

中文文档：Spring Cloud Alibaba 参考文档

参考文档：SpringCloudAlibaba | Spring Cloud Alibaba

3.1、创建服务提供者cloudalibaba-provider-payment9001

（1）pom

<?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>
    <parent>
        <groupId>com.atguigu.cloud</groupId>
        <artifactId>springcloud2024</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>cloudalibaba-provider-payment9001</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <dependencies>
        <!--nacos-discovery-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!-- 引入自己定义的api通用包 -->
        <dependency>
            <groupId>com.atguigu.cloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--SpringBoot通用依赖模块-->
        <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>
        <!--hutool-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.28</version>
            <scope>provided</scope>
        </dependency>
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

（2）application.yml

server:
  port: 9001

spring:
  application:
    name: nacos-payment-provider
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #配置Nacos地址

（3）主启动类

@SpringBootApplication
@EnableDiscoveryClient
public class Main9001 {
    public static void main(String[] args) {
        SpringApplication.run(Main9001.class, args);
    }
}

（4）业务类

package com.atguigu.cloud.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class PayAlibabaController {
    @Value("${server.port}")
    private String serverPort;

    @GetMapping(value = "/pay/nacos/{id}")
    public String getPayInfo(@PathVariable("id") Integer id) {
        return "nacos registry, serverPort: " + serverPort + "\t id" + id;
    }
}

（5）启动

3.2、创建服务消费者cloudalibaba-consumer-nacos-order83

（1）pom

<?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>
    <parent>
        <groupId>com.atguigu.cloud</groupId>
        <artifactId>springcloud2024</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>cloudalibaba-consumer-nacos-order83</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!--nacos-discovery-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!--loadbalancer-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>
        <!--web + actuator-->
        <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>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

（2）application.yml

server:
  port: 83

spring:
  application:
    name: nacos-order-consumer
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
#消费者将要去访问的微服务名称(nacos微服务提供者叫什么你写什么)
service-url:
  nacos-user-service: http://nacos-payment-provider

（3）主启动

@EnableDiscoveryClient
@SpringBootApplication
public class Order83Application {
    public static void main(String[] args) {
        SpringApplication.run(Order83Application.class,args);
    }
}

（4）业务类

Config

@Configuration
public class RestTemplateConfig {
    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

Controller

@RestController
public class OrderNacosController {
    @Resource
    private RestTemplate restTemplate;

    @Value("${service-url.nacos-user-service}")
    private String serverURL;

    @GetMapping("/consumer/pay/nacos/{id}")
    public String paymentInfo(@PathVariable("id") Integer id) {
        String result = restTemplate.getForObject(serverURL + "/pay/nacos/" + id, String.class);
        return result + "\t" + " 我是OrderNacosController83调用者。。。。。。";
    }
}

3.3、负载均衡

再建一个服务提供者cloudalibaba-provider-payment9002

或者拷贝虚拟端口映射

-DServer.port=9002

4、Nacos Config服务配置中心

官网：Nacos 融合 Spring Cloud，成为注册配置中心 | Nacos 官网

中文参考文档：Spring Cloud Alibaba 参考文档

Nacos作为配置中心配置步骤

4.1、创建cloudalibaba-config-nacos-client3377配置中心

4.2、pom

<?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>
    <parent>
        <groupId>com.atguigu.cloud</groupId>
        <artifactId>springcloud2024</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>cloudalibaba-config-nacos-client3377</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!--bootstrap-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>
        <!--nacos-config-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <!--nacos-discovery-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!--web + actuator-->
        <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>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

4.3、yml配置

Nacos同Consul一样，在项目初始化时，要保证先从配置中心进行配置拉取，

拉取配置之后，才能保证项目的正常启动，为了满足动态刷新和全局广播通知

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

bootstrap.yml

# nacos配置
spring:
  application:
    name: nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #Nacos服务注册中心地址
      config:
        server-addr: localhost:8848 #Nacos作为配置中心地址
        file-extension: yaml #指定yaml格式的配置

# nacos端配置文件DataId的命名规则是：
# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# 本案例的DataID是:nacos-config-client-dev.yaml

application.yml

server:
  port: 3377

spring:
  profiles:
    active: dev # 表示开发环境
      #active: prod # 表示生产环境
    #active: test # 表示测试环境

4.4、主启动

@EnableDiscoveryClient
@SpringBootApplication
public class NacosConfigClient3377 {
    public static void main(String[] args) {
        SpringApplication.run(NacosConfigClient3377.class, args);
    }
}

4.5、业务类

@RestController
@RefreshScope //在控制器类加入@RefreshScope注解使当前类下的配置支持Nacos的动态刷新功能。
public class NacosConfigClientController {
    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/config/info")
    public String getConfigInfo() {
        return configInfo;
    }
}

4.6、在Nacos中添加配置信息(重点)

官网：Nacos 融合 Spring Cloud，成为注册配置中心 | Nacos 官网

（1）设置 DataId 理论：Nacos中的dataid的组成格式及与SpringBoot配置文件中的匹配规则

公式：

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

（2）配置DataId实操

1、prefix 默认为 spring.application.name 的值

2、spring.profile.active 即为当前环境对应的 profile，可以通过配置项 spring.profile.active 来配置

3、file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置

nacos创建配置：

测试：

自带动态刷新测试：

历史配置：

Nacos会记录配置文件的历史版本默认保留30天，此外还有一键回滚功能，回滚操作将会触发配置更新

5、Nacos数据模型之Namespace-Group-DataId

问题：多环境多项目管理

问题1：

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

dev开发环境

test测试环境

prod生产环境。

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

问题2：

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

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

那怎么对这些微服务配置进行分组和命名空间管理呢？

5.1、Namespace+Group+DataId三者关系？

5.2、为什么这么设计？

1 是什么	类似Java里面的package名和类名，最外层的Namespace是可以用于区分部署环境的，Group和DataID逻辑上区分两个目标对象
2 默认值	默认情况：Namespace=public，Group=DEFAULT_GROUP Nacos默认的命名空间是public，Namespace主要用来实现隔离。比方说我们现在有三个环境：开发、测试、生产环境，我们就可以创建三个Namespace，不同的Namespace之间是隔离的。Group默认是DEFAULT_GROUP，Group可以把不同的微服务划分到同一个分组里面去
Service就是微服务	一个Service可以包含一个或者多个Cluster（集群），Nacos默认Cluster是DEFAULT，Cluster是对指定微服务的一个虚拟划分。见下一节：服务领域模型-补充说明

5.3、Nacos的图形化管理界面

（1）命名空间Namespace：

（2）配置管理：

5.4、三种方案加载配置之DataID方案

指定spring.profile.active和配置文件的DataID来使不同环境下读取不同的配置

默认空间public+默认分组DEFAULT_GROUP+新建DataID

（1）新建test配置DataID ：nacos-config-client-test.yaml

（2）修改yml

bootstrap.yml

# nacos配置 第一种:默认空间+默认分组+新建DataID
spring:
  application:
    name: nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #Nacos服务注册中心地址
      config:
        server-addr: localhost:8848 #Nacos作为配置中心地址
        file-extension: yaml #指定yaml格式的配置

# nacos端配置文件DataId的命名规则是：
# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# 本案例的DataID是:nacos-config-client-dev.yaml

application.yml

server:
  port: 3377

spring:
  profiles:
    #active: dev # 表示开发环境
    active: test # 表示测试环境
    #active: prod # 表示生产环境

（3）测试

5.5、三种方案加载配置之Group方案

通过Group实现环境区分

默认空间public+新建PROD_GROUP+新建DataID

（1）新建prod配置DataID ，新建Group

（2）bootstrap.yml

# nacos配置 第2种:默认空间+新建分组+新建DataID
spring:
  application:
    name: nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #Nacos服务注册中心地址
      config:
        server-addr: localhost:8848 #Nacos作为配置中心地址
        file-extension: yaml #指定yaml格式的配置
        group: PROD_GROUP

# nacos端配置文件DataId的命名规则是：
# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# 本案例的DataID是:nacos-config-client-dev.yaml

（3）application.yml

server:
  port: 3377

spring:
  profiles:
    #active: dev # 表示开发环境
    #active: test # 表示测试环境
    active: prod # 表示生产环境

（4）测试

5.6、三种方案加载配置之Namespace方案

通过Namespace实现命名空间环境区分

Prod_Namespace +PROD_GROUP+DataID(nacos-config-client-prod.yaml)

（1）新建Namespace：Prod_Namespace

（2）新建Namespace但命名空间ID不填(系统自动生成) ：Prod2_Namespace

（3）选定Prod_Namespace后新建配置

①、选定namespace

②、创建配置：

（4）bootstrap.yml

# nacos配置 第3种:新建空间+新建分组+新建DataID
spring:
  application:
    name: nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #Nacos服务注册中心地址
      config:
        server-addr: localhost:8848 #Nacos作为配置中心地址
        file-extension: yaml #指定yaml格式的配置
        group: PROD_GROUP
        namespace: Prod_Namespace

# nacos端配置文件DataId的命名规则是：
# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# 本案例的DataID是:nacos-config-client-dev.yaml

（5）application.yml

server:
  port: 3377

spring:
  profiles:
    #active: dev # 表示开发环境
    #active: test # 表示测试环境
    active: prod # 表示生产环境

（6）测试

6、Nacos集群和持久化配置

官网：集群模式部署 | Nacos 官网

部署手册概览 | Nacos 官网

6.1、概念（详细内容看官网）

Nacos默认自带的嵌入式数据库derby

6.2 Windows版nacos集群和持久化配置（详细配置请看 6.3Linux版本）

端口	与主端口的偏移量	描述
8848	0	主端口，客户端、控制台及OpenAPI所使用的HTTP端口
9848	1000	客户端gRPC请求服务端端口，用于客户端向服务端发起连接和请求
9849	1001	服务端gRPC请求服务端端口，用于服务间同步等
7848	-1000	Jraft请求服务端端口，用于处理服务端间的Raft相关请求

6.2.1、nacos配置

（1）application.properties

（2）cluster.conf

6.2.1、nginx配置

（1）配置集群

    #gzip  on;
	upstream cluster {
        server 127.0.0.1:3333;
        server 127.0.0.1:4444;
        server 127.0.0.1:5555;
    }
	
    server {
        listen       1111;
        server_name  localhost;

        #charset koi8-r;

        #access_log  logs/host.access.log  main;

        location / {
            #root   html;
            #index  index.html index.htm;
			proxy_pass http://cluster;
        }

（2）配置gRPC请求

# 和http同级

stream {
   upstream nacos-grpc {
       server 127.0.0.1:4333;
server 127.0.0.1:5444;
server 127.0.0.1:6555;
   }
   server {
       listen 2111;
proxy_pass nacos-grpc;
   }
}

6.2.3、测试

（1）持久化结果

（2）集群模式下nacos服务注册

nacos 2.x版本以上需要再nginx配置配置gRPC

server:
  port: 9001

spring:
  application:
    name: nacos-payment-provider
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.18.30:1111 #配置Nacos地址

6.3、Linux版nacos+mysql生产环境配置

预计需要，1个Nginx+3nacos注册中心+1个mysql

端口	与主端口的偏移量	描述
8848	0	主端口，客户端、控制台及OpenAPI所使用的HTTP端口
9848	1000	客户端gRPC请求服务端端口，用于客户端向服务端发起连接和请求
9849	1001	服务端gRPC请求服务端端口，用于服务间同步等
7848	-1000	Jraft请求服务端端口，用于处理服务端间的Raft相关请求

6.3.1、linux安装nacos

tar -zxvf nacos-server-2.2.3.tar.gz

6.3.2、sql脚本

创建数据库，执行sql脚本

6.3.3、nacos的application.properties配置（配置mysql）

参数名	含义	可选值	默认值
spring.sql.init.platform	Nacos Server 使用的数据库类型	mysql/空，指定为空时会根据`nacos.standalone`判断使用derby数据库还是mysql数据库；在使用数据源插件时，可以指定为插件对应的数据库值，比如oracle或postgresql	null
spring.datasource.platform	Nacos Server 使用的数据库类型，即将被废弃，请使用`spring.sql.init.platform`代替	mysql/空	null
db.num	数据库数目	正整数	0
db.url.0	第一个数据库的URL	字符串	空
db.url.1	第二个数据库的URL，当db.num=2时生效	字符串	空
db.user	数据库连接的用户名	字符串	空
db.password	数据库连接的密码	字符串	空
db.pool.config.xxx	数据库连接池参数，使用的是hikari连接池，参数与hikari连接池相同，如`db.pool.config.connectionTimeout`或`db.pool.config.maximumPoolSize`	字符串	同hikariCp对应默认配置

#*************** Config Module Related Configurations ***************#
### If use MySQL as datasource:
### Deprecated configuration property, it is recommended to use `spring.sql.init.platform` replaced.
# spring.datasource.platform=mysql
spring.sql.init.platform=mysql

### Count of DB:
db.num=1

### Connect URL of DB:
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
db.user.0=root
db.password.0=123456

6.3.4、Linux服务器上nacos的集群配置cluster.conf

（1）复制配置

cp cluster.conf.example cluster.conf

（2）编辑配置

vim cluster.conf

这个IP不能写127.0.0.1，必须是Linux命令hostname -i能够识别的IP

hostname -i

6.3.5、编辑nacos的启动脚本startup.sh，使它能够接受不同的启动端口

（1）备份

cp startup.sh startup.sh.backup

（2）编辑

vim startup.sh

修改配置

nacos启动

自己的配置及启动效果：

nacos集群启动命令查询

ps -ef|grep nacos|grep -v grep|wc -l

6.3.6、Nginx的配置，由它作为负载均衡器

（1）备份并编辑

cp nginx.conf nginx.conf.backup

vim nginx.conf

    upstream cluster {
        server 127.0.0.1:3333;
        server 127.0.0.1:4444;
        server 127.0.0.1:5555;
    }

    server {
        listen       1111;
        server_name  localhost;

        #charset koi8-r;

        #access_log  logs/host.access.log  main;

        location / {
           # root   html;
           # index  index.html index.htm;
           proxy_pass http://cluster;
        }

        #error_page  404              /404.html;

（2）配置gRPC请求

# 和http同级

stream {
   upstream nacos-grpc {
       server 127.0.0.1:4333;
server 127.0.0.1:5444;
server 127.0.0.1:6555;
   }
   server {
       listen 2111;
proxy_pass nacos-grpc;
   }
}

启动nginx

cd /usr/local/nginx/sbin/

./nginx -c /usr/local/nginx/conf/nginx.conf