Nacos共享配置

最新推荐文章于 2024-05-31 17:50:21 发布
最新推荐文章于 2024-05-31 17:50:21 发布
阅读量3.5k 收藏 8
点赞数 3
文章标签： spring cloud
原文链接：https://blog.csdn.net/qq_33619378/article/details/98972790
版权

参考：Nacos（七）：Nacos共享配置_LarsCheng's Blog-CSDN博客_nacos共享配置

图文详述Nacos配置中心使用：应用间配置共享、扩展配置文件加载优先级、新老版本差异_Saintmm的博客-CSDN博客_nacos shared-configs 不生效

我的环境

  • Windows10
  • JDK8
  • SpringCloud：Hoxton.SR9
  • SpringBoot：2.3.9.RELEASE
  • spring-cloud-alibaba-dependencies：2.2.3.RELEASE
  • Nacos-server：2.0.3

场景描述

一个项目中服务数量增加后，配置文件相应增加，多个配置文件中会存在相同的配置，那么我们可以将相同的配置独立出来，作为该项目中各个服务的共享配置文件，每个服务都可以通过Nacos进行共享配置的读取

下面用一个demo演示下，是否可行

demo工程：nacos-config-share
配置文件：nacos-config-share.yml
共享配置文件：shareconfig1.yml，shareconfig2.yml

创建项目

 创建聚合工程springcloud-nacos, 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>

    <groupId>com.cloud</groupId>
    <artifactId>springcloud-nacos</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>nacos-config-share</module>
    </modules>

    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <worldskills.version>1.1.0</worldskills.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-boot.version>2.3.9.RELEASE</spring-boot.version>
        <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
        <spring-cloud-alibaba.version>2.2.3.RELEASE</spring-cloud-alibaba.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${spring-boot.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <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>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.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>
</project>

创建子工程nacos-config-share, maven坐标：

<dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

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

创建配置类：NacosShareConfig

@Data
@RefreshScope
@Configuration
@ConfigurationProperties(prefix = "nacos.config")
public class NacosShareConfig {

    private String nacosConfigShare;
    /**
     * 共享配置
     */
    private String shareConfig1;

    private String shareConfig2;

    /**
     * 扩展共享配置
     */
    private String shareConfig3;

    private String shareConfig4;
}

控制器：NacosConfigShareController

@RestController
@RequestMapping("/share")
public class NacosConfigShareController {

    @Autowired
    private NacosShareConfig nacosShareConfig;

    @RequestMapping("/getConfigShare")
    public String getConfigShare() {
        return nacosShareConfig.getNacosConfigShare();
    }

    @RequestMapping("/getShareConfig1")
    public String getShareConfig1() {
        return nacosShareConfig.getShareConfig1();
    }

    @RequestMapping("/getShareConfig2")
    public String getShareConfig2() {
        return nacosShareConfig.getShareConfig2();
    }

    @RequestMapping("/getShareConfig3")
    public String getShareConfig3() {
        return nacosShareConfig.getShareConfig3();
    }

    @RequestMapping("/getShareConfig4")
    public String getShareConfig4() {
        return nacosShareConfig.getShareConfig4();
    }
}

配置文件：bootstrap.yml

spring:
  application:
    name: nacos-config-share
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.194.128:8848
      config:
        server-addr: 192.168.194.128:8848
        prefix: ${spring.application.name}
        file-extension: yml
        #旧共享配置方式+动态刷新
#        shared-dataids: shareconfig1.yml,shareconfig2.yml
#        refreshable-dataids: shareconfig1.yml,shareconfig2.yml
        #新的共享配置+动态刷新
        shared-configs:
          - data-id: shareconfig1.yml
            group: DEFAULT_GROUP
            refresh: true #动态刷新配置开启
          - data-id: shareconfig2.yml
            group: DEFAULT_GROUP
            refresh: false #动态刷新配置关闭

从配置文件可以看出，通过shared-dataids属性来指定要读取共享配置文件的DataID,多个文件用,分隔使用refreshable-dataids指定共享配置文件支持自动刷新

shared-dataids/refreshable-dataids官方标记废弃了

Nacos新建配置文件 

这里我们作为演示，暂不加入Namespace，直接在公共空间中创建及测试

创建配置文件nacos-config-share.yml,详细如下：

  • DataId:nacos-config-share.yml
  • 配置格式：YAML
  • 配置内容： 
    server:
    port: 9984
nacos:
    config:
        nacosConfigShare: nacos-config-share

创建共享配置文件1shareconfig1.yml,详细如下：

  • DataId:shareconfig1.yml
  • 配置格式：YAML
  • 配置内容： 
    nacos:
    config:
        shareConfig1: 这里是共享配置文件1

创建共享配置文件1shareconfig2.yml,详细如下：

  • DataId:shareconfig2.yml
  • 配置格式：YAML
  • 配置内容： 
    nacos:
    config:
        shareConfig2: 这里是共享配置文件2

创建成功后，配置列表如下图：

 

 启动测试

访问控制器提供的接口

http://localhost:9984/share/getConfigShare   #nacos-config-share
http://localhost:9984/share/getShareConfig1  #这里是共享配置文件1
http://localhost:9984/share/getShareConfig2  #这里是共享配置文件2

再测试下共享配置的自动刷新是否生效，shareconfig1.yml的refresh:true  预期会生效，shareconfig2.yml的refresh：false不生效

在Nacos控制台中修改共享配置文件shareconfig1.yml的值为：这里是共享配置文件1-测试动态刷新是否生效

编辑保存后，重新请求 http://localhost:9984/share/getShareConfig1 ，观察返回结果如下：
 

这里是共享配置文件1-测试动态刷新是否生效

  重新请求 http://localhost:9984/share/getShareConfig2 ，观察返回结果如下：

这里是共享配置文件2

需求变更

假设现在要读取shareconfig3.yml和shareconfig4.yml文件但是它的Group为SHARE3_GROUP和SHARE4_GROUP, 即共享配置文件与项目自身配置文件不在同一Group中（上边的例子是全都在DEFAULT_GROUP分组） 那如果继续用上边的方法，就无法读取共享配置文件

这时可以使用另一个配置ext-config，它可以由用户自定义指定需要加载的配置DataID、Group以及是否自动刷新

并且ext-config是一个集合（List），支持多个配置文件的指定。

注：ext-config官方标记废弃；取而代之的是extension-configs

新建共享配置文件

先创建配置配置文件shareconfig3.yml和shareconfig4.yml，注意他们的Group属性

  • DataId:shareconfig3.yml
  • Group：SHARE3_GROUP
  • 配置格式：YAML
  • 配置内容： 
    nacos:
    config:
        shareConfig3: 这里是共享配置文件3，Group:SHARE3_GROUP
  • DataId:shareconfig4.yml
  • Group：SHARE4_GROUP
  • 配置格式：YAML
  • 配置内容： 
    nacos:
    config:
        shareConfig4: 这里是共享配置文件4，Group:SHARE4_GROUP

创建成功页面如下：

 

修改项目配置文件bootstrap.yml,增加ext-config(旧)，extension-configs(新)

配置

spring:
  application:
    name: nacos-config-share
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.194.128:8848
      config:
        server-addr: 192.168.194.128:8848
        prefix: ${spring.application.name}
        file-extension: yml
        #旧共享配置方式+动态刷新
#        shared-dataids: shareconfig1.yml,shareconfig2.yml
#        refreshable-dataids: shareconfig1.yml,shareconfig2.yml
        #新的共享配置+动态刷新
        shared-configs:
          - data-id: shareconfig1.yml
            group: DEFAULT_GROUP
            refresh: true #动态刷新配置开启
          - data-id: shareconfig2.yml
            group: DEFAULT_GROUP
            refresh: false #动态刷新配置关闭
        #旧扩展配置方式+动态刷新 + 不同组获取共享配置数据
#        ext-config:
#          - data-id: shareconfig3.yml
#            group: SHARE3_GROUP
#            refresh: true
#          - data-id: shareconfig4.yml
#            group: SHARE4_GROUP
#            refresh: true
        #新的扩展配置方式 + 动态刷新 + 不同组获取共享配置数据
        extension-configs:
          - data-id: shareconfig3.yml
            group: SHARE3_GROUP
            refresh: true #动态刷新配置开启
          - data-id: shareconfig4.yml
            group: SHARE4_GROUP
            refresh: false #动态刷新配置关闭

启动进行测试 

项目经过修改后，可以看到

  1. 项目自身的nacos配置文件属于DEFAULT_GROUP下,默认读取
  2. shareconfig1.yml,shareconfig2.yml 都属于DEFAULT_GROUP下，通过shared-dataids(旧)/shared-configs(新)指定进行读取
  3. shareconfig3.yml,shareconfig4.yml 都属于非DEFAULT_GROUP下，通过ext-config(旧)/extension-configs(新)配置属性进行自定义读取

启动项目，测试所有的配置文件是否可以正常读取 

http://localhost:9984/share/getConfigShare   #nacos-config-share
http://localhost:9984/share/getShareConfig1  #这里是共享配置文件1
http://localhost:9984/share/getShareConfig2  #这里是共享配置文件2
http://localhost:9984/share/getShareConfig3  #这里是共享配置文件3，Group:SHARE3_GROUP
http://localhost:9984/share/getShareConfig4  #这里是共享配置文件4，Group:SHARE4_GROUP

修改shareconfig3.yml的配置内容为：这里是共享配置文件3，Group:SHARE3_GROUP- 测试扩展配置是否支持动态刷新，保存后，再次调用http://localhost:9984/share/getShareConfig3，返回如下：

这里是共享配置文件3，Group:SHARE3_GROUP - 测试扩展配置是否支持动态刷新 

调用接口后发现，两种共享配置的加载方式都可以正常读取，并且可以一起使用。extension-configs的方式实现了用户自定义配置共享配置文件。 

总结

上面的demo已经演示Nacos共享配置的两种实现方式，两种方式针对不同的场景，总结如下：

  • shared-configs方式：
    • 适合于共享配置文件与项目默认配置文件处于相同Group时，直接两条命令就可以搞定
    • 优点：配置方便
    • 缺点：只能在同一Group中
  • ext-config方式：
它可以由开发者自定义要读取的共享配置文件的DataId、Group、refresh属性，这样刚好解决了shared-dataids存在的局限性。
优点：可以与shared-dataids方案结合使用，用户自定义配置。灵活性强
缺点：配置容易出错，要熟悉YAML语法

 

爱上远方
关注
  • 3
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
3.SpringCloud：Nacos配置中心
zyplanke的专栏
10-20 5503
Nacos既提供注册中心，也提供配置中心。下面分别以两个例子来说明配置中心的使用。
Nacos使用实践
qq_32238611的博客
08-02 2734
本文主要整理了如何使用nacos作为微服务的注册中心、配置中心以及开启鉴权。
nacos配置管理之共享配置
最新发布
深入代码世界：程序员的技术探索与实战分享
05-31 439
1、在nacos配置管理的配置列表中添加共享的配置。拉取前还需做一些配置。新建bootstrap.yml。在module中引入如下依赖。
Nacos配置中心、注册中心详解（配置文件命名规则、extension-configs、shared-configs的作用、加载优先级）
朱大虾
06-22 6837
Nacos配置中心的详细使用、注册中心详细使用、那配置列表那么多已创建的配置文件，怎么和服务对应上(配置文件命名规则)、extension-configs读取多个配置文件、shared-configs共享配置、配置文件的读取优先级、配置文件热更新
Nacos系列(10)-Nacos开启shared-configs配置共享，读取多个配置
热门推荐
记录知识、锤炼自我
09-06 4万+
前言 在实际项目中，每个子模块中，spring有许多相同配置项，比如Redis,Mysql等等，这些公用配置信息，可以放在同一个配置文件中，方便管理及修改 步骤 pom添加Redis，把连接信息配置在共享配置中 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId
nacos解决shared-configs下的共享配置文件无法实时更新
天真吖的博客
04-16 2147
使用@RefreshScope注解，服务启动后，在nacos配置中心，修改shared-configs下的配置文件mysql.yml，数据源无法实时更新。nacos针对该服务只监听了以上3个配置文件，而我的mysql.yml并没有被监听。进入Config类，发现他有多个构造方法，怀疑问题出现在这里，于是找到问题所在，只需要在yml构造时调用其他的构造，即可。尝试进入shared-configs发现调用了这个方法。
nacos配置中心数据
03-29
在Nacos中，这样的通用配置可以被多个服务共享，减少配置的冗余，提高代码的整洁度和维护性。 Nacos配置中心的使用流程通常包括以下几个步骤： 1. **安装与启动**：下载Nacos服务器，按照官方文档进行安装配置，...
Nacos配置中心.7z
02-05
4. **命名空间**：Nacos支持多命名空间，这意味着不同团队或项目可以共享同一Nacos实例，但各自的配置和服务相互隔离，增强了系统的安全性。 5. **集群模式**：Nacos支持集群部署，以提高服务的稳定性和可用性。...
完整的nacos配置，仅供参考
08-29
集群中的每个节点都是对等的，它们共享相同的配置存储并互相备份，确保服务的高可用。 4. **数据持久化**：Nacos支持两种数据持久化方式：RDBMS（关系型数据库管理系统，如MySQL）和Local Storage（本地存储）。...
Spring Cloud Alibaba Nacos Config - - - ＞多配置文件/共享配置
12-10
在一个微服务架构应用系统中可能包含成百上千...而很多微服务可能都引入相同的中间件，当环境中引入的中间件较多时，集中管理配置/共享配置是非常有必要的，方便管理维护。比如：MySQL数据库、redis缓存、消息队列等。
nacos2.2.3-oracle版本
10-11
- `data`：存储Nacos运行时的数据，包括注册的服务信息和配置信息，集群环境下通常需要在每个节点上共享此目录。 - `target`：通常包含构建后的可执行文件或jar包，这里是Nacos服务器的运行文件。 - `bin`：包含启动...
【Nacos学习】五、Nacos共享配置
qq_37634156的博客
02-28 4664
前言 一个项目中服务数量增加后，配置文件相应增加，多个配置文件中会存在相同的配置，那么我们可以将相同的配置独立出来，作为该项目中各个服务的共享配置文件，每个服务都可以通过Nacos进行共享配置的读取 新建项目 创建名为【nacos-share】的子服务，用来测试Nacos共享配置功能。 pom文件 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0"
【Spring Cloud】关于Nacos配置管理的详解介绍
万维网连五洲，二进制写尽天下事，喜欢结识新伙伴寻找志同道合的朋友，欢迎一起探讨学习
01-07 7123
当我们的项目服务多起来的时候配置文件是必不可少的，但有些配置文件又是重复的，那么我们如果将它进行统一管理呢？那就可以用到我们的Nacos，不但有服务注册中心还有配置管理何乐而不为？
springcloud-alibaba-nacos（8）nacos共享配置
胖虎儿的博客
04-14 1739
nacos 读取共享配置，以及测试多个共享配置优先级，以及核心配置与共享配置优先级
SpringCloud-Alibaba之Nacos共享配置、灰度配置
2401_83329402的博客
03-31 858
对比我的面经和其他大佬的面经，自己真的是运气好。一个系统中微服务数量增加后，配置文件相应增加，多个配置文件中会存在相同的配置，那么我们可以将相同的配置独立出来，作为该系统中各个服务的共享配置文件，每个服务都可以通过Nacos进行共享配置的读取。配置加载的优先级spring.cloud.nacos.config.shared-dataids参数用来配置多个共享配置的Data Id，多个的时候用用逗号分隔。当我们加载多个配置的时候，如果存在相同的key时，我们需要深入了解配置加载的优先级关系。
06-Nacos-设置共享配置
宣晨光
01-29 996
首先在nacos的控制台配置多个配置文件，注意配置中指定DataID 为 share-config1.properties。
Nacos多配置管理
qq_63431773的博客
11-23 280
到目前为止我们已经解决了微服务相关的几个问题：微服务远程调用微服务注册、发现微服务请求路由、负载均衡微服务登录用户信息传递不过，现在依然还有几个问题需要解决：网关路由在配置文件中写死了，如果变更必须重启微服务某些业务配置在配置文件中写死了，每次修改都要重启服务每个微服务都有很多重复的配置，维护成本高这些问题都可以通过统一的解决。
Nacos多服务共享配置
qq_56416509的博客
07-02 412
服务名-profile.yaml>服务名称.yaml>本地配置（前两个属于nacos中的配置文件，其中第一个属于当前环境配置，第二个属于共享配置）微服务会从nacos读取的配置文件：1.服务名-profile.yaml，环境配置；2.服务名.yaml,默认配置，多环境共享。
解读yml配置文件shared-configs: - vdp-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
weixin_42759398的博客
07-02 460
请注意，上述代码片段中的配置可能是特定项目、团队或组织约定的一部分。的配置列表，其中包含一个元素。该元素的值是一个字符串，使用了变量和属性的形式来组装文件路径。在这个配置列表中，这个元素的值将根据当前的环境配置动态地生成一个文件路径。是另一个属性占位符，用于获取 Nacos（一个分布式配置中心）配置的文件扩展名。是一个 Spring Boot 属性占位符，用于获取当前激活的配置文件的名称。这样设计的目的是根据当前环境和配置的不同，动态加载相应的配置文件进行使用。，而 Nacos 配置使用的文件扩展名是。
nacos配置中心共享配置
10-12
Nacos配置中心支持共享配置，可以将配置发布到多个命名空间或者多个分组中，实现不同应用之间的配置共享。具体实现方式可以通过以下步骤来完成： 1. 在Nacos控制台中创建多个命名空间或者分组。 2. 在需要共享配置...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值