Nacos 作为服务配置中心演示

Nacos 作为服务配置中心演示

1、Nacos作为配置中心-基础配置

1.1、新建cloudalibaba-config-nacos-client3377模块

1.2、添加pom.xml依赖坐标

<dependencies>
    <!--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>
    <!--一般基础配置-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

1.3、添加YAML配置文件

Nacos同springcloud-config一样，在项目初始化时，要保证先从配置中心进行配置拉取，拉取配置之后，才能保证项目的正常启动。

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

1. 添加bootstrap.yml系统配置文件，拉取配置中心配置

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

   在8848配置中心里面找一个yaml格式的配置文件，集合下面的配置环境进行读取就是，3377到8848配置中下拉取一个dev开发环境的yaml配置文件

2. 添加application.yml配置文件（指定拉取配置中心的spring.profile.active当前环境）

   spring:
     profiles:
       active: dev # 表示开发环境
   

1.4、添加启动类

package com.zcl.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

/**
 * 描述：配置中心启动类
 *
 * @author zhong
 * @date 2022-09-26 19:21
 */
@SpringBootApplication
@EnableDiscoveryClient
public class NacosConfigClientMain3377 {
    
    
    public static void main(String[] args) {
    
    
        SpringApplication.run(NacosConfigClientMain3377.class, args);
    }
}

1.5、业务实现类

1. 业务控制器

   注意：只有添加了@RefreshScope注解后才能实现动态刷新配置信息

   package com.zcl.springcloud.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.RestController;
   
   /**
    * 描述：获取配置文件控制器
    *
    * @author zhong
    * @date 2022-09-26 19:25
    */
   @RestController
   @RefreshScope
   public class ConfigClientController {
         
         
       /**配置中心的内容key*/
       @Value("${config.info}")
       private String configInfo;
   
       /**请求当前接口返回拉取的配置*/
       @GetMapping("/config/info")
       public String getConfigInfo() {
         
         
           return configInfo;
       }
   }
   

1.6、在Nacos上添加配置信息

参考官网地址：https://nacos.io/zh-cn/docs/quick-start-spring-cloud.html

1.6.1、命名方式

在 Nacos Spring Cloud 中，dataId 的完整格式如下：

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

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

在bootstrap.yml配置文件中的套入公式后结果如下

# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# 上面公式整合为（dev是application.yml配置文件里面的生产环境）：nacos-config-client-dev.yaml

1.6.2、Nacos控制台添加配置

在配置列表中点击+新建配置

注意：nacos只支持yaml格式不支持yml格式

配置列表

1.6.3、启动测试

1. 启动3377服务

2. 访问消费者接口获取Nacos配置：http://localhost:3377/config/info

   注意：在接口中通过@Value(${config.info})获取到的内容需要与配置中心的一样，否则是获取不到的

   @Value("${config.info}")
   private String configInfo;
   

1.6.4、自带动态刷新

当我们修改Nacos中的配置文件时，再次通过请求上面的接口就会发现拉取的配置文件已经更新了，不需要再像之前那样通过curl向客户端或服务端发送更新请求

2、Nacos作为配置中心-分类配置

2.1、多环境多项目管理问题

问题1：

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

1. dev开发环境
2. test测试环境
3. prod生产环境。
4. 如何保证指定环境启动时服务能正确读取到Nacos上相应环境的配置文件呢？

问题2：

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

2.2、Nacos的图形化管理界面

2.3、Namespace+Group+Data ID三者关系？

类似Java里面的package名和类名，最外层的namespace是可以用于区分部署环境的，Group和DataID逻辑上区分两个目标对象。

默认情况下：Namespace=public，Group=DEFAULT_GROUP, 默认Cluster是DEFAULT

Nacos默认的命名空间是public，Namespace主要用来实现隔离。比方说我们现在有三个环境：开发、测试、生产环境，我们就可以创建三个Namespace，不同的Namespace之间是隔离的。

Group默认是DEFAULT_GROUP，Group可以把不同的微服务划分到同一个分组里面去

Service就是微服务；一个Service可以包含多个Cluster（集群），Nacos默认Cluster是DEFAULT，Cluster是对指定微服务的一个虚拟划分。比方说为了容灾，将Service微服务分别部署在了杭州机房和广州机房，这时就可以给杭州机房的Service微服务起一个集群名称（HZ），给广州机房的Service微服务起一个集群名称（GZ），还可以尽量让同一个机房的微服务互相调用，以提升性能。

最后是Instance，就是微服务的实例。

2.4、三种方案加载配置

2.4.1、DataID方案

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

1. 默认空间+默认分组+新建dev和test两个DataID

   在原nacos配置中新添加nacos-config-client-test.yaml配置文件

   

2. 通过spring.profile.active属性就能进行多环境下配置文件的读取

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

3. 访问测试链接一样可以获取到test.yaml配置文件

2.4.2、Group方案

在nacos图形界面控制台上面新建配置文件

分组后

在bootstrap.yml配置文件下指定具体的分组

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: DEV_GROUP # 指定分组

通过上面的group进行不同的组进行读取即可

application.yml配置文件

spring:
  profiles:
    active: info

2.4.3、Namespace方案

1、新建dev/test的Namespace

完整列表

2、回到服务管理-服务列表查看

3、按照域名配置填写

4、配置YML

bootstrap.yml系统配置文件

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: TEST_GROUP # 指定分组
        namespace: ea326f44-304c-4a0d-9d3a-34c3c67742cb # 指定唯一的空间id

application.yml指定具体的环境

spring:
  profiles:
    # active: info
    # active: test # 表示测试环境
    active: dev # 表示开发环境