SpringCloud动态路由利器--router4j

前言本文介绍Java的动态路由中间件router4j。router4j用于SpringCloud项目它可以将某个url请求路由到指定的机器上也可以将所有请求强制转到指定机器。问题描述Java后端在开发SpringCloud项目时如果同一个应用起了多个实例会遇到以下问题无法将指定url请求强制转到个人电脑。这样会导致难以打断点调试如果是设置了应用的所有请求都到我的电脑那么我在调试时其他接口无法使用。无法将指定的feign的url请求强制转到个人电脑。如果有人打了断点调试很可能影响测试环境因为网关的请求和feign请求还是会经常请求到打了断点的那个电脑。本文介绍的router4j可以解决这个问题是我个人写的中间件。它可以设置将指定的url的请求路由到指定的机器。官网网址官网文档router4j官网首先在官网更新不定时同步到CSDN博客githubhttps://github.com/knifeopen/router4jgiteehttps://gitee.com/knifeopen/router4j一、简介1.1 概述router4j是一个动态路由的中间件用于提高Java后端开发和调试效率。使用router4j可以将某个url请求路由到指定的机器上只需在可视化页面上将path绑定到应用实例的ip和端口上即可。router4j也支持将所有请求强制转到指定机器所以也可以用于线上不停机更新应用。1.2 特性简单支持通过Web页面操作操作简单一分钟上手无侵入引入依赖即可无需修改代码性能损耗小路径的规则存放在Redis速度很快几乎没有性能损耗支持路径的路由可以指定某个url路由到指定机器支持默认路由如果url没有设置规则则转发到设置的默认路由的实例支持强制路由所有url强制路由到指定实例无论是否设置了规则支持网关支持网关的请求转发支持feign支持feign的请求转发支持实例运行状态查看支持查看实例的运行状态1.3 支持的框架网关gateway已支持已测试zuul待支持SpringCloudloadbalancer已支持已测试SpringCloud2020及之后的版本ribbon待支持注册中心Nacos已支持已测试Eureka已支持未测试1.4 框架结构1.在可视化页面进行配置将url与实例ip加端口关联起来2.前端请求进来时gateway会使用本框架的全局过滤器会根据这个url到Redis中的配置中查询将url路由到指定的实例ip加端口3.调用feign时feign会使用本框架的负载均衡器会根据这个url到Redis中的配置中查询将url路由到指定的实例ip加端口1.5 下载githubhttps://github.com/knife-blade/router4jgiteehttps://gitee.com/knifeedge/router4j二、快速入门2.1 添加依赖备注本文依赖已上传到maven中央仓库、maven阿里云镜像。gateway网关和应用都添加依赖dependency groupIdcom.suchtool/groupId artifactIdrouter4j-client-spring-boot-starter/artifactId version1.0.0/version /dependency此依赖会自动识别是网关还是应用自动启用动态路由策略。2.2 配置网关和应用都要添加如下配置放到application.yml等配置文件即可suchtool: router4j: redis: host: localhost password: 222333 port: 6379 # database: 0 # ssl: false # timeout: 3s rule: enable: true # pathPatternPrefix: router4j:rule:pathPattern # defaultInstancePrefix: router4j:rule:defaultInstance2.3 启动注册中心和Redis启动Nacos、Redis。本处省略。2.4 启动router4j控制台1.启动控制台启动router4j-serverJava程序。可通过IDEA或者java -jar启动后期会提供docker镜像。本处我使用java命令启动java -jar router4j-server-1.0.0.jar运行结果如下2.5 开始使用启动示例服务gateway、业务应用2个order2个storage1个account。业务场景创建订单减库存、减账户余额。请求order的controllerorder分别用feign调用storage和account。需求将网关请求order的/order/create转发到192.168.5.1:9011这个实例将对storage的所有请求转发到192.168.5.1:9021这个实例。1.配置路径的路由规则访问router4j控制台http://localhost:9900在“规则管理”中配置路径与实例的绑定2.请求接口测试postman访问请求10次http://localhost:6001/order/order/create/?userId1productId1count10money100结果order全部都请求到了指定的实例192.168.5.1:9011storage全部都请求到了指定的实例192.168.5.1:90213.测试默认的路由策略上边介绍了本组件的作用如果没有使用router4j去指定请求会被负载均衡到不同的机器上。下边我把规则管理里的配置给删掉请求10次进行测试网关请求到order每个order实例收到了5次请求order通过feign请求到storage每个storage实例收到了5次请求三、使用详解3.1 规则管理底层是基于Spring自身的AntPathMatcher来实现的其规则见此文3.1.1 新建规则支持手动输入3.1.2 查找规则支持下拉框选择和手动输入3.1.3 删除规则支持单个删除绿色箭头所指和批量删除红色箭头所指。3.2 实例管理3.2.1 默认路由所有实例列表对于Nacos有命名空间在右上角选择命名空间后再点击一下搜索即可展示所有的实例对于Eureka右上角不会展示命名空间。设置为默认路由默认路由的作用如果url没有设置规则则转发到设置的默认路由的实例。支持单个设置绿色箭头与批量设置红色箭头。3.2.2 强制路由强制路由的作用所有url强制路由到指定实例无论是否设置了规则。注意在选择强制路由后默认路由也会自动被选中。支持单个设置绿色箭头与批量设置红色箭头。四、未来计划支持某个路径配置的开启关闭支持zuul网关支持RibbonSpringCloud2020之前写一个正式的router4j官网网站