Dubbo——路由的实现

路由的实现

路由接口会根据用户配置的不同路由策略对Invoker列表进行过滤&＃xff0c;只返回符合规则的Invoekr。例如&＃xff1a;如果用户配置了接口A的所有调用&＃xff0c;都是用IP为192.168.1.22的节点&＃xff0c;则路由会过滤其他的Invoekr&＃xff0c;只返回IP为192.168.1.22的Invoker。

路由的总体结构

路由分为条件路由、文件路由、脚本路由&＃xff0c;对应dubbo-admin中三种不同的规则匹配方法。

• 条件路由是用户使用Dubbo定义的语法规则去写路由规则&＃xff1b;
• 文件路由则需要用户提交一个文件&＃xff0c;里面写着对应的路由规则&＃xff0c;框架基于文件读取对应的规则&＃xff1b;
• 脚本路由则是使用JDK自身的脚本引擎解析路由规则脚本&＃xff0c;所有JDK脚本引擎支持的脚本都能解析&＃xff0c;默认是Javascript。
  
  

RouterFactory是一个SPI接口&＃xff0c;没有设置默认值&＃xff0c;但由于有&＃64;Adaptive("protocol")注解&＃xff0c;因此他会根据URL中的protocol参数确定要初始化哪个具体的Router实现。

在SPI的配置文件中可以看到&＃xff0c;URL中的protocol可以设置file、script、condition三种值&＃xff1a;

RouterFactory的实现也非常简单&＃xff0c;就是直接"new"一个对应的Router并返回。例如&＃xff1a;ConditionRouterFactory直接"new"并返回一个ConditionRouter。当然&＃xff0c;FileRouterFctory除外&＃xff0c;直接在工厂类中实现了所有逻辑。

条件路由的参数规则

条件路由使用的是condition://协议&＃xff0c;URL形式是:

condition://0.0.0.0/com.foo.BarService?category&＃61;routers&dynamic&＃61;false&rule&＃61;URL.encode("host&＃61;10.20.153.0&＃61;>host&＃61;10.20.153.11")//最后的路由规则会使用URL.encode畸形编码


路由规则&＃xff1a;

路由规则配置示例&＃xff1a;

method &＃61; find* &＃61;> host &＃61; 192.168.1.22


• 这条配置说明所有调用find开头的方法都会被路由到IP为192.168.1.22的服务节点上&＃xff1b;
• &＃61;>之前的部分为消费者匹配条件&＃xff0c;将所有参数和消费者的URL进行对比&＃xff0c;当消费者满足匹配条件时&＃xff0c;对该消费者执行后面的过滤规则&＃xff1b;
• &＃61;>之后的部分为提供者地址列表的过滤条件&＃xff0c;将所有参数和提供者的URL进行对比&＃xff0c;消费者最终只获取过滤后的地址列表&＃xff1b;
• 如果匹配条件为空&＃xff0c;则表示应用于所有消费方&＃xff0c;如&＃61;> host !&＃61; 192.168.1.22;
• 如果过滤条件为空&＃xff0c;则表示禁止访问&＃xff0c;如host &＃61; 192.168.1.22 ->&＃xff1b;

整个规则的表达式支持$protocol等占位符方式&＃xff0c;也支持&＃61;、!&＃61;等条件。值可以支持多个&＃xff0c;有那个逗号分隔&＃xff0c;如host &＃61; 192.168.1.22,192.168.1.23&＃xff1b;如果以"*"号结尾&＃xff0c;则说明是通配符&＃xff0c;如host &＃61; 192.168.1.*表示撇皮192.168.1.网段下所有IP。

条件路由的实现

条件路由的具体实现类是ComditionRouter&＃xff0c;Dubbo会根据自定义的规则语法来实现路由规则。我们主要需要关注其构造方法和实现父类接口的route方法。

1. ConditionRouter构造方法的逻辑&＃xff1a;

ConditionRouterFactory在初始化ConditionRouter的时候&＃xff0c;其构造方法汇总含有规则解析的逻辑。步骤如下&＃xff1a;

1. 粮据URL的健rule获取对应的规则字符串&＃xff0c;以&＃61;>为界&＃xff0c;把规则分成两段&＃xff0c;前面部分为whenRule,即消费者匹配条件:后面部分为thenRule&＃xff0c; 即提供者地址列表的过滤条件。我们以上面的示例规则为例&＃xff0c;其会被解析为whenRule method &＃61; find*和thenRule host &＃61; 192.168.1.22。

2. 分别解析两个路由规则。调用parseRule 方法&＃xff0c;通过正则表达式不断循环匹配whenRule和thenRule字符串。解析的时候&＃xff0c;会根据key-vaue之间的分隔符对key-value做分类(如果A&＃61;B,则分隔符为&＃61;)&＃xff0c;支持的分隔符形式有:A&＃61;B、 A&B、A!&＃61;B、A,B这4种形式。最终参数都会被封装成一个个MatchPair对象&＃xff0c;放入Map中保存。Map的key是参数值&＃xff0c;value 是MatchPair对象。若以上面的示例规则为例&＃xff0c;则会生成以method为key的whenMap,以host为key的then Map。value 则分别是包装了find*和192. 168.1.22的MatchPair对象。

   MatchPair对象是用来做什么的呢?这个对象一共有两个作用。

   • 第一个作用是通配符的匹配和占位符的赋值。MatchPair对象是内部类&＃xff0c;里面只有一个isMatch方法&＃xff0c;用于判断值是否能匹配得上规则。规则里的$、*等通配符都会在MatchPair对象中进行匹配。其中$支持protocol、username、password、 host、 port、 path 这几个动态参数的占位符。例如:规则中写了S$protocol,则会自动从URL中获取protocol的值&＃xff0c;并赋值进去。
   • 第二个作用是缓存规则。MatchPair 对象中有两个Set 集合&＃xff0c;一个用于保存匹配的规则&＃xff0c;如&＃61;find*; 另一个则用于保存不匹配的规则&＃xff0c;如!&＃61;find*。这两个集合在后续路由规则匹配的时候会使用到。

2. route方法的实现原理:

ConditionRouter继承了Router 接口&＃xff0c;需要实现接口的route方法。该方法的主要功能是过滤出符合路由规则的Invoker列表&＃xff0c;即做具体的条件匹配判断&＃xff0c;其步骤如下:

1. 校验。如果规则没有启用&＃xff0c;则直接返回;如果传入的Invoker列表为空&＃xff0c;则直接返回空:如果没有任何的whenRule匹配&＃xff0c;即没有规则匹配&＃xff0c;则直接返回传入的Invoker列表:如果whenRule有匹配的&＃xff0c;但是thenRule 为空&＃xff0c;即没有匹配上规则的Invoke,则返回空。

2. 遍历Invoker列表&＃xff0c;通过heRule找出所有符合规则的Invoker加入集合。例如:匹配规则中的method名称和当前URL中的method是不是相等。

3. 返回结果。如果结果集不为空&＃xff0c;则直接返回:如果结果集为空&＃xff0c;但是规则配置了frcerue即强制过滤&＃xff0c;那么就会返回空结果集:非强制则不过滤&＃xff0c;即返回所有lnoer列表。具体的逻辑还&＃xff0c;是比较简单的&＃xff0c;但代码中的if判断会比较多。

文件路由的实现

文件路由是把规则写在文件中&＃xff0c;文件中写的是自定义的脚本规则&＃xff0c;可以是Javascript、Groovy等&＃xff0c;URL中对应的key值填写的是文件的路径。文件路由主要做的就是把文件中的路由脚本读出来&＃xff0c;然后调用路由的工厂去匹配对应的脚本路由做解析。

脚本路由的实现

脚本路由使用JDK自带的脚本解析器解析脚本并运行&＃xff0c;默认使用Javascript解析器&＃xff0c;其逻辑分为构造方法和route方法两大部分。构造方法主要负责一些初始化的工作&＃xff0c;route方法则是具体的过滤逻辑执行的地方。

脚本示例&＃xff1a;

function route(invokers) {//创建一个Listvar result &＃61; new java.util.ArrayList(invokers.size());//遍历传入的所有Invoker&＃xff0c;过滤所有IP不死10.20.153.10的Invokerfor(i &＃61; 0; i < invokers.size(); i&＃43;&＃43;) {if("10.20.153.10".equals(invokers.get(i).getUrl().getHost())){result.add(invokers.get(i));}}return result;
}(invokers);//表示立即执行方法


在写Javascript脚本的时候需要注意&＃xff0c;一个服务只能有一条规则&＃xff0c;如果有多条规则&＃xff0c;并且规则之间没有交集&＃xff0c;则会把所有的Invoker都过滤。另外&＃xff0c;脚本路由中也没看到沙箱约束&＃xff0c;因此会有注入的风险。

脚本路由的构造方法逻辑&＃xff1a;

1. 初始化参数。获取规则的脚本类型、路由优先级。如果没有设置脚本类型&＃xff0c;则默认设置为Javascript类型&＃xff0c;如果没有解析到任何规则&＃xff0c;则抛出异常。
2. 初始化脚本执行引擎。根据脚本的类型&＃xff0c;通过Java的ScriptEngineManager创建不同的脚本执行器&＃xff0c;并缓存起来。

route方法的核心逻辑就是调用脚本引擎&＃xff0c;获取执行结果并返回。主要是JDK脚本引擎的调用&＃xff0c;不会涉及具体的过滤逻辑。