动态指定 IP 调用

在发起 Dubbo 调用之前指定本次调用的目标 IP

特性说明

在发起 RPC 请求的时候，需要指定本次调用的服务端，常用的场景包括消息回调、流量隔离等。

使用方式

插件依赖

首先，需要添加以下插件依赖到项目中

  1. <dependency>
  2.   <groupId>org.apache.dubbo.extensions</groupId>
  3.   <artifactId>dubbo-cluster-specify-address-dubbo3</artifactId>
  4.   <version>3.3.0</version>
  5. </dependency>

适配 Dubbo 2 版本

  1. <dependency>
  2.   <groupId>org.apache.dubbo.extensions</groupId>
  3.   <artifactId>dubbo-cluster-specify-address-dubbo2</artifactId>
  4.   <version>1.0.0</version>
  5. </dependency>

调用示例

  1. ReferenceConfig<DemoService> referenceConfig = new ReferenceConfig<>();
  2. // ... init
  3. DemoService demoService = referenceConfig.get();
  5. // for invoke
  6. // 1. find 10.10.10.10:20880 exist
  7. // 2. if not exist, create a invoker to 10.10.10.10:20880 if `needToCreate` is true (only support in Dubbo 3.x's implementation)
  8. UserSpecifiedAddressUtil.setAddress(new Address("10.10.10.10", 20880, true));
  9. demoService.sayHello("world");
  12. // for invoke
  13. // 1. find 10.10.10.10:any exist
  14. // 2. if not exist, create a invoker to 10.10.10.10:20880 if `needToCreate` is true (only support in Dubbo 3.x's implementation)
  15. UserSpecifiedAddressUtil.setAddress(new Address("10.10.10.10", 0, true));
  16. demoService.sayHello("world");

参数说明

指定 IP 调用的参数围绕 Address 对象展开。参数类型参考如下：

  1. package org.apache.dubbo.rpc.cluster.specifyaddress;
  3. public class Address implements Serializable {
  4.     // ip - priority: 3
  5.     private String ip;
  7.     // ip+port - priority: 2
  8.     private int port;
  10.     // address - priority: 1
  11.     private URL urlAddress;
  13.     private boolean needToCreate = false;
  15.     // ignore setter and getter
  16. }
  1. urlAddress 为最高优先级，如果指定了目标的 URL 地址，会优先使用该地址。(不再匹配后续)
  2. ip + port（非 0 端口） 为第二优先级，会从注册中心已经推送的地址中进行匹配。(不再匹配后续)
  3. ip 为第三优先级，会从注册中心已经推送的地址中进行匹配。

特别的，如果指定了 needToCreate 为 true，将会自动根据传入的参数构建一个 invoker。对于通过指定 ip ( + port ) 方式指定的地址， 将会自动使用注册中心中第一个地址的参数为模板进行创建；如果无地址将基于 Dubbo 协议自动创建。 如需定制创建 invoker 的逻辑请实现 org.apache.dubbo.rpc.cluster.specifyaddress.UserSpecifiedServiceAddressBuilder SPI 接口。（此功能仅Dubbo 3 实现支持）

在构建完 Address 参数每次请求前通过 UserSpecifiedAddressUtil 工具类传给 Dubbo 框架。

  1. package org.apache.dubbo.rpc.cluster.specifyaddress;
  3. public class UserSpecifiedAddressUtil {
  5.     public static void setAddress(Address address) { ... }
  7. }

必须每次都设置，而且设置后必须马上发起调用，如果出现拦截器报错（Dubbo 框架内 remove 此值是在选址过程进行的）建议设置 null 以避免 ThreadLocal 内存泄漏导致影响后续调用。

最后修改 September 13, 2024: Refactor website structure (#2860) (1a4b998f54b)