Dubbo异步方法调用里有个坑

程序员文章站 2022-07-01 22:33:42

...

在使用dubbo异步调用方法，遇到一个坑，类似于这个描述场景：客户端远程异步调用ServiceA，ServiceA在处理客户端请求的过程中需要远程同步调用ServiceB，ServiceA从ServiceB的响应中取数据时，得到的是null。网上找到的解决方法，感谢作者解惑，在这里记录一下，原文请参考：http://blog.csdn.net/windrui/article/details/52150345

dubbo对上下文信息的描述如下（点击查看）：RpcContext 是一个 ThreadLocal 的临时状态记录器，当接收到 RPC 请求，或发起 RPC 请求时，RpcContext 的状态都会变化。比如：A 调 B，B 再调 C，则 B 机器上，在 B 调 C 之前，RpcContext 记录的是 A 调 B 的信息，在 B 调 C 之后，RpcContext 记录的是 B 调 C 的信息。

回到问题描述：客户端远程异步调用ServiceA，ServiceA在处理客户端请求的过程中需要远程同步调用ServiceB，ServiceA从ServiceB的响应中取数据时，得到的是null。客户端异步调用ServiceA，RpcContext会往attachments(Map结构)属性中添加async=true的键值，当ServiceA同步调用ServiceB的时候，dubbo会将此次调用当做异步调用进行操作，返回ResponseFuture，那么会立即返回null值（关于dubbo的异步调用，请点击这里）。

源码分析如下：

client到ServiceA的远程方法异步调用，会在RpcContext(RpcContext是一个临时状态记录器，当接收到RPC请求，或发起RPC请求时，RpcContext的状态都会变化。比如：A调B，B再调C，则B机器上，在B调C之前，RpcContext记录的是A调B的信息，在B调C之后，RpcContext记录的是B调C的信息)的attachments(Map结构)属性中添加async=true的键值对，同时也会在RpcInvocation的attachments(Map结构)中添加async=true的键值对。
经过一系列的Filter，程序运行到AbstractInvoker的invoke方法，注意该方法中的如下代码段，

Map<String, String> context = RpcContext.getContext().getAttachments();
if (context != null) {
	invocation.addAttachmentsIfAbsent(context);
}

这里会把当前RpcContext中的attachments添加到调用ServiceB的RpcInvocation中，这时候async=true已经添加了，接着执行如下代码段，

if (getUrl().getMethodParameter(invocation.getMethodName(), Constants.ASYNC_KEY, false)){
	invocation.setAttachment(Constants.ASYNC_KEY, Boolean.TRUE.toString());
}
上面代码判断调用ServiceB的URL中是否含有async=true，如果有将设置async=true到RpcInvocation的attachments中，这时候是不包含的。
继续跟踪代码，运行到DubboInvoker中，调用doInvoke方法，该方法中有如下的代码段，boolean isAsync = RpcUtils.isAsync(getUrl(), invocation)，这个isAsync方法具体声明如下，
public static boolean isAsync(URL url, Invocation inv) {
	boolean isAsync ;
	//如果Java代码中设置优先.
	if (Boolean.TRUE.toString().equals(inv.getAttachment(Constants.ASYNC_KEY))) {
		isAsync = true;
	} else {
		isAsync = url.getMethodParameter(getMethodName(inv), Constants.ASYNC_KEY, false);
	}
	return isAsync;
}
上面方法首先判断RpcInvocation的attachments中async=true是否成立，如果成立则这是一次异步调用，否则判断请求URL中async=true是否成立，如果成立则是一次异步调用，否则是一次同步调用，根据上面传递的参数，此时isAsync方法返回的是true，ServiceA同步调用ServiceB变成了异步调用，继续看下面的异步调用，代码段如下，
else if (isAsync) {
	ResponseFuture future = currentClient.request(inv, timeout) ;
	RpcContext.getContext().setFuture(new FutureAdapter<Object>(future));
	return new RpcResult();
}
这里直接返回了一个RpcResult对象，没有数据内容，所以到这里，这个案子也就破了，ServiceA想从响应中取目标数据得到的当然是null。再延伸一下，如果ServiceB再同步调用ServiceC，这是可以正常同步调用的，因为ServiceA调用完ServiceB后，ConsumerContextFilter的invoke方法会清除attachements，所以ServiceB可以正常同步调用ServiceC了。

解决方法：对于上面的问题，解决办法有三个：

1.方法调用两次
ServiceA调用ServiceB的地方写两次一样的调用，这个方法原理就像ServiceB调用ServiceC一样，即清除attachements，这个方法最简单，但是可能对不了解的人来说，这块业务代码写重复了，会不小心删除掉，而且从写代码的角度来说，这个很鸡肋，所以不推荐。
2.修改Dubbo源码
修改AbstractInvoker第137行，改成每次都对async进行实际赋值，
boolean isAsync = getUrl().getMethodParameter(invocation.getMethodName(), Constants.ASYNC_KEY, false);
invocation.setAttachment(Constants.ASYNC_KEY, String.valueOf(isAsync));
3.自定义Filter
实现com.alibaba.dubbo.rpc.Filter，在RpcContext中清除这个async，

@Activate(group = {Constants.PROVIDER})
public class AsyncFilter implements Filter {
	@Override
	public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
		RpcContext.getContext().getAttachments().remove(Constants.ASYNC_KEY);
		return invoker.invoke(invocation);
	}
}
同时在src/main/resources/META-INF/dubbo/下添加com.alibaba.dubbo.rpc.Filter文件，内容文件如下：

asyncFilter=com.abc.filter.AsyncFilter