Nacos 中配置 Map 类型,不香!

本文涉及的产品
云解析 DNS,旗舰版 1个月
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: Nacos 中配置 Map 类型,不香!

大家好,我是君哥。


最近在使用 Nacos 过程中遇到一个场景,配置的字符串可以解析成 Map 类型使用,有一个配置如下:

map:
  test: key1:value1,key2:value2,key3:value3


后来有同事建议 Nacos 可以直接配置成 Map 类型,后台使用 Java Map 类型获取就可以。配置如下:

map:
  test:
    key1: value1
    key2: value2
    key3: value3


下面就来分享一下配置 Map 类型的过程中遇到的问题。

1 使用 Bean 方式获取配置

1.1 使用方式

参考网上的一些案例,第一个方式是把读取到的 Map 作为一个 Spring 的 Bean,一看代码就明白了。

@Bean
@ConfigurationProperties(prefix = "map.test")
public Map<String, String> mapping() {
    return new HashMap<>();
}

1.2 槽点

这样确实可以把 Nacos 中读取到的配置转换成 Map 类型,但一个致命的槽点就是 mapping 这个 bean 不能自动刷新。这样如果修改了 Nacos 中配置,要想让配置生效,就必须重启应用服务,这怎么能接受呢?

2 ConfigurationProperties

2.1 使用方式

直接使用 @Value 和 @NacosValue 是获取不到值的。下面的这种方式,类的定义上加注解 @ConfigurationProperties,再定义一个变量,名称跟 Nacos 中配置的后缀一样,这样是可以获取到 Map 类型的配置的。

@Component
@RefreshScope
@ConfigurationProperties(prefix = "map")
public class NacosRefresh {
    private Logger logger = LoggerFactory.getLogger(getClass());
    public void setTest(Map<String, String> test) {
        this.test = test;
    }
    private Map<String, String> test;
}

注意:上面的 setTest 方法是必须要的,不然 test 变量取不到值。

2.2 槽点

这样确实可以把 Nacos 中读取到的配置转换成 Map 类型,但是跟第一种方式一样,定义的 Map 类型变量不能自动刷新。

3 使用监听

Nacos API 提供了监听功能,可以监听配置的变化,对变化进行处理,只要在监听方法上增加 @NacosConfigListener 这个注解就可以生效。见下面代码:

@Service
public class NacosListener {
    private Logger logger = LoggerFactory.getLogger(getClass());
    private Map<String, String> map = new HashMap<>();
    @NacosConfigListener(dataId = "maptest.yaml",groupId = "DEFAULT_GROUP")
    public void listener(String context){
        logger.info("================listener context:{}", context);
        if (StringUtils.isBlank(context)){
            return;
        }
        Yaml yaml = new Yaml();
        Map<String, Object> contextMap = yaml.load(context);
        Map<String, Object> map = (Map<String, Object>)contextMap.get("map");
        if (CollectionUtils.isEmpty(map)){
            return;
        }
        Map<String, String> test = (Map<String, String>) map.get("test");
        if (CollectionUtils.isEmpty(test)){
            return;
        }
        map.clear();
        map.putAll(test);
        map.forEach((k,v) -> logger.info("Entry in map, key:{},value:{}", k, v));
    }
}


这段代码是从 Nacos 配置中解析出 Map 类型的配置,然后把配置 put 到本地变量 map。这个也可以完成我们的需求,但是有几点需要注意。

3.1 服务重启

如果服务重启了,本地变量 map 拉不到值。因为上面监听的逻辑并没有走,即使在 Nacos 上重新发布一下,也不行。

微信图片_20221213112034.jpg

上面的监听方法,只有在 Nacos 配置发生变化并且发布后才会触发,比如 map.test 配置改变如下:

map:
  test:
    key1: value1
    key2: value2
    key3: value3
    key4: value4

3.2 并发问题

上面监听的代码里面,需要把本地变量 map 先 clear 然后再 putAll,如果这两个方法调用中间发生了线程上下文切换,读取线程可能会因为从 map 中取不到值而发生异常。

4 改进

上面讲解了使用 Nacos 配置 Map 类型的坑,不过使用 Nacos 配置 Map 类型也有个好处,不用解析字符串,直接可以转成 Map 类型。

4.1 使用字符串

完全不使用 Map 类型了,改成配置字符串,配置如下:

map:
  test: key1:value1,key2:value2,key3:value3


解析代码如下:

@NacosValue(value = "${map.test}", autoRefreshed = true)
private String mapTest;
public String get(String key){
    String[] keys = mapTest.split(",");
    for (String item : keys){
        if (!item.contains(key)){
            continue;
        }
        return item.split(":")[1];
    }
    return null;
}


这种写法的好处是不用监听 Nacos,配置改变后 mapTest 变量自动刷新,缺点是每次调用 get 方法都需要解析 mapTest 这个字符串。

4.2 刷新本地 Map

把解析字符串的结果放到本地变量 map 上,考虑到 Nacos 中配置可能会发生变化,用定时线程池每 1 秒刷新一次,代码如下:

private Map<String, String> map = new HashMap<>();
@NacosValue(value = "${map.test}", autoRefreshed = true)
private String mapTest;
@PostConstruct
public void refreshLocalMap(){
    ScheduledThreadPoolExecutor scheduled = new ScheduledThreadPoolExecutor(1);
    scheduled.scheduleAtFixedRate(() -> refresh(), 0, 1000, TimeUnit.MILLISECONDS);
}
public void refresh(){
    String[] keys = mapTest.split(",");
    for (String item : keys){
        String[] kv = item.split(":");
        map.put(kv[0], kv[1]);
    }
}


这个写法的好处是不用每次调用都解析字符串,而是由异步线程每秒钟刷新。但是也有两个问题:

  • 需要一个定时线程池,会消耗 CPU 资源。
  • refresh 方法是每秒执行一次,会有短暂的本地变量和 Nacos 配置不一致的问题。

5 总结

Nacos 中配置 Map 类型确实不香,主要原因是刷新不方便。但是对于配置不需要刷新的场景,还是很有好处的,尤其是 key 比较多的时候,比解析字符串方便很多,而且 Hash 的时间复杂度是 o(1) ,在数据结构中是最优秀的。


对于需要刷新的场景,无论使用哪种方案,都有优缺点,没有最好的,只有最适合的,要根据系统的业务场景来做选择。


相关文章
|
1月前
|
负载均衡 Java Nacos
SpringCloud基础2——Nacos配置、Feign、Gateway
nacos配置管理、Feign远程调用、Gateway服务网关
SpringCloud基础2——Nacos配置、Feign、Gateway
|
2月前
|
安全 Nacos 数据安全/隐私保护
升级指南:从Nacos 1.3.0 到 2.3.0,并兼容 Seata 的鉴权配置
本文详细介绍了如何在微服务环境下从 Nacos 1.3.0 升级到 2.3.0,并确保 Seata 各版本的兼容性。作者小米分享了升级过程中的关键步骤,包括备份配置、更新鉴权信息及验证测试等,并解答了常见问题。通过这些步骤,可以帮助读者顺利完成升级并提高系统的安全性与一致性。
96 8
升级指南:从Nacos 1.3.0 到 2.3.0,并兼容 Seata 的鉴权配置
|
2月前
|
运维 Java Nacos
Spring Cloud应用框架:Nacos作为服务注册中心和配置中心
Spring Cloud应用框架:Nacos作为服务注册中心和配置中心
|
2月前
|
应用服务中间件 Nacos 数据库
Nacos 1.2.1 集群搭建(三) Nginx 配置 集群
Nacos 1.2.1 集群搭建(三) Nginx 配置 集群
58 1
|
2月前
|
缓存 Cloud Native Java
【紧急救援】Nacos配置上线后失效?手把手教你如何轻松搞定命名空间修改难题!
【8月更文挑战第15天】Nacos是关键的云原生服务管理平台,用于动态服务发现与配置管理。但在使用其管理微服务配置时,可能会遇到命名空间内的配置更新后不生效的问题。本文探讨此问题并提供解决方案。首先需确认Nacos服务器运行正常及客户端正确连接。接着检查客户端缓存配置,可通过禁用缓存或缩短缓存间隔来即时更新配置。例如,在Spring Cloud Alibaba Nacos配置中心中启用自动刷新功能,并设置每5秒拉取新配置。同时,对于新增配置项,需重启客户端应用。还需检查Nacos服务器日志排除异常,并考虑升级Nacos版本解决兼容性问题。通过这些步骤,通常可有效解决配置不生效的难题。
133 0
|
2月前
|
安全 Nacos 数据库
【技术安全大揭秘】Nacos暴露公网后被非法访问?!6大安全加固秘籍,手把手教你如何保护数据库免遭恶意篡改,打造坚不可摧的微服务注册与配置中心!从限制公网访问到启用访问控制,全方位解析如何构建安全防护体系,让您从此告别数据安全风险!
【8月更文挑战第15天】Nacos是一款广受好评的微服务注册与配置中心,但其公网暴露可能引发数据库被非法访问甚至篡改的安全隐患。本文剖析此问题并提供解决方案,包括限制公网访问、启用HTTPS、加强数据库安全、配置访问控制及监控等,帮助开发者确保服务安全稳定运行。
192 0
|
2月前
|
安全 Nacos 数据安全/隐私保护
【技术干货】破解Nacos安全隐患:连接用户名与密码明文传输!掌握HTTPS、JWT与OAuth2.0加密秘籍,打造坚不可摧的微服务注册与配置中心!从原理到实践,全方位解析如何构建安全防护体系,让您从此告别数据泄露风险!
【8月更文挑战第15天】Nacos是一款广受好评的微服务注册与配置中心,但其连接用户名和密码的明文传输成为安全隐患。本文探讨加密策略提升安全性。首先介绍明文传输风险,随后对比三种加密方案:HTTPS简化数据保护;JWT令牌减少凭证传输,适配分布式环境;OAuth2.0增强安全,支持多授权模式。每种方案各有千秋,开发者需根据具体需求选择最佳实践,确保服务安全稳定运行。
217 0
|
1月前
|
Go 定位技术 索引
Go 语言Map(集合) | 19
Go 语言Map(集合) | 19
|
1月前
|
存储 前端开发 API
ES6的Set和Map你都知道吗?一文了解集合和字典在前端中的应用
该文章详细介绍了ES6中Set和Map数据结构的特性和使用方法,并探讨了它们在前端开发中的具体应用,包括如何利用这些数据结构来解决常见的编程问题。
ES6的Set和Map你都知道吗?一文了解集合和字典在前端中的应用
|
18天前
|
存储 分布式计算 Java
Stream很好,Map很酷,但答应我别用toMap():Java开发中的高效集合操作
在Java的世界里,Stream API和Map集合无疑是两大强大的工具,它们极大地简化了数据处理和集合操作的复杂度。然而,在享受这些便利的同时,我们也应当警惕一些潜在的陷阱,尤其是当Stream与Map结合使用时。本文将深入探讨Stream与Map的优雅用法,并特别指出在使用toMap()方法时需要注意的问题,旨在帮助大家在工作中更高效、更安全地使用这些技术。
28 0