2. SpringCloud Alibaba Nacos 之服务配置中心

╰+哭是因爲堅強的太久メ 2022-12-30 08:21 180阅读 0赞

### **SpringCloud Alibaba系列文章列表** ###

[0. SpringCloud Alibaba入门简介][0. SpringCloud Alibaba]  
[1. SpringCloud Alibaba Nacos 之 服务注册中心][1. SpringCloud Alibaba Nacos _]  
[2. SpringCloud Alibaba Nacos 之 服务配置中心][2. SpringCloud Alibaba Nacos _]  
[3. SpringCloud Alibaba Nacos 之 集群][3. SpringCloud Alibaba Nacos _]  
[4. SpringCloud Alibaba Sentinel 服务限流熔断（万字长文）][4. SpringCloud Alibaba Sentinel]

### 文章目录 ###

*   *   *  \*\*SpringCloud Alibaba系列文章列表\*\*
         *  1. Spring Cloud Alibaba Nacos Config
         *  2. 基础配置
         *   *  2.1 Data Id 配置规则
             *  2.2 nacos增加配置
         *  3. 分类配置
         *   *  3.1 思考两个问题
             *  3.2 概念
             *   *  3.2.1 namespace （ 命名空间 ）
                 *  3.2.2 Group （配置分组）
                 *  3.2.2 Data Id （配置集 ID）
             *  3.3 项目实战
             *   *  3.3.1 Data Id 方案
                 *  3.3.2 Group 方案
                 *  3.3.2 NameSpace 方案

**前言**

> 官方文档：  
> https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config

### 1. Spring Cloud Alibaba Nacos Config ###

--------------------

Nacos 提供用于存储配置和其他元数据的 key/value 存储，为分布式系统中的外部化配置提供服务器端和客户端支持。使用 Spring Cloud Alibaba Nacos Config，您可以在 Nacos Server 集中管理你 Spring Cloud 应用的外部属性配置。

Spring Cloud Alibaba Nacos Config 是 Config Server 和 Client 的替代方案，客户端和服务器上的概念与 Spring Environment 和 PropertySource 有着一致的抽象，在特殊的 bootstrap 阶段，配置被加载到 Spring 环境中。当应用程序通过部署管道从开发到测试再到生产时，您可以管理这些环境之间的配置，并确保应用程序具有迁移时需要运行的所有内容。

### 2. 基础配置 ###

--------------------

#### 2.1 Data Id 配置规则 ####

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

在 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 Boot]。 **注意：当 `spring.profiles.active` 为空时，对应的连接符 `-` 也将不存在，dataId 的拼接格式变成 `${prefix}.${file-extension}`**
 *  `file-exetension` 为配置内容的数据格式，可以通过配置项 `spring.cloud.nacos.config.file-extension` 来配置。目前只支持 `properties` 和 `yaml` 类型。

具体配置如下图所示：

dataid 为 nacos-config-client-dev.yaml

![image-20201224142132090][]

另外，通过 Spring Cloud 原生注解 `@RefreshScope` 实现配置自动更新；

#### 2.2 nacos增加配置 ####

![image-20201224142701624][]

点击+添加， 本文以YAML格式为例

![image-20201224142915608][]

按照规则填写Data ID，

Group目前用默认的，后面会介绍。

配置格式选择YAML，

配置内容得是YAML格式，空格没有控制好的话会读取不到配置信息。建议在IDEA里面编辑好后，复制回来。

点击发布即可；

2.3 代码实战

新建项目cloudalibaba-config-nacos-client3377

*  pom.xml
    
        
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <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>
 *  application.yml
    
        spring:
          profiles:
            active: dev
 *  bootstrap.yml
    
    > Nacos同springcloud-config一样，在项目初始化时，要保证先从配置中心进行配置拉取，拉取配置之后，才能保证项目的正常启动。  
    > springboot中配置文件的加载是存在优先级顺序的,**bootstrap优先级高**于application
    
        server:
          port: 3377
        
        spring:
          application:
            name: nacos-config-client
          cloud:
            nacos:
              config:
                server-addr: localhost:8848 #配置中心地址
                file-extension: yaml #指定yaml格式的配置
 *  业务类 web接口
    
        @RestController
        @RefreshScope //自动刷新
        public class ConfigClientController { 
            
            @Value("${config.info}")
            private String configInfo;
        
            /** * 读取 配置的 config.info内容 * @return */
            @GetMapping("/config/info")
            public String getConfigInfo() { 
                return configInfo;
            }
        
        }
 *  启动类
    
    无额外注解
 *  测试
    
    启动项目cloudalibaba-config-nacos-client3377，
    
    浏览器访问 http://localhost:3377/config/info
    
    结果访问成功
    
    ![image-20201224144218052][]
    
    nacos中编辑配置文件内容 version=2，再次访问接口
    
    自动刷新成功。非常牛皮，比springcloud config方便多了
    
    ![image-20201224144338318][]

### 3. 分类配置 ###

--------------------

#### 3.1 思考两个问题 ####

*  实际开发中，通常一个系统会准备dev开发环境、test测试环境、prod生产环境。如何保证指定环境启动时服务能正确读取到Nacos上相应环境的配置文件呢?
 *  一个大型分布式微服务系统会有很多微服务子项目，每个微服务项目又都会有相应的开发环境、测试环境、预发环境、正式环境…那怎么对这些微服务配置进行管理呢?

#### 3.2 概念 ####

官网 https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config

##### 3.2.1 namespace （ 命名空间 ） #####

> 用于进行租户粒度的配置隔离。不同的命名空间下，可以存在相同的 Group 或 Data ID 的配置。Namespace 的常用场景之一是不同环境的配置的区分隔离，例如开发测试环境和生产环境的资源（如配置、服务）隔离等。

在没有明确指定 `${spring.cloud.nacos.config.namespace}` 配置的情况下， 默认使用的是 Nacos 上 Public 这个namespae。如果需要使用自定义的命名空间，可以通过以下配置来实现：

spring.cloud.nacos.config.namespace=b3404bc0-d7dc-4855-b519-570ed34b62d7

<table> 
 <thead> 
  <tr> 
   <th>Note</th> 
   <th>该配置必须放在 bootstrap.properties 文件中。此外 <code>spring.cloud.nacos.config.namespace</code> 的值是 namespace 对应的 id，id 值可以在 Nacos 的控制台获取。并且在添加配置时注意不要选择其他的 namespae，否则将会导致读取不到正确的配置。</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

##### 3.2.2 Group （配置分组） #####

> Nacos 中的一组配置集，是组织配置的维度之一。通过一个有意义的字符串（如 Buy 或 Trade ）对配置集进行分组，从而区分 Data ID 相同的配置集。当您在 Nacos 上创建一个配置时，如果未填写配置分组的名称，则配置分组的名称默认采用 DEFAULT\_GROUP 。配置分组的常见场景：不同的应用或组件使用了相同的配置类型，如 database\_url 配置和 MQ\_topic 配置。

在没有明确指定 `${spring.cloud.nacos.config.group}` 配置的情况下， 默认使用的是 DEFAULT\_GROUP 。如果需要自定义自己的 Group，可以通过以下配置来实现：

spring.cloud.nacos.config.group=DEVELOP_GROUP

<table> 
 <thead> 
  <tr> 
   <th>Note</th> 
   <th>该配置必须放在 bootstrap.properties 文件中。并且在添加配置时 Group 的值一定要和 <code>spring.cloud.nacos.config.group</code> 的配置值一致。</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

##### 3.2.2 Data Id （配置集 ID） #####

> Nacos 中的某个配置集的 ID。配置集 ID 是组织划分配置的维度之一。Data ID 通常用于组织划分系统的配置集。一个系统或者应用可以包含多个配置集，每个配置集都可以被一个有意义的名称标识。Data ID 通常采用类 Java 包（如 com.taobao.tc.refund.log.level）的命名规则保证全局唯一性。此命名规则非强制。

Spring Cloud Alibaba Nacos Config 从 0.2.1 版本后，可支持自定义 Data Id 的配置。

具体配置看官网 https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config\#%E6%94%AF%E6%8C%81%E8%87%AA%E5%AE%9A%E4%B9%89%E6%89%A9%E5%B1%95%E7%9A%84-data-id-%E9%85%8D%E7%BD%AE

#### 3.3 项目实战 ####

##### 3.3.1 Data Id 方案 #####

*  默认命名空间+默认分组+新建dev和test两个Data Id
    
    借助克隆功能；克隆成功后修改内容；
    
    ![image-20201224163727015][]

![image-20201224162120840][]

*  项目中通过spring.profiles.active属性进行多环境下配置文件的读取
    
        spring:
          profiles:
            #active: dev
            active: test

重启项目，浏览器访问 http://localhost:3377/config/info

![image-20201224162839620][]

##### 3.3.2 Group 方案 #####

*  默认命名空间，相同的Data ID，新增一个Group

![image-20201224164818575][]

![image-20201224164842948][]

*  项目中配置

![image-20201224165012647][]

*  测试
    
    重启项目，浏览器访问 http://localhost:3377/config/info
    
    ![image-20201224170607599][]

得到的是GG\_GROUP下的配置文件；

##### 3.3.2 NameSpace 方案 #####

*  新建命名空间+相同的Group+相同的DataID

![image-20201224171333030][]

克隆配置，或者上方切换到dev命名空间后新增

![e03a0455a8215a524d820d2ec3fca4e0.png][]

添加成功后，修改内容

![image-20201224172344151][]

![cb5a6916169af9875365b093853cf7df.png][]

*  项目中配置namespace的id

![image-20201224172531920][]

*  测试
    
    重启项目，浏览器访问 http://localhost:3377/config/info
    
    ![92c20196984925c153a0846013c6343f.png][]

可见namespace > Group > DataID

> 点赞+评论+关注  
> 本文源码地址： https://gitee.com/shuaidawang/SpringCloudDemo.git  
> 有错误的地方欢迎指正！可以加入qq交流群： 700637673

[0. SpringCloud Alibaba]: https://blog.csdn.net/shuai8624/article/details/111137557
[1. SpringCloud Alibaba Nacos _]: https://blog.csdn.net/shuai8624/article/details/111241747
[2. SpringCloud Alibaba Nacos _]: https://blog.csdn.net/shuai8624/article/details/111644546
[3. SpringCloud Alibaba Nacos _]: https://blog.csdn.net/shuai8624/article/details/111874280
[4. SpringCloud Alibaba Sentinel]: https://blog.csdn.net/shuai8624/article/details/112578405
[Spring Boot]: https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-profiles.html#boot-features-profiles
[image-20201224142132090]: /images/20221120/31c673abc0104ecd8cd8e2218eedc3a2.png
[image-20201224142701624]: /images/20221120/06af6390b3854bc8a2ac3b959777ae17.png
[image-20201224142915608]: /images/20221120/6706f2a08a0343eeb066316a514b6f6a.png
[image-20201224144218052]: /images/20221120/f817056d4ada43ea806a68701f95c68c.png
[image-20201224144338318]: https://img-blog.csdnimg.cn/img_convert/2fd4b5c1dc64cce55fc05ec36cd22385.png
[image-20201224163727015]: https://img-blog.csdnimg.cn/img_convert/a947592081a5b7249d809f3afb77085a.png
[image-20201224162120840]: https://img-blog.csdnimg.cn/img_convert/c8d234bde495b02b37297a518a3aa472.png
[image-20201224162839620]: https://img-blog.csdnimg.cn/img_convert/e75b2415b4431d5bbbc852f51b0ec7ed.png
[image-20201224164818575]: https://img-blog.csdnimg.cn/img_convert/98cc75aabb61d2522aa564683b6ac231.png
[image-20201224164842948]: https://img-blog.csdnimg.cn/img_convert/af2e613414deb26d32fd13717c8f587a.png
[image-20201224165012647]: https://img-blog.csdnimg.cn/img_convert/77022923e3433da764bfc11ec5f0358f.png
[image-20201224170607599]: https://img-blog.csdnimg.cn/img_convert/700aba80ae2f04ba7ffcceafd9a1ac38.png
[image-20201224171333030]: https://img-blog.csdnimg.cn/img_convert/99b5bf00cb582b80130bd30fd441bf38.png
[e03a0455a8215a524d820d2ec3fca4e0.png]: https://img-blog.csdnimg.cn/img_convert/e03a0455a8215a524d820d2ec3fca4e0.png
[image-20201224172344151]: https://img-blog.csdnimg.cn/img_convert/3666bd4a2763c7146e1adc23ee5589b2.png
[cb5a6916169af9875365b093853cf7df.png]: https://img-blog.csdnimg.cn/img_convert/cb5a6916169af9875365b093853cf7df.png
[image-20201224172531920]: https://img-blog.csdnimg.cn/img_convert/aa228fe8df66ffbf585c0ad0daf5582a.png
[92c20196984925c153a0846013c6343f.png]: https://img-blog.csdnimg.cn/img_convert/92c20196984925c153a0846013c6343f.png