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

目标

• 数据同步原理分析
• 动态数据流示意
• 源码解析

数据同步原理分析

在1.x版本中,配置服务依赖zk实现,管理将变更信息push给网关。而2.x版本支websocket、http、zk、nacos,通过soul.sync.strategy 指定对应的同步策略,默认使websocket同步策略,可以做到秒级数据同步,但是soul-admin与soul-bootstrap必须使用相同的同步策略。

soul-admin 在用户发生配置变更之后,会通过EventPublisher发出配置变更通知,由EventDispatcher处理该变更通知。然后根据配置的同步策略(http、websocket、zk、nacos)，将配置发送到对应的事件处理器上。本次分析的是websocket,则将变更数据主动推送到soul-bootstrap,并且在网关层会有WebSocketDataChangedListener来处理admin的数据推送

image

动态数据流示意

image.png

从上图可以看出几个关键的类 DataChangeEvent(发送事件数据载体)，ApplicationListener(Interface to be implemented by application event listeners.)，DataChangedListener(监听器接口)

源码解析

soul-admin 数据发生改变发送数据变更通知

这里我是用Selector来进行模拟

// 选择器变更发送事件,事件类型统一封装在DataChangeEvent对象
private void publishEvent(final SelectorDO selectorDO, final List selectorConditionDTOs) {
    PluginDO pluginDO = pluginMapper.selectById(selectorDO.getPluginId());
    List conditionDataList =
            selectorConditionDTOs.stream().map(ConditionTransfer.INSTANCE::mapToSelectorDTO).collect(Collectors.toList());
    // publish change event.发送 DataChangeEvent类封装的事件包,而我们看DataChangedEvent也是实现 ApplicationEvent
    eventPublisher.publishEvent(new DataChangedEvent(ConfigGroupEnum.SELECTOR, DataEventTypeEnum.UPDATE,
            Collections.singletonList(SelectorDO.transFrom(selectorDO, pluginDO.getName(), conditionDataList))));
}

DataChangedEventDispatcher 接收到事件

接收到ApplicationEventPublisher发送来的事件之后触发onApplicationEvent执行,拿着event.getGroupKey进行比对从listener中找到匹配的事件处理函数,这里面使用了策略模式,动态根据事件类型匹配对应的处理事件。

image.png

InitializingBean获取listeners

此处源码地方有可以优化的地方，因为soul默认数据同步方式只允许有一种,所以这里无需使用list,可以根据用户当前配置的方式进行定位出最终的listener.这样在事件分发器那块就无需for循环处理了。

image.png

WebSocketClient 处理事件消息

image.png

总结

到这里从用户改变数据,到事件通知,然后通过websocket将数据发送到soul网关端,至于数据到网关端处理逻辑,下一章再详细分析。

参考

soul github
soul document