org.apache.dubbo.rpc.cluster.router.condition

Class ConditionStateRouter<T>

java.lang.Object

org.apache.dubbo.rpc.cluster.router.state.AbstractStateRouter<T>

org.apache.dubbo.rpc.cluster.router.condition.ConditionStateRouter<T>

All Implemented Interfaces:

Comparable<StateRouter<T>>, StateRouter<T>

public class ConditionStateRouter<T>
extends AbstractStateRouter<T>

ConditionRouter It supports the conditional routing configured by "override://", in 2.6.x, refer to https://dubbo.apache.org/en/docs/v2.7/user/examples/routing-rule/ . For 2.7.x and later, please refer to ServiceRouter and AppStateRouter refer to https://dubbo.apache.org/zh/docs/v2.7/user/examples/routing-rule/ .

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from interface org.apache.dubbo.rpc.cluster.router.state.StateRouter

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ConditionStateRouter(org.apache.dubbo.common.URL url)
ConditionStateRouter(org.apache.dubbo.common.URL url, String rule, boolean force, boolean enabled)

Method Summary

Modifier and Type	Method and Description
void	init(String rule)
boolean	isRuntime() To decide whether this router need to execute every time an RPC comes or should only execute when addresses or rule change.
boolean	matchArguments(Map.Entry<String,org.apache.dubbo.rpc.cluster.router.condition.ConditionStateRouter.MatchPair> matchPair, Invocation invocation) analysis the arguments in the rule.
StateRouterResult<Invoker<T>>	route(BitList<Invoker<T>> invokers, org.apache.dubbo.common.URL url, Invocation invocation, boolean needToPrintMessage) ** This method can return the state of whether routerChain needed to continue route.

Methods inherited from class org.apache.dubbo.rpc.cluster.router.state.AbstractStateRouter

getPriority, getRuleRepository, getUrl, isForce, notify, setForce, setPriority, setUrl

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.dubbo.rpc.cluster.router.state.StateRouter

compareTo, stop

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ConditionStateRouter

public ConditionStateRouter(org.apache.dubbo.common.URL url,
                            String rule,
                            boolean force,
                            boolean enabled)

ConditionStateRouter

public ConditionStateRouter(org.apache.dubbo.common.URL url)

Method Detail

init

public void init(String rule)

route

public StateRouterResult<Invoker<T>> route(BitList<Invoker<T>> invokers,
                                           org.apache.dubbo.common.URL url,
                                           Invocation invocation,
                                           boolean needToPrintMessage)
                                    throws RpcException

Description copied from interface: StateRouter

** This method can return the state of whether routerChain needed to continue route. ** Filter invokers with current routing rule and only return the invokers that comply with the rule. Caching address lists in BitMap mode improves routing performance.

Parameters:

invokers - invoker bit list

url - refer url

invocation - invocation

needToPrintMessage - whether to print router state. Such as `use router branch a`.

Returns:

state with route result

Throws:

RpcException

isRuntime

public boolean isRuntime()

Description copied from interface: StateRouter

To decide whether this router need to execute every time an RPC comes or should only execute when addresses or rule change.

Specified by:

isRuntime in interface StateRouter<T>

Overrides:

isRuntime in class AbstractStateRouter<T>

Returns:

true if the router need to execute every time.

matchArguments

public boolean matchArguments(Map.Entry<String,org.apache.dubbo.rpc.cluster.router.condition.ConditionStateRouter.MatchPair> matchPair,
                              Invocation invocation)

analysis the arguments in the rule. Examples would be like this: "arguments[0]=1", whenCondition is that the first argument is equal to '1'. "arguments[1]=a", whenCondition is that the second argument is equal to 'a'.

Parameters:

matchPair -

invocation -

Returns: