ajax同步-多图，5000 字分享，API 网关如何实现配置动态更新？

点击上方“芋道源码”，选择“”

做积极的人ajax同步，而不是积极废人！

源码精品专栏

前言

网关是流量请求的入口，在微服务架构中承担了非常重要的角色，网关高可用的重要性不言而喻。在使用网关的过程中，为了满足业务诉求，经常需要变更配置，比如流控规则、路由规则等等。因此，网关动态配置是保障网关高可用的重要因素。那么，Soul网关又是如何支持动态配置的呢?

使用过Soul的同学都知道，Soul的插件全都是热插拔的，并且所有插件的选择器、规则都是动态配置，立即生效，不需要重启服务。但是我们在使用Soul网关过程中，用户也反馈了不少问题

因此，我们对Soul进行了局部重构，历时两个月的版本迭代，我们发布了2.0版本

1.可能有人会问我，配置同步为什么不使用配置中心呢？

答：首先，引入配置中心，会增加很多额外的成本，不管是运维，而且会让Soul变得很重；另外，使用配置中心，数据格式不可控，不便于soul-admin进行配置管理。

2.可能还有人会问？动态配置更新？每次我查数据库，或者redis不就行了吗？拿到的就是最新的，哪里那么多事情呢？

答：soul作为网关，为了提供更高的响应速度，所有的配置都缓存在JVM的Hashmap中，每次请求都走的本地缓存，速度非常快。所以本文也可以理解为分布式环境中，内存同步的三种方式。

原理分析

先来张高清无码图，下图展示了Soul数据同步的流程，Soul网关在启动时，会从从配置服务同步配置数据，并且支持推拉模式获取配置变更信息，并且更新本地缓存。而管理员在管理后台，变更用户、规则、插件、流量配置，通过推拉模式将变更信息同步给Soul网关，具体是push模式，还是pull模式取决于配置。关于配置同步模块，其实是一个简版的配置中心。

Soul数据同步流程图

在1.x版本中，配置服务依赖zookeeper实现，管理后台将变更信息push给网关。而2.x版本支持webosocket、http、zookeeper，通过soul.sync.strategy指定对应的同步策略，默认使用http长轮询同步策略，可以做到秒级数据同步。但是，有一点需要注意的是，soul-web和soul-admin必须使用相同的同步机制。

如下图所示，soul-admin在用户发生配置变更之后，会通过EventPublisher发出配置变更通知，由EventDispatcher处理该变更通知，然后根据配置的同步策略(http、weboscket、zookeeper)，将配置发送给对应的事件处理器

zookeeper同步

基于 zookeeper 的同步原理很简单，主要是依赖zookeeper的 watch 机制，soul-web会监听配置的节点ajax同步，soul-admin在启动的时候，会将数据全量写入zookeeper，后续数据发生变更时，会增量更新zookeeper的节点，与此同时，soul-web会监听配置信息的节点，一旦有信息变更时，会更新本地缓存

zookeeper节点设计

soul将配置信息写到zookeeper节点，是通过精细设计的。

websocket同步

websocket和zookeeper机制有点类似，将网关与admin建立好websocket连接时，admin会推送一次全量数据，后续如果配置数据发生变更，则将增量数据通过websocket主动推送给soul-web

使用websocket同步的时候，特别要注意断线重连，也叫保持心跳。soul使用java-websocket这个第三方库来进行websocket连接。

public class WebsocketSyncCache extends WebsocketCacheHandler {
    /**
     * The Client.
     */
    private WebSocketClient client;

    public WebsocketSyncCache(final SoulConfig.WebsocketConfig websocketConfig) {
        ScheduledThreadPoolExecutor executor = new ScheduledThreadPoolExecutor(1,
                SoulThreadFactory.create("websocket-connect", true));
         client = new WebSocketClient(new URI(websocketConfig.getUrl())) {
                @Override
                public void onOpen(final ServerHandshake serverHandshake) {
                  //....
                }
                @Override
                public void onMessage(final String result) {
                  //....
                }    
            };
        //进行连接
        client.connectBlocking();
        //使用调度线程池进行断线重连，30秒进行一次
        executor.scheduleAtFixedRate(() -> {
            if (client != null && client.isClosed()) {
                    client.reconnectBlocking();
            }
        }, 10, 30, TimeUnit.SECONDS);
    }