Java - 利用Nacos做一个动态开关配置功能

前言

我公司里有一个Config配置功能（我相信这是很普遍的一个功能）。简单来说就是：

• 将相关的键值对放到这个Config配置系统里面。
• 代码里通过这个Config配置系统的相关API，根据对应的Key拿到配置的值。在进行逻辑操作。

那么这个有啥好处呢？

1. 我们将我们的代码发布到生产环境，往往是需要一定的流程的。可能耗时比较长。而Config配置系统的发布则非常简单。页面上点一下即可。
2. 假如我们有一个场景：一个新老接口的替换。那么我们可以在代码里面加一个“开关”，如果为T，走新接口，如果为F，则走老接口。那么当生产上新接口出现问题的时候，我们就可以通过改变Config配置系统中的开关值为F。这样就可以在不发布代码的情况下，动态地改变程序地运行逻辑。
3. Config配置系统除了可以用作开关的功能以外。还有个重要的功能就如其名，配置系统，我们可以通过这个系统动态地设置相关配置。
4. 开关同样支持分环境、分Group等操作。

自己最近也在复习微服务这块的知识。自然而然地用到了Nacos。那么Nacos不就是一个天生的配置系统吗？因此准备在其基础上稍微写个工具类，达到模拟Config配置系统的功能。

一. Nacos配置类编写

我们知道Nacos的加载需要几个属性：

• server-addr：服务地址。
• namespace：命名空间。
• group：组的名称。

如图：

前提：你的application.yml或者bootstrap.yml文件里面有对应的配置。

1.我们先写一个配置类，自定义我们的名称ZKNacosProperties

@Data
@Component
@ConfigurationProperties(prefix = "kz.nacos")
public class ZKNacosProperties {
    private String fileName;
    private Long timeout;
}

对应的application.properties文件

kz.nacos.file-name=kz-service-config.properties
kz.nacos.timeout=3000

2.NacosConfig配置类：

@Configuration
public class NacosConfig {
    @Value("${spring.cloud.nacos.discovery.server-addr}")
    private String serverAddr;
    @Value("${spring.cloud.nacos.config.namespace}")
    private String namespace;
    @Value("${spring.application.name}")
    private String group;
    @Autowired
    private ThreadPoolExecutor executor;
    @Autowired
    private ZKNacosProperties zkNacosProperties;

    @Bean
    @RefreshScope
    public Map<String, String> zConfig() {
        HashMap<String, String> config = new HashMap<>();
        Properties properties = new Properties();
        properties.put(PropertyKeyConst.SERVER_ADDR, serverAddr);
        properties.put(PropertyKeyConst.NAMESPACE, namespace);
        ConfigService configService;
        try {
            configService = NacosFactory.createConfigService(properties);
            addListener(configService, config);
            String content = configService.getConfig(zkNacosProperties.getFileName(), group, zkNacosProperties.getTimeout());
            updateCache(content, config);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return config;
    }

    /**
     * Nacos在项目启动的时候，就会将配置进行读取，并起了一个线程 LongPollingRunnable
     * 用于感应Nacos端的配置变换
     * 这里用我们自定义的线程池做替换
     *
     * @param configService
     */
    private void addListener(ConfigService configService, Map<String, String> config) {
        try {
            if (configService != null) {
                configService.addListener(zkNacosProperties.getFileName(), group, new Listener() {
                    @Override
                    public Executor getExecutor() {
                        return executor;
                    }

                    @Override
                    public void receiveConfigInfo(String s) {
                    	// 更新我们的本地配置
                        updateCache(s, config);
                    }
                });
            }
        } catch (NacosException e) {
            e.printStackTrace();
        }
    }

    private void updateCache(String content, Map<String, String> config) {
        if (StringUtils.isBlank(content)) {
            return;
        }
        String key, value;
        // 拿到的content是一个完整的内容，我们一般是一行一个配置。这里按照行来分割
        String[] configs = content.split("\n");
        for (String c : configs) {
            String[] keyValue = c.split("=");
            key = keyValue[0];
            value = StringUtils.isNotBlank(keyValue[1]) ? keyValue[1] : "";
            config.put(key, value);
        }
    }
}

这里的自定义线程你可以去掉，也可以自己定义一个：

@Configuration
public class ThreadConfig {
    @Bean
    public ThreadPoolExecutor threadPoolExecutor() {
        return new ThreadPoolExecutor(2,
                4,
                3,
                TimeUnit.SECONDS,
                new LinkedBlockingDeque<>(100),
                Executors.defaultThreadFactory(),
                new ThreadPoolExecutor.AbortPolicy());
    }
}

3.自定义一个Config工具类：ZConfigUtil，用来访问配置。

@Component
public class ZConfigUtil {
    @Autowired
    private Map<String, String> zConfig;

    public String getValue(String key) {
        String res = "";
        if (StringUtils.isBlank(key)) {
            return res;
        }
        res = zConfig.get(key);
        return res;
    }
}

二. 测试

我Nacos中的配置文件内容：（记得保证你的命名空间、组都和你配置一致）

我的测试代码：

@GetMapping("/test")
@IgnoreCertification
public CommonReturnType getUser(@RequestParam("key") String key) {
    String value = zConfigUtill.getValue(key);
    return CommonReturnType.creat(value);
}

访问路径：localhost:8003/user/test?key=test ，如图：

如果我们在Nacos上添加一条配置然后保存：

可以看到监听器监听到了对应的变更事件：

所以我代码里面会对\n进行分割：

三. 展望

其实这个功能，Nacos本身已经支持了，或许还有别的方式可以直接获取相关的配置。只不过我这里自己又写了一个。核心的代码无非就是这段：

Properties properties = new Properties();
properties.put(PropertyKeyConst.SERVER_ADDR, serverAddr);
properties.put(PropertyKeyConst.NAMESPACE, namespace);
ConfigService configService;
try {
    configService = NacosFactory.createConfigService(properties);
    addListener(configService, config);
    String content = configService.getConfig(zkNacosProperties.getFileName(), group, zkNacosProperties.getTimeout());
    updateCache(content, config);
} catch (Exception e) {
    e.printStackTrace();
}

一般项目启动之后，Nacos的配置地址、相关的命名空间都是固定好的。实际开发过程中，文件名称、Key的值往往是可以改变的。无非就是将上面的代码改造一下而已。

剩余的就是看对NacosConfig上的内容如何做处理了。