SpringCloud Alibaba系列文章列表
0. SpringCloud Alibaba入门简介
1. SpringCloud Alibaba Nacos 之 服务注册中心
2. SpringCloud Alibaba Nacos 之 服务配置中心
3. SpringCloud Alibaba Nacos 之 集群
4. SpringCloud Alibaba Sentinel 服务限流熔断(万字长文)
文章目录
前言
官方文档:
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.profiles.active
为空时,对应的连接符-
也将不存在,dataId 的拼接格式变成${prefix}.${file-extension}
file-exetension
为配置内容的数据格式,可以通过配置项spring.cloud.nacos.config.file-extension
来配置。目前只支持properties
和yaml
类型。
具体配置如下图所示:
dataid 为 nacos-config-client-dev.yaml
另外,通过 Spring Cloud 原生注解 @RefreshScope
实现配置自动更新;
2.2 nacos增加配置
点击+添加, 本文以YAML格式为例
按照规则填写Data ID,
Group目前用默认的,后面会介绍。
配置格式选择YAML,
配置内容得是YAML格式,空格没有控制好的话会读取不到配置信息。建议在IDEA里面编辑好后,复制回来。
点击发布即可;
2.3 代码实战
新建项目cloudalibaba-config-nacos-client3377
-
pom.xml
<!--nacos-config--> <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优先级高于applicationserver: 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
结果访问成功
nacos中编辑配置文件内容 version=2,再次访问接口
自动刷新成功。非常牛皮,比springcloud config方便多了
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
Note | 该配置必须放在 bootstrap.properties 文件中。此外 spring.cloud.nacos.config.namespace 的值是 namespace 对应的 id,id 值可以在 Nacos 的控制台获取。并且在添加配置时注意不要选择其他的 namespae,否则将会导致读取不到正确的配置。 |
---|---|
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
Note | 该配置必须放在 bootstrap.properties 文件中。并且在添加配置时 Group 的值一定要和 spring.cloud.nacos.config.group 的配置值一致。 |
---|---|
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
借助克隆功能;克隆成功后修改内容;
-
项目中通过spring.profiles.active属性进行多环境下配置文件的读取
spring: profiles: #active: dev active: test
重启项目,浏览器访问 http://localhost:3377/config/info
3.3.2 Group 方案
- 默认命名空间,相同的Data ID,新增一个Group
- 项目中配置
-
测试
重启项目,浏览器访问 http://localhost:3377/config/info
得到的是GG_GROUP下的配置文件;
3.3.2 NameSpace 方案
- 新建命名空间+相同的Group+相同的DataID
克隆配置,或者上方切换到dev命名空间后新增
添加成功后,修改内容
- 项目中配置namespace的id
-
测试
重启项目,浏览器访问 http://localhost:3377/config/info
可见namespace > Group > DataID
点赞+评论+关注
本文源码地址: https://gitee.com/shuaidawang/SpringCloudDemo.git
有错误的地方欢迎指正!可以加入qq交流群: 700637673