大家好，我是君哥。

最近在使用 Nacos 過(guò)程中遇到一個(gè)場(chǎng)景，配置的字符串可以解析成 Map 類(lèi)型使用，有一個(gè)配置如下：

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

后來(lái)有同事建議 Nacos 可以直接配置成 Map 類(lèi)型，后臺(tái)使用 Java Map 類(lèi)型獲取就可以。配置如下：

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

下面就來(lái)分享一下配置 Map 類(lèi)型的過(guò)程中遇到的問(wèn)題。

1.使用 Bean 方式獲取配置

1.1 使用方式

參考網(wǎng)上的一些案例，第一個(gè)方式是把讀取到的 Map 作為一個(gè) Spring 的 Bean，一看代碼就明白了。

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

1.2 槽點(diǎn)

這樣確實(shí)可以把 Nacos 中讀取到的配置轉(zhuǎn)換成 Map 類(lèi)型，但一個(gè)致命的槽點(diǎn)就是 mapping 這個(gè) bean 不能自動(dòng)刷新。這樣如果修改了 Nacos 中配置，要想讓配置生效，就必須重啟應(yīng)用服務(wù)，這怎么能接受呢?

2.ConfigurationProperties

2.1 使用方式

直接使用 @Value 和 @NacosValue 是獲取不到值的。下面的這種方式，類(lèi)的定義上加注解 @ConfigurationProperties，再定義一個(gè)變量，名稱(chēng)跟 Nacos 中配置的后綴一樣，這樣是可以獲取到 Map 類(lèi)型的配置的。

@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 槽點(diǎn)

這樣確實(shí)可以把 Nacos 中讀取到的配置轉(zhuǎn)換成 Map 類(lèi)型，但是跟第一種方式一樣，定義的 Map 類(lèi)型變量不能自動(dòng)刷新。

3.使用監(jiān)聽(tīng)

Nacos API 提供了監(jiān)聽(tīng)功能，可以監(jiān)聽(tīng)配置的變化，對(duì)變化進(jìn)行處理，只要在監(jiān)聽(tīng)方法上增加 @NacosConfigListener 這個(gè)注解就可以生效。見(jiàn)下面代碼：

@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 類(lèi)型的配置，然后把配置 put 到本地變量 map。這個(gè)也可以完成我們的需求，但是有幾點(diǎn)需要注意。

3.1 服務(wù)重啟

如果服務(wù)重啟了，本地變量 map 拉不到值。因?yàn)樯厦姹O(jiān)聽(tīng)的邏輯并沒(méi)有走，即使在 Nacos 上重新發(fā)布一下，也不行。

上面的監(jiān)聽(tīng)方法，只有在 Nacos 配置發(fā)生變化并且發(fā)布后才會(huì)觸發(fā)，比如 map.test 配置改變?nèi)缦拢?/p>

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

3.2 并發(fā)問(wèn)題

上面監(jiān)聽(tīng)的代碼里面，需要把本地變量 map 先 clear 然后再 putAll，如果這兩個(gè)方法調(diào)用中間發(fā)生了線(xiàn)程上下文切換，讀取線(xiàn)程可能會(huì)因?yàn)閺?map 中取不到值而發(fā)生異常。

4.改進(jìn)

上面講解了使用 Nacos 配置 Map 類(lèi)型的坑，不過(guò)使用 Nacos 配置 Map 類(lèi)型也有個(gè)好處，不用解析字符串，直接可以轉(zhuǎn)成 Map 類(lèi)型。

4.1 使用字符串

完全不使用 Map 類(lèi)型了，改成配置字符串，配置如下：

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;
}

這種寫(xiě)法的好處是不用監(jiān)聽(tīng) Nacos，配置改變后 mapTest 變量自動(dòng)刷新，缺點(diǎn)是每次調(diào)用 get 方法都需要解析 mapTest 這個(gè)字符串。

4.2 刷新本地 Map

把解析字符串的結(jié)果放到本地變量 map 上，考慮到 Nacos 中配置可能會(huì)發(fā)生變化，用定時(shí)線(xiàn)程池每 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]);
    }
}

這個(gè)寫(xiě)法的好處是不用每次調(diào)用都解析字符串，而是由異步線(xiàn)程每秒鐘刷新。但是也有兩個(gè)問(wèn)題：

• 需要一個(gè)定時(shí)線(xiàn)程池，會(huì)消耗 CPU 資源。
• refresh 方法是每秒執(zhí)行一次，會(huì)有短暫的本地變量和 Nacos 配置不一致的問(wèn)題。

5.總結(jié)

Nacos 中配置 Map 類(lèi)型確實(shí)不香，主要原因是刷新不方便。但是對(duì)于配置不需要刷新的場(chǎng)景，還是很有好處的，尤其是 key 比較多的時(shí)候，比解析字符串方便很多，而且 Hash 的時(shí)間復(fù)雜度是 o(1) ，在數(shù)據(jù)結(jié)構(gòu)中是最優(yōu)秀的。

對(duì)于需要刷新的場(chǎng)景，無(wú)論使用哪種方案，都有優(yōu)缺點(diǎn)，沒(méi)有最好的，只有最適合的，要根據(jù)系統(tǒng)的業(yè)務(wù)場(chǎng)景來(lái)做選擇。