SpringCloud Alibaba - Nacos Config的多环境(Profile)配置信息读取

本章目标

读取Profile多环境下Nacos Config的配置信息,了解多环境下相同的配置优先级加载问题。

回顾

通过本系列的前篇文章:

在之前文章中我们学习到了SpringCloud Alibaba读取Nacos Config内定义的propertiesYaml类型的配置文件信息,并且使用Nacos Console进行修改配置信息后可以在应用程序内实时更新。

在我之前的SpringBoot系列教程中有提到Profile(多环境)相关的概念,有兴趣的同学可以去查看第三十八章:基于SpringBoot架构使用Profile完成打包环境分离文章,既然应用程序存在Profile分离的概念, Nacos Config同样为我们提供了这一概念,接下来我们来看看是如何进行Profile的配置信息切换使用优先级替换

快速入门

我们还是先来通过Nacos Console来添加本章所使用的配置信息,要注意配置的后缀名改为yaml

Nacos Server

需要在本地安装Nacos Server才能完成本章的内容讲解,具体的安装步骤访问Nacos 官方文档

添加配置

通过Nacos控制台添加本项目所使用的配置信息,之前又讲到过SpringCloud Alibaba默认使用spring.application.name作为DATA-ID,本章的spring.application.name = hengboy-spring-cloud-config-profile,所以我们添加如下两个配置信息:

  • hengboy-spring-cloud-config-profile.yaml

    这个配置是不参与任何profile环境的基础配置,其定位其实跟application.yml差不多。
  • hengboy-spring-cloud-config-profile-dev.yaml

    这个配置则是profile=dev环境的配置信息,其定位跟application-dev.yml差不多。

创建应用

通过idea开发工具来创建一个SpringCloud项目,并添加SpringCloud 版本依赖SpringCloud Alibaba 版本依赖pom.xml配置内容如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
//...
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.RELEASE</spring-cloud.version>
<spring-cloud-alibaba.version>0.2.1.RELEASE</spring-cloud-alibaba.version>
</properties>

<dependencies>
<!--spring cloud alibaba config-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>

<dependencyManagement>
<!--SpringCloud-->
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!--SpringCloud Alibaba-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>${spring-cloud-alibaba.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
//...

配置bootstrap.yml

之前有说过,SpringCloud Alibaba所需要的配置信息,需要在引导配置bootstrap.yml文件内添加,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# application name
spring:
application:
name: hengboy-spring-cloud-config-profile
# profile
profiles:
active: dev
# nacos config
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848
# nacos配置扩展类型为yaml
file-extension: yaml

我们本章用到的配置文件的格式为yaml所以需要通过spring.cloud.nacos.config.file-extension进行配置,该参数默认为properties

读取配置

我们创建一个SpringMvc Controller来读取配置信息,ConfigController如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//...
@RestController
@RequestMapping(value = "/config")
@RefreshScope
public class ConfigController {
/**
* 读取data-id对应的配置信息
*/
@Value(value = "${hengboy.name:}")
private String name;

@RequestMapping(value = "/get")
public String getConfig() {
return this.name;
}
}

如果对上面的@RefreshScope以及@Value使用方法不了解的同学可以去SpringCloud Alibaba - Nacos 作为配置中心 & 读取Yaml配置信息文章查看。

运行测试

通过Application方式启动应用程序后,打开终端访问通过如下命令行:

1
2
curl -X GET http://localhost:8080/config/get
输出内容:xxx-xxx-dev

看到输出内容你应该会感觉到不可思议,按照我们之前说的这里应该去找spring.application.name所对应的配置信息,也就是hengboy-spring-cloud-config-profile.yaml的配置信息,在上面步骤中我们在hengboy-spring-cloud-config-profile.yaml内添加的配置信息不是xxx-xxx-dev而是xxx-xxx-xx

多环境配置的优先级

上面出现的情况,其实一点也不奇怪,Nacos Config所被应用到SpringBootSpringCloud项目时,如果项目内存在Profile多环境的配置,就会自动去找spring.profile.actives所激活的profile配置文件,如下所示:

1
2
# 激活dev profile时
spring.profile.actives=dev -> hengboy-spring-cloud-config-profile-dev.yaml

我们激活spring.profile.actives=dev时,Nacos Config会自动去找两个配置文件,分别是:hengboy-spring-cloud-config-profile.yamlhengboy-spring-cloud-config-profile-dev.yaml

这也就对应上面说的application配置文件与Nacos Config配置文件的对应关系:

1
2
3
4
# 默认的配置
application.yml -> hengboy-spring-cloud-config-profile.yaml
# 激活profile=dev的配置
application-dev.yml -> hengboy-spring-cloud-config-profile-dev.yaml

我们之前在学习SpringBoot时讲到过,profile多环境下的配置如果与默认配置(application.yml)相同时会自动被覆盖掉,如下所示:

1
2
3
4
5
6
7
8
9
# application.yml
server:
port: 8000
spring:
profile:
actives: dev
# application-dev.yml
server:
port: 9000

根据上面的额配置的项目,在启动时会使用9000作为启动端口。

Nacos Config也是同样的概念设计,这一点可能是不想改变太多相关SpringBoot、SpringCloud的习惯,让开发者更方面的集成使用。

结论

根据上面的解释,我们在访问/config/get时你就明白为什么返回的是xxx-xxx-dev了。

代码示例

本章代码在源码的名称为:spring-cloud-alibaba-nacos-config-profile,在SpringCloud-Alibaba/Nacos-Config目录下。

开源信息

  • MicroJob
    micro-job是一款分布式任务调度执行框架,用于集群环境负载均衡条件下的任务分发以及任务消费
    任务消费者节点定义任务 & 任务自动上报
    任务调度器自动根据负载均衡策略来选择不同的消费者节点进行任务消费

    点击查看MicroJob官方文档

下面的内容你感兴趣吗?

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×