扫二维码与项目经理沟通
我们在微信上24小时期待你的声音
解答本文疑问/技术咨询/运营咨询/技术建议/互联网交流
Spring Cloud Zuul的动态路由以及集成Nacos实现的示例分析,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。
成都创新互联公司-专业网站定制、快速模板网站建设、高性价比江华网站开发、企业建站全套包干低至880元,成熟完善的模板库,直接使用。一站式江华网站制作公司更省心,省钱,快速模板网站建设找我们,业务覆盖江华地区。费用合理售后完善,十多年实体公司更值得信赖。
网关的核心概念就是路由配置和路由规则,而作为所有请求流量的入口,在实际生产环境中为了保证高可靠和高可用,是尽量要避免重启的,所以实现动态路由是非常有必要的;下面主要介绍实现的思路,并且以Nacos
为数据源来讲解
要实现动态路由只需关注下面4个点
网关启动时,动态路由
的数据怎样加载进来
静态路由
与动态路由
以那个为准,ps:静态路由
指的是配置文件里写死的路由配置
监听动态路由
的数据源变化
数据有变化时怎样通知zuul
刷新路由
重写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 MaplocateRoutes() { LinkedHashMap routesMap = new LinkedHashMap<>(); // 从application.properties中加载静态路由信息 routesMap.putAll(super.locateRoutes()); // 从数据源中加载动态路由信息 routesMap.putAll(loadDynamicRoute()); // 优化一下配置 LinkedHashMap values = new LinkedHashMap<>(); for (Map.Entry 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 loadDynamicRoute();}
由于动态路由的数据可以有很多种途径,如:Nacos、redis、Zookeeper、DB等,所以这里定义一个抽象类,由具体的实现类去定义
loadDynamicRoute
方法
NacosDynRouteLocator类
loadDynamicRoute
方法获取动态数据@Overridepublic MaploadDynamicRoute() { Map routes = new LinkedHashMap<>(); if (zuulRouteEntities == null) { zuulRouteEntities = getNacosConfig(); } for (ZuulRouteEntity result : zuulRouteEntities) { if (StrUtil.isBlank(result.getPath()) || !result.isEnabled()) { continue; } ZuulRoute zuulRoute = new ZuulRoute(); BeanUtil.copyProperties(result, zuulRoute); routes.put(zuulRoute.getPath(), zuulRoute); } return routes;}private List 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); } return new ArrayList<>(0);}
NacosListener
监听路由数据变化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); }}
注意路由数据变化后不需要自己手动刷新路由,只需要给
zuul
发送一个RoutesRefreshedEvent
事件即可,zuul
自己有个ZuulRefreshListener类
会监听事件帮我们刷新路由
该类完整的代码实现可查看:
https://gitee.com/zlt2000/microservices-platform/blob/master/zlt-gateway/zuul-gateway/src/main/java/com/central/gateway/route/nacos/NacosDynRouteLocator.java
NacosDynRouteLocator
的BeanDynamicZuulRouteConfig类
@Configuration@ConditionalOnProperty(prefix = "zlt.gateway.dynamicRoute", name = "enabled", havingValue = "true")public class DynamicZuulRouteConfig { @Autowired private ZuulProperties zuulProperties; @Autowired private DispatcherServletPath dispatcherServletPath; /** * Nacos实现方式 */ @Configuration @ConditionalOnProperty(prefix = "zlt.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); } }}
这里通过自定义配置来控制是否开启
动态路由功能
Nacos
路由配置
新增配置项:
Data Id:zuul-routes
Group:ZUUL_GATEWAY
配置内容:
[ { "enabled":true, "id":"csdn", "path":"/csdn/**", "retryable":false, "stripPrefix":true, "url":"https://www.csdn.net/" }, { "enabled":true, "id":"github", "path":"/github/**", "retryable":false, "stripPrefix":true, "url":"http://github.com/" }]
添加两条路由数据
启动网关通过/actuator/routes
端点查看网关所有路由信息
可以看到静态路由和
Nacos
里配置的两条路由信息并存显示
修改Nacos
配置,关闭csdn
路由
刷新查看网关的路由信息
csdn
的路由已经看不到了,实现了动态改变路由配置
关于Spring Cloud Zuul的动态路由以及集成Nacos实现的示例分析问题的解答就分享到这里了,希望以上内容可以对大家有一定的帮助,如果你还有很多疑惑没有解开,可以关注创新互联行业资讯频道了解更多相关知识。
我们在微信上24小时期待你的声音
解答本文疑问/技术咨询/运营咨询/技术建议/互联网交流