Router
本文讲解如何通过扩展 Router 实现自定义路由策略，可以根据业务场景的特点来实现特定的路由方式。
通过自定义路由，可以根据业务场景的特点来实现特定的路由方式。本示例 router 扩展实现源码请参见 dubbo-samples-extensibility。
开始之前
任务详情
对所有的请求都使用第一提供服务的Provider，如果该Provider下线，则从新选择一个新的Provider。
实现方式
在Consumer中自定义一个Router，在Router中将第一次调用的Provider保存下来，如果后续有请求调用且Provider列表中包含第一次调用时使用的Provider，则继续使用第一次调用时使用的Provider，否则重新选去一个Provider。
代码结构
src
|-main
|-java
|-org
|-apache
|-dubbo
|-samples
|-extensibility
|-router
|-consumer
|-router
|-StickFirstStateRouter.java (实现StateRouter接口)
|-StickFirstStateRouterFactory.java (实现StateRouterFactory接口)
|-resources
|-META-INF
|-application.properties (Dubbo Consumer配置文件)
|-dubbo
|-org.apache.dubbo.rpc.cluster.router.state.StateRouterFactory (纯文本文件)
代码详情
- StickFirstStateRouter
package org.apache.dubbo.samples.extensibility.router.consumer.router;
import org.apache.dubbo.common.URL;
import org.apache.dubbo.common.config.configcenter.ConfigChangeType;
import org.apache.dubbo.common.config.configcenter.ConfigChangedEvent;
import org.apache.dubbo.common.config.configcenter.ConfigurationListener;
import org.apache.dubbo.common.logger.ErrorTypeAwareLogger;
import org.apache.dubbo.common.logger.LoggerFactory;
import org.apache.dubbo.common.utils.CollectionUtils;
import org.apache.dubbo.common.utils.Holder;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.RpcException;
import org.apache.dubbo.rpc.cluster.router.RouterSnapshotNode;
import org.apache.dubbo.rpc.cluster.router.state.AbstractStateRouter;
import org.apache.dubbo.rpc.cluster.router.state.BitList;
public class StickFirstStateRouter<T> extends AbstractStateRouter<T> implements ConfigurationListener {
public StickFirstStateRouter(URL url) {
super(url);
}
public static final String NAME = "STICK_FIRST_ROUTER";
private static final ErrorTypeAwareLogger logger = LoggerFactory.getErrorTypeAwareLogger(StickFirstStateRouter.class);
private volatile BitList<Invoker<T>> firstInvokers;
@Override
protected BitList<Invoker<T>> doRoute(BitList<Invoker<T>> invokers, URL url, Invocation invocation, boolean needToPrintMessage, Holder<RouterSnapshotNode<T>> routerSnapshotNodeHolder, Holder<String> messageHolder) throws RpcException {
if (CollectionUtils.isEmpty(invokers)) {
if (needToPrintMessage) {
messageHolder.set("Directly Return. Reason: Invokers from previous router is empty.");
}
return invokers;
}
BitList<Invoker<T>> copy = invokers.clone();
if (CollectionUtils.isEmpty(copy)) {
this.firstInvokers = new BitList<>(BitList.emptyList());
this.firstInvokers.add(copy.get(0));
} else {
this.firstInvokers = copy.and(invokers);
if(CollectionUtils.isEmpty(this.firstInvokers)){
this.firstInvokers.add(copy.get(0));
}
}
return this.firstInvokers;
}
@Override
public void process(ConfigChangedEvent event) {
if (logger.isDebugEnabled()) {
logger.debug("Notification of tag rule, change type is: " + event.getChangeType() + ", raw rule is:\n " +
event.getContent());
}
// Reset
if (event.getChangeType().equals(ConfigChangeType.DELETED)) {
this.firstInvokers = null;
}
}
@Override
public void stop() {
super.stop();
this.firstInvokers = null;
}
}
- StickFirstStateRouterFactory
package org.apache.dubbo.samples.extensibility.router.consumer.router;
import org.apache.dubbo.common.URL;
import org.apache.dubbo.rpc.cluster.router.state.StateRouter;
import org.apache.dubbo.rpc.cluster.router.state.StateRouterFactory;
public class StickFirstStateRouterFactory implements StateRouterFactory {
@Override
public <T> StateRouter<T> getRouter(Class<T> interfaceClass, URL url) {
return new StickFirstStateRouter<>(url);
}
}
SPI配置
在resources/META-INF/dubbo/org.apache.dubbo.rpc.cluster.router.state.StateRouterFactory文件中添加如下配置：
stickfirst=org.apache.dubbo.samples.extensibility.router.consumer.router.StickFirstStateRouterFactory
配置文件
在resources/application.properties文件中添加如下配置：
# 配置自定义路由
dubbo.consumer.router=stickfirst
运行结果
以使用本地IDE的方式来运行任务，结果如下：
