Soul API网关源码解析09 - 数据同步篇

目标

• bootstrap zk客户端启动流程
• zk 如何接收数据变动
• 接收到数据变动之后的处理流程
• 总结

bootstrap端zk客户端启动流程

前面我们知道soul的各种插件启动基本流程是通过自定义starter启动,然后内部做一系列的依赖注入，zk Client 也不例外,下面就看看源码吧。

image.png

ZookeeperSyncDataConfiguration实例化

• SyncDataService Bean注入

image.png

通过代码我们可以看出来这里面也使用了Spring4.3新特性 ObjectProvider Bean依赖查找注入。确实经过debug 知道执行顺序是先执行了syncDataService,发现在构造器方式注入时候zkClient还未初始化,紧接着就执行了下面的zkClient注入。这里也就是初始化一个zk客户端。使用我们配置的zk客户端url还有会话超时时间和连接超时时间。

image.png

ZookeeperSyncDataService初始化

image.png

这里面主要就是全量给需要关心的节点增加watch机制。这里有个巧妙设计地方。因为zk的watch 触发完之后下次还要监听必须要再次设置watch,soul这边就每次触发数据变动，就先watch 然后在处理事件。

zk 如何接收数据变动

private void watcherPlugin(final String pluginName) {

    String pluginPath = ZkPathConstants.buildPluginPath(pluginName);

    if (!zkClient.exists(pluginPath)) {

        zkClient.createPersistent(pluginPath, true);

    }

    cachePluginData(zkClient.readData(pluginPath));

    // 这里就是绑定watch事件触发之后处理的方法

    subscribePluginDataChanges(pluginPath, pluginName);

}

通过zk的watcher机制，先将需要关注的节点绑定watcher,并指定执行方法

接收到数据变动之后的处理流程

image.png

handleDataChange 就是当watch触发时候 就会执行这里。前面分析过,websocket与subscribe绑定。所以这里面也一样，到这步后面就与websocket处理流程一样的了。

总结

到这里zk如何接收到数据同时如何保持watcher一直存在,并且如何更新对应关心数据的Plugin。我想经过两个同步类型工具流程分析，大家都清楚了吧。我再来总结下，admin 主要通过ApplicationEvent 发送数据变动事件，然后通过具体通信插件将数据告知网关端，网关通过订阅模式将信息告知对应关心数据的通信协议插件。

参考

soul github
soul document