【想进大厂还不会阅读源码】ShenYu源码-替换ZooKeeper客户端

相信大家碰到源码时经常无从下手🙃，不知道从哪开始阅读，面对大量代码晕头转向，索性就读不下去了，又浪费了一次提升自己的机会😭。

我认为有一种方法，可以解决大家的困扰！那就是通过阅读某一次开源的【commit】、【ISSUE】，从这个入口出发去阅读源码！！

至此，我们发现自己开始从大量堆砌的源码中脱离开来😀。豁然开朗，柳暗花明又一村🍀。

ShenYu是一个异步的，高性能的，跨语言的，响应式的 API 网关。有关ShenYu的介绍可以戳这。

一、前瞻

今天我们来攻克这一次开源提交：commit链接

本次commit的核心内容就在下图红框中，意思很清晰明了：替换当前的ZooKeeper客户端。

看看Magic Header是什么

Magic Header 通常指的是文件开头的一段特定字节序列，用来标识或确认文件的格式和类型。这些字节序列是预先定义的，不同的文件格式有不同的 Magic Header。操作系统和应用程序通过读取这些特定的字节序列来识别文件的格式，即使文件扩展名被更改或丢失。

简单来说就是用来标识文件。

我们先整体看下本次所有提交的内容，虽然看起来涉及了大量的模块、大量的代码，但核心其实就是红框对应的内容。既然是要替换当前的ZooKeeper客户端，那便是要新建Curator这个新的客户端，同时修改调用端的调用对象！

下面我们就来看看贡献者是怎么实现替换的！！同时上文提到并将数据保存在没有 magic header 的 zk 中，正确翻译应该是保存数据在zk时，不使用magic header来标识数据，那他又是怎么做的？？

二、探索

我们参照上图，先看下ZookeeperClient类，该类很显眼的引入了本次提交的主角CuratorFramework，ZookeeperClient封装了CuratorFramework作为ZooKeeper新的客户端。

public class ZookeeperClient {

    private static final Logger LOGGER = LoggerFactory.getLogger(ZookeeperClient.class);

    private final ZookeeperConfig config;

    private final CuratorFramework client;

    private final Map<String, CuratorCache> caches = new ConcurrentHashMap<>();

    public ZookeeperClient(final ZookeeperConfig zookeeperConfig) {
        this.config = zookeeperConfig;
        ExponentialBackoffRetry retryPolicy = new ExponentialBackoffRetry(config.getBaseSleepTimeMilliseconds(), config.getMaxRetries(), config.getMaxSleepTimeMilliseconds());

        CuratorFrameworkFactory.Builder builder = CuratorFrameworkFactory.builder()
                .connectString(config.getServerLists())
                .retryPolicy(retryPolicy)
                .connectionTimeoutMs(config.getConnectionTimeoutMilliseconds())
                .sessionTimeoutMs(config.getSessionTimeoutMilliseconds())
                .namespace(config.getNamespace());

        if (!StringUtils.isEmpty(config.getDigest())) {
            builder.authorization("digest", config.getDigest().getBytes(StandardCharsets.UTF_8));
        }

        this.client = builder.build();
    }

    /**
     * start.
     */
    public void start() {
        this.client.start();
        try {
            this.client.blockUntilConnected();
        } catch (InterruptedException e) {
            LOGGER.warn("Interrupted during zookeeper client starting.");
            Thread.currentThread().interrupt();
        }
    }
}

而ZookeeperInstanceRegisterRepository就是起到控制器的作用，把ZookeeperConfig类的配置注册到ZookeeperClient来初始化我们新的客户端。

我们在代码可以看到初始化方法init()。

@Join
public class ZookeeperInstanceRegisterRepository implements ShenyuInstanceRegisterRepository {

    private static final Logger LOGGER = LoggerFactory.getLogger(ZookeeperInstanceRegisterRepository.class);

    private ZookeeperClient client;

    private final Map<String, String> nodeDataMap = new HashMap<>();

    @Override
    public void init(final InstanceConfig config) {
        Properties props = config.getProps();
        int sessionTimeout = Integer.parseInt(props.getProperty("sessionTimeout", "3000"));
        int connectionTimeout = Integer.parseInt(props.getProperty("connectionTimeout", "3000"));

        int baseSleepTime = Integer.parseInt(props.getProperty("baseSleepTime", "1000"));
        int maxRetries = Integer.parseInt(props.getProperty("maxRetries", "3"));
        int maxSleepTime = Integer.parseInt(props.getProperty("maxSleepTime", String.valueOf(Integer.MAX_VALUE)));

        ZookeeperConfig zkConfig = new ZookeeperConfig(config.getServerLists());
        zkConfig.setBaseSleepTimeMilliseconds(baseSleepTime)
                .setMaxRetries(maxRetries)
                .setMaxSleepTimeMilliseconds(maxSleepTime)
                .setSessionTimeoutMilliseconds(sessionTimeout)
                .setConnectionTimeoutMilliseconds(connectionTimeout);

        String digest = props.getProperty("digest");
        if (!StringUtils.isEmpty(digest)) {
            zkConfig.setDigest(digest);
        }

        this.client = new ZookeeperClient(zkConfig);
        this.client.getClient().getConnectionStateListenable().addListener((c, newState) -> {
            if (newState == ConnectionState.RECONNECTED) {
                nodeDataMap.forEach((k, v) -> {
                    if (!client.isExist(k)) {
                        client.createOrUpdate(k, v, CreateMode.EPHEMERAL);
                        LOGGER.info("zookeeper client register instance success: {}", v);
                    }
                });
            }
        });

        client.start();
    }
}

替换客户端的操作其实不会太复杂，主要就是把所有旧的客户端入参修改为新的客户端对象，可以看下贡献者的提交代码。

我们打开commit链接指向的ISSUE

意思其实是旧的zkClient保存数据时默认会把magic header头信息插入到数据中，导致了我们的序列化数据失败。

而贡献者本次提交把客户端改为了Curator客户端，也就不会有上面插入magic header头信息的操作了。

创作不易，不妨点赞、收藏、关注支持一下，各位的支持就是我创作的最大动力❤️