【Spring Cloud】Nacos作为配置中心，如何配置？

悠悠 2022-12-01 15:50 202阅读 0赞

#### 引言 ####

继续Nacos的学习，在上篇博客中，我们知道了[Nacos安装、下载及作为注册中心的使用][Nacos]，本篇博客介绍的内容是Nacos作为配置中心，我们如何读取、修改配置等。

#### 配置流程 ####

**1. 引入依赖**

<dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        <version>2.1.0.RELEASE</version>
    </dependency>

关于版本，官网上有作说明：版本 2.1.x.RELEASE 对应的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 对应的是 Spring Boot 2.0.x 版本，版本 1.5.x.RELEASE 对应的是 Spring Boot 1.5.x 版本。

**2. 在bootstrap.properties中配置 Nacos server 的地址和应用名**

spring.cloud.nacos.config.server-addr=127.0.0.1:8848
    
    spring.application.name=example

说明：之所以需要配置 spring.application.name ，是因为它是构成 Nacos 配置管理 dataId字段的一部分。

在 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 的拼接格式变成  p r e f i x . \{prefix\}. prefix.\{file-extension\}
 *  file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

**3. 通过 Spring Cloud 原生注解 @RefreshScope 实现配置自动更新：**

/**
     * @Description : Nacos读取properties控制类
     * @Author : huzhiting
     * @Date: 2020-08-28 10:36
     */
    @RestController
    @RequestMapping("/config")
    @RefreshScope
    public class ConfigController {
    
        @Value("${useLocalCache}")
        private boolean useLocalCache;
    
    
        @RequestMapping("/get/cache")
        public boolean get() {
            return useLocalCache;
        }
    }

使用postman，通过调用Nacos Open API向Nacos发布配置：

http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example.properties&group=DEFAULT_GROUP&content=useLocalCache=true

**4. 运行 NacosConfigApplication，调用 http://localhost:8080/config/get/cache，返回内容是 true。**

**5. 再次调用 Nacos Open API 向 Nacos server 发布配置：dataId 为example.properties，内容为useLocalCache=false**

http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example.properties&group=DEFAULT_GROUP&content=useLocalCache=false

**6. 再次访问 http://localhost:8080/config/get/cache，此时返回内容为false，说明程序中的useLocalCache值已经被动态更新了。**

#### 问题再现 ####

*  **启动失败，NacosException：endpoint is blank**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70_pic_center]  
这是因为我刚开始并没有新建bootstrap.properties文件，nacos服务的地址直接配置在application.properties中，启动就会报错，所以 spring.cloud.nacos.config.server-addr=127.0.0.1:8848 这个配置必须在bootstrap.properties中。

*  **读取配置，获取不到最新的值**

我是按照官网上的步骤一步步配置的，使用的example.properties配置文件，项目启动成功后，在Nacos管理页面上也可以看到配置，如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70_pic_center 1]  
但我调用API之后，获取的值并不是最新的，也不清楚是什么问题，只是感觉是不是哪里配置理解的有出入。

我又新建了一个工程，使用的是yaml格式的配置文件，相关配置也重新写了：

bootstrap.yaml配置文件中配置了Nacos服务和配置文件的扩展名类型：

spring:
      cloud:
        nacos:
          config:
            server-addr: 127.0.0.1:8848
            file-extension: yaml

application.yaml配置文件中配置了应用名和端口：

spring:
      application:
        name: nacos_config_test
    server:
      port: 9002

这次我是使用管理页面增加的配置，也就是第二个nacos\_config\_test：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70_pic_center 2]  
试了一下读取值，还是不能读取，查了些文章，发现是Data Id的问题，没有指定yaml格式，于是增加了第三个配置，最终获取值成功了。

工程里的配置和Nacos管理上的配置的关系也明确了，又改了改第一个使用properties配置文件格式的工程，调用相关的API，也可以读取到最新的配置了。

#### 总结 ####

有了配置中心，我们管理配置也变得简单了。看着官网的介绍，整个过程挺简单的，但是自己使用，也会遇到这样那样的问题，总结下来，或许以后就能用的上。[properties和yaml两种格式的配置文件工程代码][properties_yaml]已同步更新至github。

[Nacos]: https://blog.csdn.net/hu_zhiting/article/details/108168549
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/ce787ec1eba04c5182439189f96f1da9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/bea2c7e0e1a44b65a5a90d04bb6aa1c1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/ec3923ed74df4025ac28c001c70c9f36.png
[properties_yaml]: https://github.com/huzhiting/spring-cloud.git