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<T Extends ApplicationEvent>(Interface to be implemented by application event listeners.)，DataChangedListener(监听器接口)

源码解析

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

这里我是用Selector来进行模拟

// 选择器变更发送事件,事件类型统一封装在DataChangeEvent对象
private void publishEvent(final SelectorDO selectorDO, final List<SelectorConditionDTO> selectorConditionDTOs) {
    PluginDO pluginDO = pluginMapper.selectById(selectorDO.getPluginId());
    List<ConditionData> 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))));
}