网关zuul动态路由 · 葵花宝典

[TOC] 开启功能需要，修改`zuul`的配置文件 ~~~ pigframe.gateway.dynamicRoute.enabled=true ~~~ ## 1. 实现动态路由的数据加载 * 重写`SimpleRouteLocator`类的`locateRoutes`方法，此方法是加载路由配置的，父类中是获取properties中的路由配置，可以通过扩展此方法，达到动态获取配置的目的 * 这里采用`静态路由`与`动态路由`共存，相同路由id以`动态路由`优先覆盖的实现方式 AbstractDynRouteLocator抽象类 ~~~ public abstract class AbstractDynRouteLocator extends SimpleRouteLocator implements RefreshableRouteLocator { private ZuulProperties properties; public AbstractDynRouteLocator(String servletPath, ZuulProperties properties) { super(servletPath, properties); this.properties = properties; } /** * 刷新路由 */ @Override public void refresh() { doRefresh(); } @Override protected Map<String, ZuulRoute> locateRoutes() { LinkedHashMap<String, ZuulRoute> routesMap = new LinkedHashMap<>(); // 从application.properties中加载静态路由信息 routesMap.putAll(super.locateRoutes()); // 从数据源中加载动态路由信息 routesMap.putAll(loadDynamicRoute()); // 优化一下配置 LinkedHashMap<String, ZuulRoute> values = new LinkedHashMap<>(); for (Map.Entry<String, ZuulRoute> entry : routesMap.entrySet()) { String path = entry.getKey(); // Prepend with slash if not already present. if (!path.startsWith("/")) { path = "/" + path; } if (StringUtils.hasText(this.properties.getPrefix())) { path = this.properties.getPrefix() + path; if (!path.startsWith("/")) { path = "/" + path; } } values.put(path, entry.getValue()); } return values; } /** * 加载路由配置，由子类去实现 */ public abstract Map<String, ZuulRoute> loadDynamicRoute(); } ~~~ > 由于动态路由的数据可以有很多种途径，如：Nacos、Redis、Zookeeper、DB等，所以这里定义一个抽象类，由具体的实现类去定义`loadDynamicRoute`方法 ## 2. Nacos路由实现类 NacosDynRouteLocator类 ### 2.1. 实现`loadDynamicRoute`方法获取动态数据 ~~~ @Override public Map<String, ZuulProperties.ZuulRoute> loadDynamicRoute() { Map<String, ZuulRoute> routes = new LinkedHashMap<>(); if (zuulRouteEntities == null) { zuulRouteEntities = getNacosConfig(); } for (ZuulRouteEntity result : zuulRouteEntities) { if (StringUtils.isBlank(result.getPath()) || !result.isEnabled()) { continue; } ZuulRoute zuulRoute = new ZuulRoute(); BeanCopyUtils.copyProperties(result, zuulRoute); routes.put(zuulRoute.getPath(), zuulRoute); } return routes; } /** * 查询zuul的路由配置 */ private List<ZuulRouteEntity> getNacosConfig() { try { String content = nacosConfigProperties.configServiceInstance().getConfig(ZUUL_DATA_ID, ZUUL_GROUP_ID,5000); return getListByStr(content); } catch (NacosException e) { log.error("listenerNacos-error, {}", e.getMessage()); } return new ArrayList<>(0); } ~~~ ### 2.2. 增加`NacosListener`监听路由数据变化 ~~~ /** * 添加Nacos监听 */ private void addListener() { try { nacosConfigProperties.configServiceInstance().addListener(ZUUL_DATA_ID, ZUUL_GROUP_ID, new Listener() { @Override public Executor getExecutor() { return null; } @Override public void receiveConfigInfo(String configInfo) { //赋值路由信息 locator.setZuulRouteEntities(getListByStr(configInfo)); RoutesRefreshedEvent routesRefreshedEvent = new RoutesRefreshedEvent(locator); publisher.publishEvent(routesRefreshedEvent); } }); } catch (NacosException e) { log.error("nacos-addListener-error, {}", e.getMessage()); } } ~~~ >注意路由数据变化后不需要自己手动刷新路由，只需要给`zuul`发送一个`RoutesRefreshedEvent`事件即可，`zuul`自己有个`ZuulRefreshListener类`会监听事件帮我们刷新路由 ### 2.3. 该类完整代码 ~~~ @Slf4j public class NacosDynRouteLocator extends AbstractDynRouteLocator { private static final String ZUUL_DATA_ID = "zuul-routes"; private static final String ZUUL_GROUP_ID = "ZUUL_GATEWAY"; private NacosConfigProperties nacosConfigProperties; private ApplicationEventPublisher publisher; private NacosDynRouteLocator locator; @Setter private List<ZuulRouteEntity> zuulRouteEntities; public NacosDynRouteLocator(NacosConfigProperties nacosConfigProperties, ApplicationEventPublisher publisher, String servletPath, ZuulProperties properties) { super(servletPath, properties); this.nacosConfigProperties = nacosConfigProperties; this.publisher = publisher; this.locator = this; addListener(); } /** * 添加Nacos监听 */ private void addListener() { try { nacosConfigProperties.configServiceInstance().addListener(ZUUL_DATA_ID, ZUUL_GROUP_ID, new Listener() { @Override public Executor getExecutor() { return null; } @Override public void receiveConfigInfo(String configInfo) { //赋值路由信息 locator.setZuulRouteEntities(getListByStr(configInfo)); RoutesRefreshedEvent routesRefreshedEvent = new RoutesRefreshedEvent(locator); publisher.publishEvent(routesRefreshedEvent); } }); } catch (NacosException e) { log.error("nacos-addListener-error, {}", e.getMessage()); } } @Override public Map<String, ZuulProperties.ZuulRoute> loadDynamicRoute() { Map<String, ZuulRoute> routes = new LinkedHashMap<>(); if (zuulRouteEntities == null) { zuulRouteEntities = getNacosConfig(); } for (ZuulRouteEntity result : zuulRouteEntities) { if (StringUtils.isBlank(result.getPath()) || !result.isEnabled()) { continue; } ZuulRoute zuulRoute = new ZuulRoute(); BeanCopyUtils.copyProperties(result, zuulRoute); routes.put(zuulRoute.getPath(), zuulRoute); } return routes; } /** * 查询zuul的路由配置 */ private List<ZuulRouteEntity> getNacosConfig() { try { String content = nacosConfigProperties.configServiceInstance().getConfig(ZUUL_DATA_ID, ZUUL_GROUP_ID,5000); return getListByStr(content); } catch (NacosException e) { log.error("listenerNacos-error, {}", e.getMessage()); } return new ArrayList<>(0); } public List<ZuulRouteEntity> getListByStr(String content) { if (StringUtils.isNotEmpty(content)) { return JSONObject.parseArray(content, ZuulRouteEntity.class); } return new ArrayList<>(0); } } ~~~ ## 3. 配置类创建`NacosDynRouteLocator`的Bean DynamicZuulRouteConfig类 ~~~ @Configuration @ConditionalOnProperty(prefix = "pigframe.gateway.dynamicRoute", name = "enabled", havingValue = "true") public class DynamicZuulRouteConfig { @Autowired private ZuulProperties zuulProperties; @Autowired private DispatcherServletPath dispatcherServletPath; /** * Nacos实现方式 */ @Configuration @ConditionalOnProperty(prefix = "pigframe.gateway.dynamicRoute", name = "dataType", havingValue = "nacos", matchIfMissing = true) public class NacosZuulRoute { @Autowired private NacosConfigProperties nacosConfigProperties; @Autowired private ApplicationEventPublisher publisher; @Bean public NacosDynRouteLocator nacosDynRouteLocator() { return new NacosDynRouteLocator(nacosConfigProperties, publisher, dispatcherServletPath.getPrefix(), zuulProperties); } } } ~~~ >这里通过自定义配置来控制是否开启`动态路由功能` ## 4. 添加`Nacos`路由配置新增配置项： * Data Id：zuul-routes * Group：ZUUL\_GATEWAY * 配置内容： ~~~ [ { "enabled":true, "id":"gitee", "path":"/gitee/**", "retryable":false, "stripPrefix":true, "url":"https://www.gitee.com/" }, { "enabled":true, "id":"github", "path":"/github/**", "retryable":false, "stripPrefix":true, "url":"http://github.com/" } ] ~~~ ## 5. 测试路由 >启动网关通过`/actuator/routes`端点查看网关所有路由信息可以看到静态路由和`Nacos`里配置的两条路由信息并存显示修改`Nacos`配置，关闭`gitee`路由("enabled":false) 刷新查看网关的路由信息 `gitee`的路由已经看不到了，实现了动态改变路由配置