API 配置

API 属性与配置项一对一,各属性含义,请参见:配置参考手册,比如:ApplicationConfig.setName("xxx") 对应 <dubbo:application name="xxx" /> [1]

服务提供者

  1. import org.apache.dubbo.rpc.config.ApplicationConfig;
  2. import org.apache.dubbo.rpc.config.RegistryConfig;
  3. import org.apache.dubbo.rpc.config.ProviderConfig;
  4. import org.apache.dubbo.rpc.config.ServiceConfig;
  5. import com.xxx.XxxService;
  6. import com.xxx.XxxServiceImpl;
  7. // 服务实现
  8. XxxService xxxService = new XxxServiceImpl();
  9. // 当前应用配置
  10. ApplicationConfig application = new ApplicationConfig();
  11. application.setName("xxx");
  12. // 连接注册中心配置
  13. RegistryConfig registry = new RegistryConfig();
  14. registry.setAddress("10.20.130.230:9090");
  15. registry.setUsername("aaa");
  16. registry.setPassword("bbb");
  17. // 服务提供者协议配置
  18. ProtocolConfig protocol = new ProtocolConfig();
  19. protocol.setName("dubbo");
  20. protocol.setPort(12345);
  21. protocol.setThreads(200);
  22. // 注意:ServiceConfig为重对象,内部封装了与注册中心的连接,以及开启服务端口
  23. // 服务提供者暴露服务配置
  24. ServiceConfig<XxxService> service = new ServiceConfig<XxxService>(); // 此实例很重,封装了与注册中心的连接,请自行缓存,否则可能造成内存和连接泄漏
  25. service.setApplication(application);
  26. service.setRegistry(registry); // 多个注册中心可以用setRegistries()
  27. service.setProtocol(protocol); // 多个协议可以用setProtocols()
  28. service.setInterface(XxxService.class);
  29. service.setRef(xxxService);
  30. service.setVersion("1.0.0");
  31. // 暴露及注册服务
  32. service.export();

服务消费者

  1. import org.apache.dubbo.rpc.config.ApplicationConfig;
  2. import org.apache.dubbo.rpc.config.RegistryConfig;
  3. import org.apache.dubbo.rpc.config.ConsumerConfig;
  4. import org.apache.dubbo.rpc.config.ReferenceConfig;
  5. import com.xxx.XxxService;
  6. // 当前应用配置
  7. ApplicationConfig application = new ApplicationConfig();
  8. application.setName("yyy");
  9. // 连接注册中心配置
  10. RegistryConfig registry = new RegistryConfig();
  11. registry.setAddress("10.20.130.230:9090");
  12. registry.setUsername("aaa");
  13. registry.setPassword("bbb");
  14. // 注意:ReferenceConfig为重对象,内部封装了与注册中心的连接,以及与服务提供方的连接
  15. // 引用远程服务
  16. ReferenceConfig<XxxService> reference = new ReferenceConfig<XxxService>(); // 此实例很重,封装了与注册中心的连接以及与提供者的连接,请自行缓存,否则可能造成内存和连接泄漏
  17. reference.setApplication(application);
  18. reference.setRegistry(registry); // 多个注册中心可以用setRegistries()
  19. reference.setInterface(XxxService.class);
  20. reference.setVersion("1.0.0");
  21. // 和本地bean一样使用xxxService
  22. XxxService xxxService = reference.get(); // 注意:此代理对象内部封装了所有通讯细节,对象较重,请缓存复用

特殊场景

下面只列出不同的地方,其它参见上面的写法

方法级设置

  1. ...
  2. // 方法级配置
  3. List<MethodConfig> methods = new ArrayList<MethodConfig>();
  4. MethodConfig method = new MethodConfig();
  5. method.setName("createXxx");
  6. method.setTimeout(10000);
  7. method.setRetries(0);
  8. methods.add(method);
  9. // 引用远程服务
  10. ReferenceConfig<XxxService> reference = new ReferenceConfig<XxxService>(); // 此实例很重,封装了与注册中心的连接以及与提供者的连接,请自行缓存,否则可能造成内存和连接泄漏
  11. ...
  12. reference.setMethods(methods); // 设置方法级配置
  13. ...

点对点直连

  1. ...
  2. ReferenceConfig<XxxService> reference = new ReferenceConfig<XxxService>(); // 此实例很重,封装了与注册中心的连接以及与提供者的连接,请自行缓存,否则可能造成内存和连接泄漏
  3. // 如果点对点直连,可以用reference.setUrl()指定目标地址,设置url后将绕过注册中心,
  4. // 其中,协议对应provider.setProtocol()的值,端口对应provider.setPort()的值,
  5. // 路径对应service.setPath()的值,如果未设置path,缺省path为接口名
  6. reference.setUrl("dubbo://10.20.130.230:20880/com.xxx.XxxService");
  7. ...

  1. API使用范围说明:API 仅用于 OpenAPI, ESB, Test, Mock 等系统集成,普通服务提供方或消费方,请采用XML 配置方式使用 Dubbo ↩︎