四时宝库

程序员的知识宝库

Nacos配置管理简明教程(nacos 配置)

一、前言

在当前的项目开发中,经常会遇到业务变更的情况,比如:今天保留2为位小数,明天要保留4位小数、昨天刚说关闭某项检测,今天又说要打开。从配置式的角度来说,这些可以做成一个开关,需要时开启,不需要时就关闭。

常见的配置式,可以从数据库中、缓存中、文件中进行读取。我们目前适用的是yml配置的形式来进行管理,但是最近一些开关的频繁变动使得我们要积极寻求一个更加灵活和友好的解决方案。

二、Nacos配置管理

2.1、什么是Nacos配置管理

Nacos提供了动态管理配置服务,用户可以通过api调用和控制台操作进行实时服务应用配置的变更,让配置管理变得更加的灵活、高效、便捷。

2.2、配置管理的核心概念

信息来源于Nacos官网:https://nacos.io/zh-cn/docs/concepts.html

① 命名空间(namespace)

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

② 配置项(configuration item)

一个具体的可配置的参数与其值域,通常以 param-key=param-value 的形式存在。例如我们常配置系统的日志输出级别(logLevel=INFO|WARN|ERROR) 就是一个配置项。

③ 配置集(configuration set)

一组相关或者不相关的配置项的集合称为配置集。在系统中,一个配置文件通常就是一个配置集,包含了系统各个方面的配置。例如,一个配置集可能包含了数据源、线程池、日志级别等配置项。

④ 配置ID(data id)

Nacos 中的某个配置集的 ID。配置集 ID 是组织划分配置的维度之一。Data ID 通常用于组织划分系统的配置集。

一个系统或者应用可以包含多个配置集,每个配置集都可以被一个有意义的名称标识。Data ID 通常采用类 Java 包(如 com.taobao.tc.refund.log.level)的命名规则保证全局唯一性。此命名规则非强制。

⑤ 配置分组(group)

Nacos 中的一组配置集,是组织配置的维度之一。通过一个有意义的字符串(如 Buy 或 Trade )对配置集进行分组,从而区分 Data ID 相同的配置集。当您在 Nacos 上创建一个配置时,如果未填写配置分组的名称,则配置分组的名称默认采用DEFAULT_GROUP 。配置分组的常见场景:不同的应用或组件使用了相同的配置类型,如 database_url 配置和 MQ_topic 配置。



三、Nacos配置管理步骤(后端)

3.1、安装Nacos

可以参考我之前的文章:Nacos+Dubbo项目搭建简明教程

3.2、引入需要的Maven


        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>2.7.7</version>
        </dependency>

        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-registry-nacos</artifactId>
            <version>2.7.7</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba.boot</groupId>
            <artifactId>nacos-config-spring-boot-starter</artifactId>
            <version>0.2.7</version>
        </dependency>


3.3、启用配置服务

在项目的启动类中配置注解:NacosPropertySource 以启动配置服务

@NacosPropertySource(dataId = "guangmuhua_customer_web", autoRefreshed = true)

PS: 这里的dataId要后面我们控制台的配置一致,并设置自动更新

3.4、使用@NacosValue注解

不同于我们之前使用的@Value注解,这里我们使用@NacosValue


@NacosValue(value = "${useDeleted:false}", autoRefreshed = true)

private String useDeleted;


这里我们使用@NacosValue注解来引入userDeleted属性,并默认为false,为了更好的检测效果我们写一个测试类如下:


import com.alibaba.nacos.api.config.annotation.NacosValue;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RefreshScope
public class NacosConfigTest {

    @NacosValue(value = "${useDeleted:}", autoRefreshed = true)
    private String useDeleted;

    @GetMapping("/getNacosConfig")
    public String getNacosConfig() {
        return String.valueOf(useDeleted);
    }

}


四、Nacos控制台配置

4.1、新增一个配置项

控制台操作如下:



4.2、写入配置信息

控制台操作如下:


五、测试效果

5.1、程序默认效果

PS: 没有进行自定义配置时,默认为程序中的false

5.2、配置后的效果

PS: 通过Nacos控制台进行配置后,数据修改为我们定义的true

六、注意事项


① 在属性优先级上:yml文件总配置 > nacos控制台属性配置 > @NacosValue注解定义默认值

② 当yml文件中没有定义,且nacos没有属性配置时,@NacosValue注解或报错

③ 当属性配置不生效时,先检测maven依赖是否正确,如果还是出现问题就重启nacos服务

④ nacos属性配置可以通过api直接进行配置(一如前段时间的nacos通过api添加账户,然后登陆),做好安全处理


七、后记

这里只是简单记录下,Nacos配置管理的基础用法,当然也可以根据业务需要进行更复杂的namespace、groupId等参数的细化。

通过以上操作,我们就可以做到灵活、优雅的管理线上项目的一些开关操作。

更多精彩,请持续关注:guangmuhua.com

发表评论:

控制面板
您好,欢迎到访网站!
  查看权限
网站分类
最新留言
    友情链接