Spring Cloud Zuul动态路由

1.动态路由实现原理剖析

     在介绍基于DB与事件刷新机制热修改Zuul映射规 则实战之前,很有必要讲一讲这部分路由加载以及刷新 的原理,因为实现动态路由就是要从此处入手,通过4个核心类来使读者掌握构建动态路由的原理,类之间依赖如图所示。
 
 
                                           Spring Cloud Zuul动态路由
DiscoveryClientRouteLocator:
 
顾名思义,此类是Zuul中对于路由配置信息读取与 新节点注册变更的操作类,本类依赖关系如图所示,部分重要源码如下:
Spring Cloud Zuul动态路由
Spring Cloud Zuul动态路由
      locateRoutes()方法继承自SimpleRouteLocator类并重写了规则,该方法主要的功能就是将配置文件中的映射规则信息包装成LinkedHashMap<String,ZuulRoute>,键String是路径path,值ZuulRoute是配置 文件的封装类,以往所见的配置映射读取进来就是使用 ZuulRoute来封装。refresh()实现自RefreshableRouteLocator接口,添加刷新功能必须要实 现此方法,doRefresh()方法来自SimpleRouteLocator 类。我们需要自定义路由配置加载器,以仿照它的实现。
 
SimpleRouteLocator:
    
    SimpleRouteLocatorDiscoveryClientRouteLocator 的父类,此类基本实现了RouteLocator接口,对读取的配置文件信息做一些基本处理,提供方法doRefresh()与 locateRoutes()供子类实现刷新策略与映射规则加载策
略,两个方法源码及签名如下:

    Spring Cloud Zuul动态路由

Spring Cloud Zuul动态路由

       两个方法都是使用protected修饰,是为了让子类不 用维护此类一些成员变量就能够实现刷新或者读取路由的功能。从注释也能看出,调用doRefresh()方法需要实现RefreshableRouteLocatorlocateRoutes()方法,默认是一个静态的映射读取方法,方法签名说得很明白,如果需要动态读取加载映射,则需要子类重写此方法。
 
ZuulServerAutoConfiguration:
 
    在低版本的Spring Cloud Zuul中,这个类叫作 ZuulConfiguration,位于org.springframework.cloud.netflix.zuul包中,主要目的是注册各种过滤器、监听器以及其他功能。Zuul在注册中 心新增服务后刷新监听器也是在此注册的,底层是采用Spring的ApplicationListener来实现的,核心代码如下:

Spring Cloud Zuul动态路由

Spring Cloud Zuul动态路由

       由方法onApplicationEvent(ApplicationEvent event) 可知,Zuul会接收3种事件ContextRefreshedEvent, RefreshScopeRefreshedEvent,RoutesRefreshedEvent通 知去刷新路由映射配置信息,此外心跳续约监视器
HeartbeatMonitor也会触发这个动作。
 
ZuulHandlerMapping :
 此类是将本地配置的映射关系映射到远程的过程控 制器,与事件刷新相关的代码如下:
  Spring Cloud Zuul动态路由
 
 
 
这个dirty属性很重要,它是用来控制当前是否需要重新加载映射配置信息的标记,在Zuul每次进行路由操 作的时候都会检查这个值,如果为true,就会触发配置 信息的重新加载,同时再将其回设为false。也由 setDirty(boolean dirty)可知,启动刷新动作必须要实现RefreshableRouteLocator接口。
    我们在构建动态路由的时候只需要重写SimpleRouteLocator类的locateRoutes()方法,并且实现 RefreshableRouteLocator接口的refresh()方法,再在内部 调用SimpleRouteLocator类的doRefresh()方法,就可以构建起一个由Zuul内部事件触发的自定义动态路由加载 器。如果不想使用内部事件触发配置更新操作,改为手 动触发,可以重写onApplicationEvent(ApplicationEvent
event)方法内部实现方式,事实上手动触发的控制性更好。
 

2.基于DB的动态路由实战

1.zuul-server编写说明

Spring Cloud Zuul动态路由

 
Spring Cloud Zuul动态路由
 
Spring Cloud Zuul动态路由
Spring Cloud Zuul动态路由
 
编写DAO类,从数据库读取路由配置信息
 
Spring Cloud Zuul动态路由
 
 
Spring Cloud Zuul动态路由
 
读取数据库可用的路由配置信息,ZuulRouteEntity 是库表的映射实体类,这里就不展示了,然后把结果包 装成Map<StringZuulRoute>供自定义路由配置加载器 使用。
 
编写自定义路由配置加载器:
 
Spring Cloud Zuul动态路由
 
 
 
Spring Cloud Zuul动态路由
 
 
这个类是本次改造的核心类,locateRoutes()方法从数据库加载配置信息,并且结合Zuul内部事件刷新机制,实际上每次心跳续约都会触发路由配置重新加载的操作。
 
 
对自定义路由配置加载器的生效操作类:
Spring Cloud Zuul动态路由
Spring Cloud Zuul动态路由