SpringCloud Alibaba - Nacos 作为配置中心 & 读取Yaml配置信息

末蓝、 2021-06-10 20:39 502阅读 0赞

过本系列的前篇文章：

*  [《SpringCloud Alibaba - Nacos 作为配置中心 & 读取Properties配置信息》][SpringCloud Alibaba - Nacos _ _ _Properties]

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

### 本章目标 ###

`Nacos Config`所支持的配置文件类型既然有多种，那我们该怎么配置才能读取不同的配置类型的内容呢？

### 快速入门 ###

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

Nacos Server

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

创建配置

配置信息如下所示：  
![710ec49ff641378af647785127cdeba5.png][]

创建应用

我们在`Nacos Console`已经添加了本章所使用的`Yaml`类型的配置信息，下面通过`Idea`开发工具创建一个`SpringBoot`项目，并添加`SpringCloud Alibaba`、`SpringCloud`版本的依赖，`pom.xml`配置文件内容如下所示：

1.  `//...`
2.  `<properties>`
3.  `<java.version>1.8</java.version>`
4.  `<spring-cloud.version>Greenwich.RELEASE</spring-cloud.version>`
5.  `<spring-cloud-alibaba.version>0.2.1.RELEASE</spring-cloud-alibaba.version>`
6.  `</properties>`
7.   
8.  `<dependencies>`
9.  `<dependency>`
10. `<groupId>org.springframework.boot</groupId>`
11. `<artifactId>spring-boot-starter-web</artifactId>`
12. `</dependency>`
13. ``
14. `<dependency>`
15. `<groupId>org.springframework.cloud</groupId>`
16. `<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>`
17. `</dependency>`
18. `</dependencies>`
19.  
20. `<dependencyManagement>`
21. `<dependencies>`
22. ``
23. `<dependency>`
24. `<groupId>org.springframework.cloud</groupId>`
25. `<artifactId>spring-cloud-dependencies</artifactId>`
26. `<version>${spring-cloud.version}</version>`
27. `<type>pom</type>`
28. `<scope>import</scope>`
29. `</dependency>`
30. ``
31. `<dependency>`
32. `<groupId>org.springframework.cloud</groupId>`
33. `<artifactId>spring-cloud-alibaba-dependencies</artifactId>`
34. `<version>${spring-cloud-alibaba.version}</version>`
35. `<type>pom</type>`
36. `<scope>import</scope>`
37. `</dependency>`
38. `</dependencies>`
39. `</dependencyManagement>`
40. `//...`

配置文件扩展名

在之前讲到过默认的配置文件扩展名为`properties`，既然我们本章是读取的`yaml`类型的文件，那肯定需要修改这个配置参数，`application.yml`配置文件如下所示：

1.  `spring:`
2.  `application:`
3.  `name: hengboy-spring-cloud`
4.  `# nacos config`
5.  `cloud:`
6.  `nacos:`
7.  `config:`
8.  `server-addr: 127.0.0.1:8848`
9.  `# 配置文件后缀名为yaml`
10. `file-extension: yaml`

通过`spring.cloud.nacos.config.file-extension`参数进行修改默认的`Nacos Config`所匹配的默认文件扩展名。

> 在上面的配置文件内要注意的时，`hengboy-spring-cloud`要与`Nacos Console`内添加的配置`data-id`前部分匹配，也就是匹配：`hengboy-spring-cloud.yaml`。

读取配置

下面我们通过简单的几个步骤来读取我们配置的`yaml`配置内容。

**第一步：创建一个配置读取的`Controller`**

创建一个名为`ConfigController`的配置查询控制器，并且类上配置`@RequestMapping("/config")`。

**第二步：通过@Value注解读取配置信息**

我们在之前章节通过`applicationContext#getEnvironment#getProperty`方法可以直接获取对应的`Nacos Config`的配置信息，当然`SpringCloud Alibaba`也同样支持通过`@Value`注解来获取配置信息，如下所示：

1.  `@RestController`
2.  `@RequestMapping(value = "/config")`
3.  `@RefreshScope`
4.  `public class ConfigController {`
5.  `/**`
6.  `* 读取hengboy.name配置信息`
7.  `*/`
8.  `@Value(value = "${hengboy.name:}")`
9.  `private String userName;`
10. `/**`
11. `* 读取hengboy.age配置信息`
12. `*/`
13. `@Value(value = "${hengboy.age:}")`
14. `private String userAge;`
15.  
16. `/**`
17. `* 获取配置内容`
18. `*`
19. `* @return`
20. `*/`
21. `@RequestMapping(value = "/get")`
22. `public String getConfig() {`
23. `return userName + ":" + userAge;`
24. `}`
25.  
26. `}`

> 解释：`${hengboy.name:}`表示需要从全局的配置内容中读取`hengboy.name`的配置信息，如果没有找到则使用 `冒号（:）` 后的内容，当然这里我们没有添加任何的默认值，如果没有配置则为`空字符串`。

**第三步：通过@RefreshScope注解实时刷新配置信息**  
我们在`ConfigController`控制器上添加了注解`@RefreshScope`主要目的是来实时同步通过`Nacos Console`修改的配置内容。

`@RefreshScope`注解是`SpringCloud`内部提供，用于`配置热加载`。

**第四步：运行测试**

启动应用程序，我们通过`curl http://localhost:8080/config/get`可以获取我们在`Nacos Console`添加的配置内容：`admin:25`

**第五步：实时更新测试**

通过`Nacos Console`我们修改下两个参数的内容并且`重新发布配置信息`：

1.  `hengboy.name : admin -> admin-change-after`
2.  `hegnboy.age : 25 -> 30`

再次通过`curl http://localhost:8080/config/get`命令访问，我们已经可以得到更新后的配置内容：`admin-change-after:30`

### 代码示例 ###

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

*  Github：[https://github.com/hengboy/spring-cloud-chapter][https_github.com_hengboy_spring-cloud-chapter]
 *  Gitee：[https://gitee.com/hengboy/spring-cloud-chapter][https_gitee.com_hengboy_spring-cloud-chapter]

### 开源信息 ###

*  MicroJob  
    micro-job是一款分布式任务调度执行框架，用于集群环境负载均衡条件下的任务分发以及任务消费

任务消费者节点定义任务 & 任务自动上报  
任务调度器自动根据负载均衡策略来选择不同的消费者节点进行任务消费

[SpringCloud Alibaba - Nacos _ _ _Properties]: https://www.jianshu.com/u/092df3f77bca
[Nacos]: https://nacos.io/zh-cn/docs/quick-start.html
[710ec49ff641378af647785127cdeba5.png]: /images/20210527/7974a15b55004814bfed111dedf72081.png
[https_github.com_hengboy_spring-cloud-chapter]: https://github.com/hengboy/spring-cloud-chapter
[https_gitee.com_hengboy_spring-cloud-chapter]: https://gitee.com/hengboy/spring-cloud-chapter