com.alibaba.dubbo.registry.common.route

类 RouteRule

java.lang.Object

com.alibaba.dubbo.registry.common.route.RouteRule

public class RouteRule
extends Object

Rule分成两部分，When条件和Then条件。
条件是一组键值（KV）对，表示匹配条件。条件包含的键值中的“值”（Value）可以有多个值，即是一个列表。
Rule的含义是，符合了When条件后，则进行Then条件的过虑。
当然被When条件的符合的、被Then条件过滤的，也是一组KV，术语上我们就称为样本（Sample）吧。
使用条件对样本进行的匹配的过程称为“过滤”（或称为“筛选”）（Filter）。 使用When条件过滤和使用Then条件过滤的样本，不需要是相同的集合。如在Dubbo中，分别对应的是Consumer和Provider。 对于RouteRule（路由规则）含义即，符合When条件的Consumer，则对Provider进行Then过滤，出来的Provide即是提供给这个Consumer的Provider。
Rule的字符串格式如下： key1 = value11,value12 & key2 = value21 & key2 != value22 => key3 = value3 & key4 = value41,vlaue42 & key5 !=value51 。 =>之前的称为When条件，是KV对；之后是Then条件，是KV对。KV的Value可以有多个值。

值对象，线程安全。

作者:

william.liangf, ding.lid

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	RouteRule.MatchPair

方法概要

限定符和类型	方法和说明
static void	contidionToString(StringBuilder sb, Map<String,RouteRule.MatchPair> condition)
static RouteRule	copyWithRemove(RouteRule copy, Set<String> whenParams, Set<String> thenParams)
static RouteRule	copyWithReplace(RouteRule copy, Map<String,RouteRule.MatchPair> whenCondition, Map<String,RouteRule.MatchPair> thenCondition) 使用新的条件值来替换。
static RouteRule	createFromCondition(Map<String,RouteRule.MatchPair> whenCondition, Map<String,RouteRule.MatchPair> thenCondition)
static RouteRule	createFromNameAndValueListString(Map<String,String> whenParams, Map<String,String> notWhenParams, Map<String,String> thenParams, Map<String,String> notThenParams)
boolean	equals(Object obj)
Map<String,RouteRule.MatchPair>	getThenCondition()
String	getThenConditionString()
Map<String,RouteRule.MatchPair>	getWhenCondition()
String	getWhenConditionString()
int	hashCode()
boolean	isContainValue(String key, String value)
boolean	isThenContainValue(String key, String value)
boolean	isWhenContainValue(String key, String value)
static String	join(Set<String> valueSet)
static boolean	matchCondition(Map<String,String> sample, Map<String,RouteRule.MatchPair> condition) 样本是否通过条件。
static RouteRule	parse(Route route) 把字符串形式的RouteRule的解析成对象。
static RouteRule	parse(String rule)
static RouteRule	parse(String whenRule, String thenRule)
static RouteRule	parseQuitely(Route route)
static Map<String,RouteRule.MatchPair>	parseRule(String rule)
String	toString()

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

方法详细资料

parseRule

public static Map<String,RouteRule.MatchPair> parseRule(String rule)
                                                 throws ParseException

抛出:

ParseException

parse

public static RouteRule parse(Route route)
                       throws ParseException

把字符串形式的RouteRule的解析成对象。

抛出:

ParseException - RouteRule字符串格式不对了。以下输入的情况，RouteRule都是非法的。

• 输入是null。
• 输入是空串，或是空白串。
• 输入的Rule，没有When条件
• 输入的Rule，没有Then条件

parse

public static RouteRule parse(String whenRule,
                              String thenRule)
                       throws ParseException

抛出:

ParseException

parse

public static RouteRule parse(String rule)
                       throws ParseException

抛出:

ParseException

parseQuitely

public static RouteRule parseQuitely(Route route)

抛出:

RuntimeException - 解析出错时，Wrap了parse(String)方法的抛出的ParseException的异常。

另请参阅:

parse(String)

createFromNameAndValueListString

public static RouteRule createFromNameAndValueListString(Map<String,String> whenParams,
                                                         Map<String,String> notWhenParams,
                                                         Map<String,String> thenParams,
                                                         Map<String,String> notThenParams)

createFromCondition

public static RouteRule createFromCondition(Map<String,RouteRule.MatchPair> whenCondition,
                                            Map<String,RouteRule.MatchPair> thenCondition)

copyWithRemove

public static RouteRule copyWithRemove(RouteRule copy,
                                       Set<String> whenParams,
                                       Set<String> thenParams)

copyWithReplace

public static RouteRule copyWithReplace(RouteRule copy,
                                        Map<String,RouteRule.MatchPair> whenCondition,
                                        Map<String,RouteRule.MatchPair> thenCondition)

使用新的条件值来替换。

参数:

copy - 替换的Base

whenCondition - 要替换的whenCondition，如果Base没有项目，则直接插入。

thenCondition - 要替换的thenCondition，如果Base没有项目，则直接插入。

返回:

替换后的RouteRule

matchCondition

public static boolean matchCondition(Map<String,String> sample,
                                     Map<String,RouteRule.MatchPair> condition)

样本是否通过条件。

如果样本的KV中，存在Key有对应的MatchPair，且Value不通过MatchPair里，返回false； 否则返回true。

另请参阅:

RouteRule.MatchPair.pass(String)

join

public static String join(Set<String> valueSet)

contidionToString

public static void contidionToString(StringBuilder sb,
                                     Map<String,RouteRule.MatchPair> condition)

isWhenContainValue

public boolean isWhenContainValue(String key,
                                  String value)

isThenContainValue

public boolean isThenContainValue(String key,
                                  String value)

isContainValue

public boolean isContainValue(String key,
                              String value)

getWhenCondition

public Map<String,RouteRule.MatchPair> getWhenCondition()

getThenCondition

public Map<String,RouteRule.MatchPair> getThenCondition()

getWhenConditionString

public String getWhenConditionString()

getThenConditionString

public String getThenConditionString()

toString

public String toString()

覆盖:

toString 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 Object