API 配置

以API 配置的方式来配置你的 Dubbo 应用

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;
  8. // 服务实现
  9. XxxService xxxService = new XxxServiceImpl();
  11. // 当前应用配置
  12. ApplicationConfig application = new ApplicationConfig();
  13. application.setName("xxx");
  15. // 连接注册中心配置
  16. RegistryConfig registry = new RegistryConfig();
  17. registry.setAddress("10.20.130.230:9090");
  18. registry.setUsername("aaa");
  19. registry.setPassword("bbb");
  21. // 服务提供者协议配置
  22. ProtocolConfig protocol = new ProtocolConfig();
  23. protocol.setName("dubbo");
  24. protocol.setPort(12345);
  25. protocol.setThreads(200);
  27. // 注意：ServiceConfig为重对象，内部封装了与注册中心的连接，以及开启服务端口
  29. // 服务提供者暴露服务配置
  30. ServiceConfig<XxxService> service = new ServiceConfig<XxxService>(); // 此实例很重，封装了与注册中心的连接，请自行缓存，否则可能造成内存和连接泄漏
  31. service.setApplication(application);
  32. service.setRegistry(registry); // 多个注册中心可以用setRegistries()
  33. service.setProtocol(protocol); // 多个协议可以用setProtocols()
  34. service.setInterface(XxxService.class);
  35. service.setRef(xxxService);
  36. service.setVersion("1.0.0");
  38. // 暴露及注册服务
  39. 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;
  7. // 当前应用配置
  8. ApplicationConfig application = new ApplicationConfig();
  9. application.setName("yyy");
  11. // 连接注册中心配置
  12. RegistryConfig registry = new RegistryConfig();
  13. registry.setAddress("10.20.130.230:9090");
  14. registry.setUsername("aaa");
  15. registry.setPassword("bbb");
  17. // 注意：ReferenceConfig为重对象，内部封装了与注册中心的连接，以及与服务提供方的连接
  19. // 引用远程服务
  20. ReferenceConfig<XxxService> reference = new ReferenceConfig<XxxService>(); // 此实例很重，封装了与注册中心的连接以及与提供者的连接，请自行缓存，否则可能造成内存和连接泄漏
  21. reference.setApplication(application);
  22. reference.setRegistry(registry); // 多个注册中心可以用setRegistries()
  23. reference.setInterface(XxxService.class);
  24. reference.setVersion("1.0.0");
  26. // 和本地bean一样使用xxxService
  27. XxxService xxxService = reference.get(); // 注意：此代理对象内部封装了所有通讯细节，对象较重，请缓存复用

特殊场景

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

方法级设置

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

点对点直连

  2. ...
  4. ReferenceConfig<XxxService> reference = new ReferenceConfig<XxxService>(); // 此实例很重，封装了与注册中心的连接以及与提供者的连接，请自行缓存，否则可能造成内存和连接泄漏
  5. // 如果点对点直连，可以用reference.setUrl()指定目标地址，设置url后将绕过注册中心，
  6. // 其中，协议对应provider.setProtocol()的值，端口对应provider.setPort()的值，
  7. // 路径对应service.setPath()的值，如果未设置path，缺省path为接口名
  8. reference.setUrl("dubbo://10.20.130.230:20880/com.xxx.XxxService"); 
  10. ...
  1. API使用范围说明：API 仅用于 OpenAPI, ESB, Test, Mock 等系统集成，普通服务提供方或消费方，请采用XML 配置方式使用 Dubbo ↩︎