Nacos

本专栏学习内容来自尚硅谷周阳老师的视频

有兴趣的小伙伴可以点击视频地址观看

简介

Nacos是阿里巴巴推出的服务注册和配置中心。等价于Eureka+Config+Bus，可以替代Eureka做服务注册中心，替代Config做服务配置中心。官方文档

安装

关于Nacos的安装非常简单，git上拉取压缩包解压即可，下载链接

这里有一个需要注意的地方，我的nacos依赖版本为2.1.0，下载了2.2.x的压缩包，启动服务无法正常注册，2.1.x可以正常注册，估计是版本问题

启动

在bin目录下通过命令行允许单机版即可

startup.cmd -m standalone

运行完成之后，访问localhost:8848/nacos即可

服务注册中心

服务提供者

创建一个名为cloudalibaba-provider-payment9001的服务

导入相关依赖

通过官方文档可以得知，这里父工程需要引入依赖

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring.cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring.cloud.alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

相应的子工程在引入Nacos依赖

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

编写配置文件

server:
  port: 9001

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

management:
  endpoints:
    web:
      exposure:
        include: '*' # 暴露所有端点

启动类

@SpringBootApplication
@EnableDiscoveryClient //让注册中心能够发现，扫描到该服务
public class PaymentMain9001 {
    public static void main(String[] args) {
        SpringApplication.run(PaymentMain9001.class,args);
    }
}

业务类

@RestController
public class PaymentController {
    @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;
    }
}

测试

启动服务后，观察Nacos客户端，发现服务正常注册

如果无法注册，看一下Naco客户端版本和依赖版本是否一致

为了演示负载均衡，我们复制一个cloudalibaba-provider-payment9002出来，此处代码就省略了。

启动9001，9002，可以看到实例数增加了

服务消费者

创建一个新的服务cloudalibaba-consumer-nacos-order83

引入依赖

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

编写配置文件

service-url.nacos-user-service是为了后续RestTemplate更方便的调用支付服务

server:
  port: 83

spring:
  application:
    name: nacos-order-consumer
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848

management:
  endpoints:
    web:
      exposure:
        include: '*'
        
#消费者将要去访问的微服务名称(注册成功进nacos的微服务提供者)
service-url:
  nacos-user-service: http://nacos-payment-provider

启动类

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

业务类

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

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

    @GetMapping("/consumer/payment/nacos/{id}")
    public String paymentInfo(@PathVariable("id") Long id) {
        return restTemplate.getForObject(serverURL + "/payment/nacos/" + id, String.class);
    }
}

RestTemplate配置

Nacos集成了Ribbon，所以具有负载均衡的功能，可以从依赖关系图看出来

@Configuration
public class ApplicationContextBeanConfig {
    @Bean
    @LoadBalanced //让RestTemplate具备负载均衡的能力
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}

测试

通过测试可以发现能调通9001、9002服务，并且具有负载均衡功能

服务注册中心的对比

市面上还有很多服务注册中心，例如Eureka、ZooKeeper等，而Nacos有什么优点呢？

CAP是我们的关注点，C是所有节点在同一时间看到的数据是一致的；而A的定义是所有的请求都会收到响应。

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

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

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

默认情况下Nacos是AP，也可以通过命令切换成CP模式

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

服务配置中心

Nacos也可以用来做服务配置中心，Config有的功能他也有，Config没有的功能他还有，印证了一句经典台词东厂管不了的，我西厂管；东厂管得了的，我西厂更要管！

基本配置

项目代码

添加依赖

以后有关于Nacos的依赖，我们一般都引入两个，一个是服务注册中心，一个是服务配置中心

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

编写配置文件

这里我们需要有两个配置文件bootstrap.yml以及application.yml

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

拉取配置之后，才能保证项目的正常启动。

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

# bootstrap.yml
server:
  port: 3377

spring:
  application:
    name: nacos-order-consumer
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 # nacos作为注册中心地址
      config:
        server-addr: localhost:8848 # nacos作为配置中心地址
        file-extension: yml # 指定yml格式的配置

# application.yml
spring:
  profiles:
    active: test

业务类

注意添加@RefreshScope注解，可以实现动态刷新

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

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

Nacos配置

在学习Config时，我们将配置文件存放在git上，而Nacos可以直接存储在服务端。

命名规则

在官方文档中，也可以查看他的命名规则

整理一下，命名规则如下

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

可以根据命名规则创建两个配置文件

通过对spring.profiles.active属性值的修改，可以读取到不同配置文件的内容。

动态刷新

通过修改Nacos上的配置文件，可实现动态刷新功能

分类配置

问题

问题1：实际开发中，通常一个系统会准备dev开发环境、test测试环境、prod生产环境。如何保证指定环境启动时服务能正确读取到Nacos上相应环境的配置文件呢？

问题2：一个大型分布式微服务系统会有很多微服务子项目，每个微服务项目又都会有相应的开发环境、测试环境、预发环境、正式环境…那怎么对这些微服务配置进行管理呢？

解决方案

Nacos为此设计了一套解决方案，通过Namespace+Group+DataID可以很好的解决

可以理解为Java的包，一层包着一层

DataID方案

此方案就是基础配置中演示的，spring.profiles.active配置什么读取的就是什么，不在赘述。

Group方案

新建两个配置文件，如下图所示

在DataID相同的情况下，可以通过Group来区分两个配置文件

修改bootstrap.yml

添加如下配置

spring:
  application:
    name: nacos-order-consumer
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 
      config:
        server-addr: localhost:8848 
        file-extension: yml 
        group: TEST_GROUP # 读取指定的组

Namespace方案

在Nacos服务端，新增两个命名空间

在该命名空间下新增一个配置文件

修改bootstrap.yml

spring:
  application:
    name: nacos-order-consumer
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 
      config:
        server-addr: localhost:8848
        file-extension: yml
        namespace: 2e44af2f-e009-4c21-a407-d21a149f22e6 # 读取指定的命名空间

Nacos集群与持久化！！！

前面只是学习如何使用Nacos，真正需要掌握的在于集群与持久化，官方文档里明确表示一个Nacos集群至少有3个服务存在才行，这也是工作中常用的。

官方文档的示意图有些难以理解，我们来看下面这张图，现在我们要做的事当一个请求访问Nacos配置中心的配置文件时，通过Nginx转发他的请求，去集群中选一个服务进行处理，并且我们需要持久化的操作，Nacos支持MySQL。

持久化

• 1.安装数据库，版本要求：5.6.5+
• 2.初始化mysql数据库，数据库初始化文件：mysql-schema.sql
• 3.修改conf/application.properties文件，增加支持mysql数据源配置（目前只支持mysql），添加mysql数据源的url、用户名和密码。

spring.datasource.platform=mysql

db.num=1
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_devtest?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=xxx
db.password=xxx

通过修改以上配置，可以将Nacos的数据存储在MySQL中。

Linux版本下的集群

现在是动手实操环节，我们需要实现如下图所示的效果

Linux安装Nacos

可以参考该博主的文章。Linux安装Nacos

配置持久化

找到/nacos/conf/nacos-mysql.sql文件，这个文件的作用是创建数据表，执行结果如下

接下来需要修改application.properties文件

spring.datasource.platform=mysql

db.num=1
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=root
db.password=123456

集群搭建

我们将要梳理出3台nacos集群的不同服务端口号3333,4444,5555

复制cluster.conf文件

编辑cluster.conf文件，表示这几个服务构成一个集群

启动脚本

因为在同一台机器上，我们不能每次启动都是同一个端口，所以需要修改start.sh文件，我们希望可以通过./start.sh -port 3333来指定Nacos启动的端口。标红地方需要添加。

通过命令行启动Nacos

./startup.sh -port 3333
./startup.sh -port 4444
./startup.sh -port 5555

Nginx负载均衡

最后我们希望外部访问1111端口，由Nginx来帮忙转发到指定的服务去

修改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;
        location / {
         proxy_pass http://cluster;
        }
}

最后重启一下Nginx就可以使用ip:1111/nacos访问啦