4.23. 异步调用

• 需要服务提供者事先定义 CompletableFuture 签名的服务，具体参见 4.22. 异步执行 接口定义：

  public interface AsyncService {
      CompletableFuture<String> sayHello(String name);
  }
  

  • 注意接口的返回类型是 CompletableFuture<String>。
• XML引用服务：

  <dubbo:reference id="asyncService" timeout="10000" interface="com.alibaba.dubbo.samples.async.api.AsyncService"/>
  

• 调用远程服务：

  // 调用直接返回CompletableFuture
  CompletableFuture<String> future = asyncService.sayHello("async call request");
  // 增加回调
  future.whenComplete((v, t) -> {
      if (t != null) {
          t.printStackTrace();
      } else {
          System.out.println("Response: " + v);
      }
  });
  // 早于结果输出
  System.out.println("Executed before response return.");
  

• 在 consumer.xml 中配置：

  <dubbo:reference id="asyncService" interface="org.apache.dubbo.samples.governance.api.AsyncService">
        <dubbo:method name="sayHello" async="true" />
  </dubbo:reference>
  

• 调用代码:

  // 此调用会立即返回null
  asyncService.sayHello("world");
  // 拿到调用的Future引用，当结果返回后，会被通知和设置到此Future
  CompletableFuture<String> helloFuture = RpcContext.getContext().getCompletableFuture();
  // 为Future添加回调
  helloFuture.whenComplete((retValue, exception) -> {
      if (exception == null) {
          System.out.println(retValue);
      } else {
          exception.printStackTrace();
      }
  });
  

• 或者，你也可以这样做异步调用:

  CompletableFuture<String> future = RpcContext.getContext().asyncCall(
      () -> {
          asyncService.sayHello("oneway call request1");
      }
  );
  future.get();
  

public interface GreetingsService {
    String sayHi(String name);
}

CompletableFuture 签名的方法目前只支持 Dubbo 协议，其他协议由于第三方实现问题，需要视具体情况而定。

• 提供方或消费方自己修改接口签名

  public interface GreetingsService {
      String sayHi(String name);
      // AsyncSignal is totally optional, you can use any parameter type as long as java allows your to do that.
      default CompletableFuture<String> sayHi(String name, AsyncSignal signal) {
          return CompletableFuture.completedFuture(sayHi(name));
      }
  }
  

  • Dubbo 官方提供 compiler hacker，编译期自动重写同步方法，请在此讨论和跟进具体进展。
• 你也可以设置是否等待消息发出：
  • sent="true" 等待消息发出，消息发送失败将抛出异常。
  • sent="false" 不等待消息发出，将消息放入 IO 队列，即刻返回。

    <dubbo:method name="findFoo" async="true" sent="true" />
    

• 如果你只是想异步，完全忽略返回值，可以配置 return="false"，以减少 Future 对象的创建和管理成本：

  <dubbo:method name="findFoo" async="true" return="false" />