API 配置

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

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

    服务提供者

    import org.apache.dubbo.rpc.config.ApplicationConfig;
    import org.apache.dubbo.rpc.config.RegistryConfig;
    import org.apache.dubbo.rpc.config.ProviderConfig;
    import org.apache.dubbo.rpc.config.ServiceConfig;
    import com.xxx.XxxService;
    import com.xxx.XxxServiceImpl;
     
    // 服务实现
    XxxService xxxService = new XxxServiceImpl();
     
    // 当前应用配置
    ApplicationConfig application = new ApplicationConfig();
    application.setName("xxx");
     
    // 连接注册中心配置
    RegistryConfig registry = new RegistryConfig();
    registry.setAddress("10.20.130.230:9090");
    registry.setUsername("aaa");
    registry.setPassword("bbb");
     
    // 服务提供者协议配置
    ProtocolConfig protocol = new ProtocolConfig();
    protocol.setName("dubbo");
    protocol.setPort(12345);
    protocol.setThreads(200);
     
    // 注意:ServiceConfig为重对象,内部封装了与注册中心的连接,以及开启服务端口
     
    // 服务提供者暴露服务配置
    ServiceConfig<XxxService> service = new ServiceConfig<XxxService>(); // 此实例很重,封装了与注册中心的连接,请自行缓存,否则可能造成内存和连接泄漏
    service.setApplication(application);
    service.setRegistry(registry); // 多个注册中心可以用setRegistries()
    service.setProtocol(protocol); // 多个协议可以用setProtocols()
    service.setInterface(XxxService.class);
    service.setRef(xxxService);
    service.setVersion("1.0.0");
     
    // 暴露及注册服务
    service.export();
    

    服务消费者

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

    特殊场景

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

    方法级设置

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

    点对点直连

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

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