SpringCloud Nacos的配置与使用_springcloud nacos配置

Spring Cloud Nacos的配置与使用

在之前的文章中我们介绍过 注册中心Eureka的使用，而在这篇文章中将介绍另一个注册中心： Nacos

1. 简单介绍

Nacos(Dynamic Naming and Configuration Service)是阿里Nacos开源的一个项目，由阿里Nacos内部三个产品合并统一开源，Nacos是Spring Cloud Alibaba的组件，遵循着Spring Cloud 中定义的服务注册、服务发现规范，因此使用Nacos和使用Eureka对于微服务来说并没有太大区别，但Nacos除了提供服务发现和服务注册外，还提供了配置中心和流量管理等功能！！

2. 环境搭建

在使用之前需要对Nacos进行安装，通过下面的链接可下载安装包，这里我们选择Linux版本进行安装：

Release 2.2.3 (May 25th, 2023) · alibaba/nacos · GitHub

​ 注：我们这里使用的是2.2.3版本，其它版本可以前往官网安装

安装包下载好后进行解压，解压后目录如下：

这里我们选择单机模式启动，进入nacos/bin目录下，输入命令：

sh startup.sh -m standalone

上述命令是CentOS系统的，如果是Ubuntu系统则输入：bash startup.sh -m standalone

出现上述提示则启动成功，可以打开浏览器访问Nacos链接：hostIp:port/nacos(默认端口号为8848，需要开放端口号)

3. 服务注册/服务发现

与Eureka不同，Nacos不需要自己搭建服务，组件已经准备好了，只需启动即可，但相关依赖需要引入：

这里的项目环境我们使用在之前文章中搭建好的框架：代码链接

操作步骤：

1. 在父工程的pom文件中的dependencyManagement中引入Spring Cloud Alibaba的依赖：

   <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>
   1
   2
   3
   4
   5
   6
   7

   注：引入的Spring Cloud Alibaba版本与Spring Cloud一样，需要与Spring Boot版本对应，参考如下：官网版本发布说明

2. 在order-service 和 product-service 中引入 nacos依赖:

   <dependency>
       <groupId>com.alibaba.cloud</groupId>
       <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
   </dependency>
   <dependency>
   1
   2
   3
   4
   5

3. 在order-service 和 product-service 中引入 LoadBalance依赖:

   <dependency>
     	<groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-loadbalancer</artifactId>
   </dependency>
   1
   2
   3
   4

4. 在order-service 和 product-service 配置文件中配置Nacos地址，进行服务注册：

   spring:
     application:
       name: product-service #项目名,order-service配置文件中则为order-service
     cloud:
       nacos:
         config:
           server-addr: 主机地址:8848
   1
   2
   3
   4
   5
   6
   7

配置完上述内容后即可进行远程调用：

1. 修改order-service中的远程调用IP为服务项目名:

   package com.order.service.Impl;
   
   import com.order.mapper.OrderMapper;
   import com.order.model.OrderInfo;
   import com.order.model.ProductInfo;
   import com.order.service.OrderService;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.stereotype.Service;
   import org.springframework.web.client.RestTemplate;
   
   @Service
   public class OrderServiceImpl implements OrderService {
   
       @Autowired
       private OrderMapper orderMapper;
   
       @Autowired
       private RestTemplate restTemplate;
       @Override
       public OrderInfo selectOrderById(Integer orderId) {
           OrderInfo orderInfo = orderMapper.selectOrderById(orderId);
           String url = "http://product-service/product/" + orderInfo.getProductId();
           ProductInfo productInfo = restTemplate.getForObject(url, ProductInfo.class);
           orderInfo.setProductInfo(productInfo);
           return orderInfo;
       }
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27

2. 为restTemplate添加负载均衡注解 @LoadBalanced：

   package com.order.config;
   
   import org.springframework.cloud.client.loadbalancer.LoadBalanced;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   import org.springframework.web.client.RestTemplate;
   
   @Configuration
   public class BeanConfig {
   
       @Bean
       @LoadBalanced
       public RestTemplate restTemplate() {
           return new RestTemplate();
       }
   
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17

启动服务，观察Nacos的服务管理界面，可以发现order-service 和 product-service 都注册在Nacos上了：

这个时候我们再启动多个product-service实例:

可以看到这两个实例也都注册到了Nacos上了，访问接口能成功获取数据：http://127.0.0.1:8080/order/2

4. Nacos 负载均衡

对于Nacos来说，它提供了多种负载均衡策略来对服务进行流量控制，包括权重、同集群优先访问等；

4.1 服务下线

当某一个节点上接口的性能较差时，我们可以通过Nacos对节点进行下线：

​ 点击下线后，对应节点就会停止服务，不需要我们去停止运行中的程序来进行下线！！此时能发现该节点没有请求进来了，点击上线后该节点就会继续接收请求.

4.2 权重配置

除了下线之外，我们也可以为这个节点配置流量的权重(默认为1)，权重越低该节点被调用的比例也越低：

注：由于Spring Cloud LoadBalance组件自身有负载均衡配置方式，所以不支持Nacos的权重属性配置，我们需要开启Nacos的负载均衡策略，让权重配置生效（修改@LoadBalance所在服务的配置文件）：

spring:
  cloud:
    loadbalancer:
      nacos:
        enabled: true
1
2
3
4
5

4.3 同集群优先访问

对于微服务架构来说，一个服务通常有多个实例共同提供服务，这些实例可以部署在不同的机器上，而这些机器又可以分布在不同的机房，如product-service：

通常情况下，因为同一个机房的机器属于一个局域网，在局域网中的机器互相访问速度更快一些。对此，微服务访问时，应该尽量访问同一个机房的实例；当本机房内实例不可用时，在访问其它机房的实例

就上述例子，当我们的order-service在上海机房时，且product-service在北京和上海机房都有实例，那我们更希望可以优先访问上海机房中的实例。如果上海机房中的实例刚下线了或不可用了，再访问北京机房的实例：

在Nacos中，我们可以进行下述配置实现同集群优先访问：

1. 为product-service配置集群名称：

   spring:
     application:
       name: product-service
     cloud:
       nacos:
         discovery:
           server-addr: 主机号:8848
           cluster-name: SH
   1
   2
   3
   4
   5
   6
   7
   8

2. 重启服务，观察Nacos控制台，可以看到SH集群下多了一个实例:

   

3. 为另外两个product-service实例设置集群BJ：

   

   添加下述配置：

   -Dspring.cloud.nacos.discovery.cluster-name=BJ

   

   后观察Nacos服务台，此时这两个实例都在BJ集群下了：

   

4. 为order-service配置集群名称: SH

   spring:
     application:
       name: order-service
     cloud:
       nacos:
         discovery:
           server-addr: 主机号:8848
           cluster-name: SH
   1
   2
   3
   4
   5
   6
   7
   8

   

完成上述配置后，重新启动服务，并进行远程调用：

可以发现此时所有请求都到了9090实例，实现了同集群优先访问！

若这个时候将9090实例下线，则其它在BJ集群的product-service就能接收到请求！！

5. Nacos 健康检查

5.1 两种健康检查机制

Nacos作为注册中心，需要感知服务的健康状态，才能为服务调用方提供良好的服务.

Nacos中提供了两种健康检查机制：

客户端主动上报机制：

• 客户端通过心跳上报方式告知服务端(nacos注册中心)健康状态，默认心跳间隔5秒
• nacos会在超过15秒为收到心跳后将实例设置为不健康，超过30秒则将实例删除

服务端反向探测机制：

• nacos主动探知客户端健康状态，默认间隔为20秒
• 健康检查失败后实例会被标记为不健康，不会被立即删除

Nacos中的健康检查机制不能主动设置，并且与Nacos的服务实例类型强相关.

5.2 服务实例类型

Nacos的服务实例(注册的节点)分为临时实例和非临时实例：

• 临时实例：如果实例宕机超过一定时间，会从服务列表剔除，为默认类型
• 非临时实例：如果实例宕机，不会从服务列表剔除，也叫永久实例

Nacos对临时实例，采取的是客户端主动上报机制；对非临时实例，采取服务端反向探测机制：

在这里我们可以将order-service为永久实例：

spring:
  cloud:
    nacos:
      discovery:
        ephemeral: false # 设置为非临时实例
1
2
3
4
5

重启服务，此时可能会有报错：

原因：Nacos会记录每个服务实例的IP和端口号，当发现IP和端口都没有发生变化时，Nacos不允许一个服务实例类型发生变化，如从临时实例转变为非临时实例，或者从非临时实例转变为临时实例

解决方法：先停掉nacos，然后删除nacos目录下 /data/protocol/raft 的信息，里面会报错应用实例的原数据信息

完成之后再重启order-service，可以发现order-service已经成功修改为非临时实例了：

6.Nacos 环境隔离

企业开发中，一个服务会分为开发环境、测试环境和生产环境：

1. 开发环境：开发人员用于开发的服务器，是最基础的环境，一般日志级别设置较低，可能会开启一些调试信息
2. 测试环境：测试人员用来进行测试的服务器，是开发环境到生产环境的过渡环境
3. 生产环境：正式提供对外服务的环境，通常关掉调试信息

通常情况下，这几个环境是不能互相通信的。Nacos提供了namespace(命名空间)来实现环境的隔离，不同的namespace的服务不可见.

具体使用方式如下：

6.1 创建namespace

默认情况下，所有服务都在同一个namespafce下，即public下：

选择左侧命名空间可对namespace进行操作：

6.2 配置namespace

创建完namespace后，对服务进行配置：

修改 order-service 的配置文件，添加命名空间ID：

spring:
  cloud:
    nacos:
      discovery:
        namespace: c567e423-b52b-4797-a33b-734ee78882f8 #命名空间ID
1
2
3
4
5

此时重启服务，可以看到order-service添加到了dev环境下：

如果此时进行远程调用，将无法获取到结果：

这是因为product-service在public环境下，和order-service实例在不同的环境下，所有无法被调用！

此时如果我们将product-service也添加到与order-service同一环境下，则可成功获取服务：

7. Nacos 配置中心

除了注册中心和负载均衡之外，Nacos还是一个配置中心，具备配置管理的功能。

微服务架构中，一个服务可能有很多个实例，当我们的配置文件需要修改时，则需要挨个进行部署，这样很容易导致问题发生；同时在多人开发时，配置文件可能需要经常修改，使用同一个配置文件容易冲突

配置中心就是对这些配置项进行统一管理，通过配置中心，可以集中查看、修改和删除配置，无需再逐个修改配置文件，提高效率的同时，也降低了出错的风险:

在这里我们对product-service服务进行配置：

1. 选择创建配置

   

2. 新建配置项

   

   注：

   • Data ID 设置为项目名称
   • 配置内容的数据格式，目前只支持properties 和 yaml 类型
   • 设置配置内容：自定义，这里添加的是nacos.config=product
   • 配置管理的命名空间和服务列表命名空间是隔离的，两者需要分别设置，默认都是public

3. 引入Nacos Config 依赖

   <dependency>
       <groupId>com.alibaba.cloud</groupId>
       <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
   </dependency>
   <!-- SpringCloud 2020.*之后版本需要引⼊bootstrap-->
   <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-bootstrap</artifactId>
   </dependency>
   1
   2
   3
   4
   5
   6
   7
   8
   9

4. 配置bootstrap.yml

   微服务启动前，需要先获取Nacos中的配置，并与application.yml配置合并.在微服务运行之前，Nacos必须使用 bootstrap.yml 配置文件来配置Nacos Server地址

   这里在product-service实例中创建bootstrap.yml：

   spring:
     application:
       name: product-service
     cloud:
       nacos:
         config: #注：这里是config，代表配置中心，而服务中心是discovery
           server-addr: 主机号:8848
   1
   2
   3
   4
   5
   6
   7

   注：spring.application.name 需要和nacos配置管理的Data ID 一致，spring.cloud.nacos.config.server-addr 为Nacos Server的地址

5. 为product-service编写一个Controller层进行测试

   package com.product.controller;
   
   import org.springframework.beans.factory.annotation.Value;
   import org.springframework.cloud.context.config.annotation.RefreshScope;
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.RequestMapping;
   import org.springframework.web.bind.annotation.RestController;
   
   @RefreshScope
   @RestController
   public class NacosController {
   
       @Value("${nacos.config}")
       private String nacosConfig;
   
       @RequestMapping("/getConfig")
       public String getNacosConfig() {
           return "从Nacos中获取配置项nacos.config: " + nacosConfig;
       }
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20

   其中@Value用来读取配置，@RefreshScope用来为配置进行热更新

完成上述步骤后，启动服务并访问接口：http://127.0.0.1:9090/getConfig

与在Nacos配置中心中设置的配置内容一致：

​ 此时我们通过Nacos控制台修改配置内容为 nacos.config=public2，同时再访问接口，可以看到在没有修改代码的情况下获取的内容也能发生修改：

Nacos配置管理的命名空间默认是public，在这里我们也可以对其进行修改，使项目启动时先从指定命名空间下找对应的配置项！

在之前已经创建好的namespace dev中创建新的配置：

此时将命名空间ID添加到bootstrap.yml中：

spring:
  application:
    name: product-service
  cloud:
    nacos:
      config:
        namespace: c567e423-b52b-4797-a33b-734ee78882f8 # 修改方式与配置服务中心时一致,添加命名空间ID
1
2
3
4
5
6
7

重启product-service实例，并重新访问接口：http://127.0.0.1:9090/getConfig，可以看到获取到的内容成功更改为dev环境中的配置内容：

spring:
  application:
    name: product-service
  cloud:
    nacos:
      config:
        namespace: c567e423-b52b-4797-a33b-734ee78882f8 # 修改方式与配置服务中心时一致,添加命名空间ID
1
2
3
4
5
6
7

以上便是Nacos的配置与使用介绍了！！如果内容对大家有帮助的话请给这篇文章一个三连关注吧