SpringCloud Alibaba 2021版 nacos 配置中心教程

已于 2023-03-11 11:36:12 修改
阅读量1w 收藏 32
点赞数 17
分类专栏： Spring Cloud Alibaba 文章标签： java nacos config nacos 配置中心 Alibaba nacos
于 2022-03-25 23:29:02 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_39654841/article/details/123719707
版权

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到网站。

文章目录


上篇介绍了 nacos作为注册中心的使用，这篇来看看nacos作为配置中心将怎么使用？

nacos 配置中心 是什么

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 环境中。当应用程序通过部署管道从开发到测试再到生产时，您可以管理这些环境之间的配置，并确保应用程序具有迁移时需要运行的所有内容。

nacos config 和 springcloud config 对比

  • springcloud config大部分场景结合git 使用, 动态变更还需要依赖Spring Cloud Bus 消息总线来通过所有的客户端变化.
  • springcloud config不提供可视化界面
  • nacos config使用长轮询更新配置, 一旦配置有变动后，通知Provider的过程非常的迅速, 从速度上秒杀springcloud

常用配置中心对比

在这里插入图片描述

Spring Cloud Alibaba config 特性

支持配置的动态更新

spring-cloud-starter-alibaba-nacos-config 也支持配置的动态更新，当配置修改时能获取到最新数据。
也可以通过配置 spring.cloud.nacos.config.refresh.enabled=false 来关闭动态刷新

支持profile粒度的配置

spring-cloud-starter-alibaba-nacos-config 在加载配置的时候，不仅仅加载了以 dataid 为 {spring.application.name}.{file-extension:properties} 为前缀的基础配置，还加载了dataid为 {spring.application.name}-{profile}.{file-extension:properties} 的基础配置。在日常开发中如果遇到多套环境下的不同配置，可以通过Spring 提供的 {spring.profiles.active} 这个配置项来配置。

spring.profiles.active=develop

profile 的配置文件 大于 默认配置的文件。 并且形成互补

支持自定义 namespace 的配置

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

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

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

支持自定义 Group 的配置

Group是组织配置的维度之一。通过一个有意义的字符串（如 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

支持自定义扩展的 Data Id 配置

Data ID 是组织划分配置的维度之一。Data ID 通常用于组织划分系统的配置集。一个系统或者应用可以包含多个配置集，每个配置集都可以被一个有意义的名称标识。Data ID 通常采用类 Java 包（如 com.taobao.tc.refund.log.level）的命名规则保证全局唯一性。此命名规则非强制。
通过自定义扩展的 Data Id 配置，既可以解决多个应用间配置共享的问题，又可以支持一个应用有多个配置文件。

spring.application.name=opensource-service-provider
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

# config external configuration
# 1、Data Id 在默认的组 DEFAULT_GROUP,不支持配置的动态刷新
spring.cloud.nacos.config.extension-configs[0].data-id=ext-config-common01.properties

# 2、Data Id 不在默认的组，不支持动态刷新
spring.cloud.nacos.config.extension-configs[1].data-id=ext-config-common02.properties
spring.cloud.nacos.config.extension-configs[1].group=GLOBALE_GROUP

# 3、Data Id 既不在默认的组，也支持动态刷新
spring.cloud.nacos.config.extension-configs[2].data-id=ext-config-common03.properties
spring.cloud.nacos.config.extension-configs[2].group=REFRESH_GROUP
spring.cloud.nacos.config.extension-configs[2].refresh=true

可以看到:

  • 通过 spring.cloud.nacos.config.extension-configs[n].data-id 的配置方式来支持多个 Data Id 的配置。
  • 通过 spring.cloud.nacos.config.extension-configs[n].group 的配置方式自定义 Data Id 所在的组，不明确配置的话，默认是 DEFAULT_GROUP。
  • 通过 spring.cloud.nacos.config.extension-configs[n].refresh 的配置方式来控制该 Data Id 在配置变更时，是否支持应用中可动态刷新， 感知到最新的配置值。默认是不支持的。

多个 Data Id 同时配置时，它的优先级关系是 spring.cloud.nacos.config.extension-configs[n].data-id 其中 n 的值越大，优先级越高。
spring.cloud.nacos.config.extension-configs[n].data-id 的值必须带文件扩展名，文件扩展名既可支持 properties，又可以支持 yaml/yml。
此时 spring.cloud.nacos.config.file-extension 的配置对自定义扩展配置的 Data Id 文件扩展名没有影响。

通过自定义扩展的 Data Id 配置，既可以解决多个应用间配置共享的问题，又可以支持一个应用有多个配置文件。

通过自定义扩展的 Data Id 配置，既可以解决多个应用间配置共享的问题，又可以支持一个应用有多个配置文件。
为了更加清晰的在多个应用间配置共享的 Data Id ，你可以通过以下的方式来配置：

# 配置支持共享的 Data Id
spring.cloud.nacos.config.shared-configs[0].data-id=common.yaml

# 配置 Data Id 所在分组，缺省默认 DEFAULT_GROUP
spring.cloud.nacos.config.shared-configs[0].group=GROUP_APP1

# 配置Data Id 在配置变更时，是否动态刷新，缺省默认 false
spring.cloud.nacos.config.shared-configs[0].refresh=true

可以看到：

  • 通过 spring.cloud.nacos.config.shared-configs[n].data-id 来支持多个共享 Data Id 的配置。
  • 通过 spring.cloud.nacos.config.shared-configs[n].group 来配置自定义 Data Id 所在的组，不明确配置的话，默认是 DEFAULT_GROUP。
  • 通过 spring.cloud.nacos.config.shared-configs[n].refresh 来控制该Data Id在配置变更时，是否支持应用中动态刷新，默认false。

配置的优先级

Spring Cloud Alibaba Nacos Config 目前提供了三种配置能力从 Nacos 拉取相关的配置。

  • A: 通过 spring.cloud.nacos.config.shared-configs[n].data-id 支持多个共享 Data Id 的配置
  • B: 通过 spring.cloud.nacos.config.extension-configs[n].data-id 的方式支持多个扩展 Data Id 的配置
  • C: 通过内部相关规则(应用名、应用名+ Profile )自动生成相关的 Data Id 配置

当三种方式共同使用时，他们的一个优先级关系是:A < B < C

完全关闭配置

通过设置 spring.cloud.nacos.config.enabled = false 来完全关闭 Spring Cloud Nacos Config

Spring Cloud Alibaba config 2021.0.1.0 升级指南

  • 版本号
    从 2021.0.1.0 开始，SCA 版本将会对应 Spring Cloud 版本，
    前三位为 Spring Cloud 版本，最后一位为扩展版本

升级步骤

升级版本 (注意版本对应关系)

<dependencyManagement>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>2.6.3</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-dependencies</artifactId>
        <version>2021.0.1</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-alibaba-dependencies</artifactId>
        <version>2021.0.1.0</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
</dependencyManagement>

注意事项： spring-cloud-starter-alibaba-nacos-config 模块移除了 spring-cloud-starter-bootstrap 依赖，如果你想以旧版的方式使用，你需要手动加上该依赖，现在推荐使用 spring.config.import 方式引入配置

完成以上步骤就能无缝切换到 spring cloud alibaba 2021.0.1.0 版本

新特性及其使用

  • 支持 spring.config.import
    这里假设有一个配置文件(bootstrap.yml)，升级到新版本应该怎么配置呢
# bootstrap.yml
spring:
  cloud:
    nacos:
      config:
        name: test.yml
        group: DEFAULT_GROUP
        server-addr: 127.0.0.1:8848
        extension-configs:
          - dataId: test01.yml
            group: group_01
          - dataId: test02.yml
            group: group_02
            refresh: false

这两个配置是等价的

# application.yml
spring:
  cloud:
    nacos:
      config:
        group: DEFAULT_GROUP
        server-addr: 127.0.0.1:8848
  config:
    import:
      - optional:nacos:test.yml  # 监听 DEFAULT_GROUP:test.yml
      - optional:nacos:test01.yml?group=group_01 # 覆盖默认 group，监听 group_01:test01.yml
      - optional:nacos:test02.yml?group=group_02&refreshEnabled=false # 不开启动态刷新
      - nacos:test03.yml # 在拉取nacos配置异常时会快速失败，会导致 spring 容器启动失败

注意事项:

  • 如果使用 spring.config.import 就不能使用 bootstrap.yml/properties 引入配置的方式了 !!!

  • 如果引入了 spring-cloud-starter-alibaba-nacos-config，并且使用 import 方式导入配置,项目启动时会自动检测是否引入了 nacos: 条目，如果没有 import nacos 条目，会出现如下错误：

The spring.config.import property is missing a nacos: entry
Action:
Add a spring.config.import=nacos: property to your configuration.
	If configuration is not required add spring.config.import=optional:nacos: instead.
	To disable this check, set spring.cloud.nacos.config.import-check.enabled=false.

你可以手动通设置 spring.cloud.nacos.config.import-check.enabled=false 关闭它，但是不建议这么做，这个功能可以帮助你检查是否引入多余依赖

  • 假如想保留以前的使用方式 (bootstrap引入配置)，你只需要添加依赖 spring-cloud-starter-bootstrap 依赖，不需要修改一行代码

快速入门

本次使用版本：

Spring Cloud Alibaba 版本Spring Cloud 版本Spring Boot 版本
2021.12021.0.12.6.4
  1. 启动nacos server
    安装教程请移步到windows系统 安装nacos服务注册与发现中心
  2. 引入依赖
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
  1. 修改配置文件
server:
  port: 8090

spring:
  cloud:
    nacos:
      discovery:
        group: PROVIDER_GROUP
      config:
        group: PROVIDER_CONFIG_GROUP
        server-addr: 127.0.0.1:8848
  config:
    import:
      - optional:nacos:provider-config-dev.yml  # 监听 PROVIDER_GROUP :provider-config-dev.yml
#      - optional:nacos:provider-config-dev.yml?group=group_01  # 覆盖默认 group，监听 group_01:provider-config-dev.yml
#      - optional:nacos:provider-config-dev.yml?group=group_02&refreshEnabled=false # 不开启动态刷新
      - nacos:provider-config-dev.yml # 在拉取nacos配置异常时会快速失败，会导致 spring 容器启动失败
  application:
    name: nacos-provider
  1. 创建配置类 及 dataId配置文件
@Configuration
@ConfigurationProperties(prefix = "configdata")
public class UserConfig {

    private String name;
    private Integer age;
    // 省略get/set方法
}

provider-config-dev.yml:
这个配置文件其实也可以不必在项目中配置，在nacos中配置即可，这里配置主要是做为一个记录而已

configdata:
  age: 21
  name: freeman
  1. 打开nacos管理后台，新建配置
  • 找到配置列表
    在这里插入图片描述
  • 点击＋添加配置
    在这里插入图片描述
    Data ID: 对应着application.yml配置文件中spring.config.import属性中配置的文件名及其扩展名
    Group: spring.cloud.nacos.config.group属性对应的值
    格式：选择Data ID对应文件的扩展名
    配置内容: Data ID对应文件内容
    上述内容填写好之后，点击发布，在配置列表中就能看到刚刚填写的配置
    在这里插入图片描述
    打开nacos数据库，在config_info表中也能看到刚刚添加的数据
    在这里插入图片描述
    接下来进入测试阶段，来验证上述配置是否可行
  1. 测试
    启动项目，在控制台可以看到配置的配置信息
    在这里插入图片描述
  • 首先在浏览器访问 http://localhost:8090/helloProvider/getConfig
    在这里插入图片描述
  • 然后修改在nacos管理后台 配置列表中找到provider-config-dev.yml配置，并编辑配置内容，将age从21修改为24，确认发布
    在这里插入图片描述
    再次访问 http://localhost:8090/helloProvider/getConfig
    在这里插入图片描述
    发现数据也变成最新的数据了。

至此，nacos做为配置中心的入门就完成了。

参考：

https://nacos.io/zh-cn/docs/what-is-nacos.html
https://github.com/alibaba/spring-cloud-alibaba/wiki/

能力一般，水平有限，如有错误，请多指出。
如果对你有用点个关注给个赞呗

索码理
关注
专栏目录
【云原生】SpringCloud Alibaba 之 Nacos注册中心实战
wanghuichen的博客
07-22 5387
什么是 Spring Cloud Alibaba，Nacos又是什么，快速入门Naocs！
微服务nacos搭建报错No spring.config.import property has been defined
weixin_50568403的博客
06-19 589
因为spring-cloude无法识别bootstrap.properties文件，所以添加该依赖项。
spring-cloud-starter-alibaba-nacos-config-2.1.0.RELEASE.jar
03-09
spring-cloud-starter-alibaba-nacos-config-2.1.0.RELEASE.jar
配置参数读取类的注入方式（yaml、properties或nacos等配置中心配置的参数）
最新发布
lfplfp1109的博客
08-22 408
配置参数读取类的注入方式
spring-cloud-starter-alibaba-nacos-config 启动配置管理
热门推荐
不懂一休
04-07 1万+
nacos spring-cloud 参考地址： https://nacos.io/zh-cn/docs/quick-start-spring-cloud.html Spring Cloud Alibaba Nacos Config 参考地址：https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config 版本对应说明： https://github.com/alibaba/spring-cloud-alibaba/wiki/版本说明 说明
Add a spring.config.import=nacos: property to your configuration. If configuration is not required
m0_72395978的博客
08-22 9160
产生问题的原因是bootstrap.properties比application.properties的优先级要高由于bootstrap.properties是系统级的资源配置文件，是用在程序引导执行时更加早期配置信息读取；而application.properties是用户级的资源配置文件，是用来后续的一些配置所需要的公共参数。但是在SpringCloud 2020.* 版本把bootstrap禁用了，导致在读取文件的时候读取不到而报错，所以我们只要把bootstrap重新导入进来就会生效了。
Add a spring.config.import=nacos: property to your configuration.If configuration is not required
a_smart_lin的博客
04-03 3612
但是在SpringCloud 2020.* 版本把bootstrap禁用了，导致在读取文件的时候读取不到而报错，所以我们只要把bootstrap重新导入进来就会生效了。产生问题的原因是bootstrap.properties比application.properties的优先级要高。由于bootstrap.properties是系统级的资源配置文件，是用在程序引导执行时更加早期配置信息读取；而application.properties是用户级的资源配置文件，是用来后续的一些配置所需要的公共参数。
springCloud-alibaba-nacos配置中心讲义.pdf
10-06
在本讲义中，我们将重点探讨如何使用 Spring Cloud Alibaba Nacos Config 将 Nacos 作为配置中心来使用。首先，我们需要了解 Nacos 的基本概念。Nacos 提供了一个基于 Web 的用户界面，可以方便地查看、编辑和推送...
SpringCloud-Alibaba之Nacos配置中心
gongzi_759的博客
08-10 908
SpringCloud-Alibaba之Nacos配置中心
Spring Cloud Alibaba Nacos注册中心入门
鱼丝泽的博客
03-10 1667
Spring Cloud Nacos注册中心入门和多环境配置
spring-cloud-starter-alibaba-nacos-config-2021.1-API文档-中文版.zip
05-09
赠送jar包：spring-cloud-starter-alibaba-nacos-config-2021.1.jar； 赠送原API文档：spring-cloud-starter-alibaba-nacos-config-2021.1-javadoc.jar； 赠送源代码：spring-cloud-starter-alibaba-nacos-config-2021.1-sources.jar； 赠送Maven依赖信息文件：spring-cloud-starter-alibaba-nacos-config-2021.1.pom； 包含翻译后的API文档：spring-cloud-starter-alibaba-nacos-config-2021.1-javadoc-API文档-中文(简体)版.zip； Maven坐标：com.alibaba.cloud:spring-cloud-starter-alibaba-nacos-config:2021.1； 标签：cloud、spring、alibaba、starter、config、nacos、jar包、java、中文文档； 使用方法：解压
SpringCloud Alibaba使用 - Nacos服务注册、配置中心、集群和持久化.zip
06-22
Spring Cloud Alibaba 致力于提供微服务开发的一站式...依托 Spring Cloud Alibaba，您只需要添加一些注解和少量配置，就可以将 Spring Cloud 应用接入阿里微服务解决方案，通过阿里中间件来迅速搭建分布式应用系统。
Spring Cloud Alibaba 2021.0.1.0之Nacos升级
sunnyday0426的博客
06-13 2167
spring-cloud-starter-alibaba-nacos-config 模块移除了 spring-cloud-starter-bootstrap 依赖，如果你想以旧版的方式使用，你需要手动加上该依赖，现在推荐使用 spring.config.import 方式引入配置。你可以手动通设置 spring.cloud.nacos.config.import-check.enabled=false 关闭它，但是不建议这么做，这个功能可以帮助你检查是否引入多余依赖。
spring-Cloud-Alibaba-nacos-Config
qq_41480794的博客
03-28 672
1.电商微服务架构 2.用户下单场景微服务搭建 3.nacos简单介绍 4. 一般架构设计 5. nacos使用场景 6.springboot和nacos的配置中心整合： （1）pom.xml <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-a.
Spring Cloud Alibaba组件-Nacos Config
xiaochen的博客
06-23 2046
Nacos中添加项目配置文件 获取配置信息 动态感知 配置优先级介绍
Spring cloud alibaba--Nacos Config配置管理
ZHANGLIZENG的博客
07-25 1万+
1.
SpringCloudAlibaba之Nacos Config
林知屿的博客
03-24 1260
配置文件相对分散。在一个微服务架构下，配置文件会随着微服务的增多变的越来越多，而且分散在各个微服务中，不好统一配置和管理。配置文件无法区分环境。微服务项目可能会有多个环境，例如：测试环境、预发布环境、生产环境。每一个环境所使用的配置理论上都是不同的，一旦需要修改，就需要我们去各个微服务下手动维护，这比较困难。配置文件无法实时更新。我们修改了配置文件之后，必须重新启动微服务才能使配置生效，这对一个正在运行的项目来说是非常不友好的。基于上面这些问题，我们就需要配置中心的加入来解决这些问题。
spring cloud alibaba - 集成nacos配置中心
不才不才不不才的博客
07-06 4496
注意：此版本spring-cloud需要spring-boot 2.6.7及以上版本支持。 版本说明 · alibaba/spring-cloud-alibaba Wiki · GitHubSpring Cloud Alibaba provides a one-stop solution for application development for the distributed solutions of Alibaba middleware. - 版本说明 · alibaba/spring-cloud-
SpringCloud Alibaba Nacos：配置中心实战与接入教程
"本讲义主要围绕Spring Cloud Alibaba中的Nacos配置中心展开，旨在帮助读者理解如何在微服务架构中利用Nacos作为统一的配置管理服务。首先，我们回顾了Nacos的基本概念，它是微服务架构中一个重要的组件，用于集中...
评论 14
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

索码理

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值