Dubbo3 API配置

以API 配置的方式來(lái)配置你的 Dubbo 應(yīng)用

通過(guò)API編碼方式組裝配置，啟動(dòng)Dubbo，發(fā)布及訂閱服務(wù)。此方式可以支持動(dòng)態(tài)創(chuàng)建ReferenceConfig/ServiceConfig，結(jié)合泛化調(diào)用可以滿足API Gateway或測(cè)試平臺(tái)的需要。

API 屬性與XML配置項(xiàng)一一對(duì)應(yīng)，各屬性含義請(qǐng)參見(jiàn)：XML配置參考手冊(cè)，比如：ApplicationConfig.setName("xxx") 對(duì)應(yīng) 

API使用范圍說(shuō)明：API 僅用于 OpenAPI, ESB, Test, Mock, Gateway 等系統(tǒng)集成，普通服務(wù)提供方或消費(fèi)方，請(qǐng)采用XML 配置 或 注解配置 或 屬性配置 方式使用 Dubbo

參考API示例

服務(wù)提供者

通過(guò)ServiceConfig暴露服務(wù)接口，發(fā)布服務(wù)接口到注冊(cè)中心。

注意：為了更好支持Dubbo3的應(yīng)用級(jí)服務(wù)發(fā)現(xiàn)，推薦使用新的DubboBootstrap API。

import org.apache.dubbo.config.ApplicationConfig;
import org.apache.dubbo.config.RegistryConfig;
import org.apache.dubbo.config.ProviderConfig;
import org.apache.dubbo.config.ServiceConfig;
import com.xxx.DemoService;
import com.xxx.DemoServiceImpl;

public class DemoProvider {
    public static void main(String[] args) {
        // 服務(wù)實(shí)現(xiàn)
        DemoService demoService = new DemoServiceImpl();

        // 當(dāng)前應(yīng)用配置
        ApplicationConfig application = new ApplicationConfig();
        application.setName("demo-provider");

        // 連接注冊(cè)中心配置
        RegistryConfig registry = new RegistryConfig();
        registry.setAddress("zookeeper://10.20.130.230:2181");

        // 服務(wù)提供者協(xié)議配置
        ProtocolConfig protocol = new ProtocolConfig();
        protocol.setName("dubbo");
        protocol.setPort(12345);
        protocol.setThreads(200);

        // 注意：ServiceConfig為重對(duì)象，內(nèi)部封裝了與注冊(cè)中心的連接，以及開(kāi)啟服務(wù)端口
        // 服務(wù)提供者暴露服務(wù)配置
        ServiceConfig<DemoService> service = new ServiceConfig<DemoService>(); // 此實(shí)例很重，封裝了與注冊(cè)中心的連接，請(qǐng)自行緩存，否則可能造成內(nèi)存和連接泄漏
        service.setApplication(application);
        service.setRegistry(registry); // 多個(gè)注冊(cè)中心可以用setRegistries()
        service.setProtocol(protocol); // 多個(gè)協(xié)議可以用setProtocols()
        service.setInterface(DemoService.class);
        service.setRef(demoService);
        service.setVersion("1.0.0");

        // 暴露及注冊(cè)服務(wù)
        service.export();
        
        // 掛起等待(防止進(jìn)程退出）
        System.in.read();
    }
}

服務(wù)消費(fèi)者

通過(guò)ReferenceConfig引用遠(yuǎn)程服務(wù)，從注冊(cè)中心訂閱服務(wù)接口。

注意：為了更好支持Dubbo3的應(yīng)用級(jí)服務(wù)發(fā)現(xiàn)，推薦使用新的DubboBootstrap API。

import org.apache.dubbo.config.ApplicationConfig;
import org.apache.dubbo.config.RegistryConfig;
import org.apache.dubbo.config.ConsumerConfig;
import org.apache.dubbo.config.ReferenceConfig;
import com.xxx.DemoService;

public class DemoConsumer {
    public static void main(String[] args) {
        // 當(dāng)前應(yīng)用配置
        ApplicationConfig application = new ApplicationConfig();
        application.setName("demo-consumer");

        // 連接注冊(cè)中心配置
        RegistryConfig registry = new RegistryConfig();
        registry.setAddress("zookeeper://10.20.130.230:2181");

        // 注意：ReferenceConfig為重對(duì)象，內(nèi)部封裝了與注冊(cè)中心的連接，以及與服務(wù)提供方的連接
        // 引用遠(yuǎn)程服務(wù)
        ReferenceConfig<DemoService> reference = new ReferenceConfig<DemoService>(); // 此實(shí)例很重，封裝了與注冊(cè)中心的連接以及與提供者的連接，請(qǐng)自行緩存，否則可能造成內(nèi)存和連接泄漏
        reference.setApplication(application);
        reference.setRegistry(registry); // 多個(gè)注冊(cè)中心可以用setRegistries()
        reference.setInterface(DemoService.class);
        reference.setVersion("1.0.0");

        // 和本地bean一樣使用demoService
        // 注意：此代理對(duì)象內(nèi)部封裝了所有通訊細(xì)節(jié)，對(duì)象較重，請(qǐng)緩存復(fù)用
        DemoService demoService = reference.get();
        demoService.sayHello("Dubbo");
    }
}

Bootstrap API

通過(guò)DubboBootstrap API可以減少重復(fù)配置，更好控制啟動(dòng)過(guò)程，支持批量發(fā)布/訂閱服務(wù)接口，還可以更好支持Dubbo3的應(yīng)用級(jí)服務(wù)發(fā)現(xiàn)。

import org.apache.dubbo.config.bootstrap.DubboBootstrap;
import org.apache.dubbo.config.ApplicationConfig;
import org.apache.dubbo.config.RegistryConfig;
import org.apache.dubbo.config.ProviderConfig;
import org.apache.dubbo.config.ServiceConfig;
import com.xxx.DemoService;
import com.xxx.DemoServiceImpl;

public class DemoProvider {
    public static void main(String[] args) {

        ConfigCenterConfig configCenter = new ConfigCenterConfig();
        configCenter.setAddress("zookeeper://127.0.0.1:2181");

        // 服務(wù)提供者協(xié)議配置
        ProtocolConfig protocol = new ProtocolConfig();
        protocol.setName("dubbo");
        protocol.setPort(12345);
        protocol.setThreads(200);

        // 注意：ServiceConfig為重對(duì)象，內(nèi)部封裝了與注冊(cè)中心的連接，以及開(kāi)啟服務(wù)端口
        // 服務(wù)提供者暴露服務(wù)配置
        ServiceConfig<DemoService> demoServiceConfig = new ServiceConfig<>();
        demoServiceConfig.setInterface(DemoService.class);
        demoServiceConfig.setRef(new DemoServiceImpl());
        demoServiceConfig.setVersion("1.0.0");
        
        // 第二個(gè)服務(wù)配置
        ServiceConfig<FooService> fooServiceConfig = new ServiceConfig<>();
        fooServiceConfig.setInterface(FooService.class);
        fooServiceConfig.setRef(new FooServiceImpl());
        fooServiceConfig.setVersion("1.0.0");
        
        ...

        // 通過(guò)DubboBootstrap簡(jiǎn)化配置組裝，控制啟動(dòng)過(guò)程
        DubboBootstrap.getInstance()
                .application("demo-provider") // 應(yīng)用配置
                .registry(new RegistryConfig("zookeeper://127.0.0.1:2181")) // 注冊(cè)中心配置
                .protocol(protocol) // 全局默認(rèn)協(xié)議配置
                .service(demoServiceConfig) // 添加ServiceConfig
                .service(fooServiceConfig)
                .start()    // 啟動(dòng)Dubbo
                .await();   // 掛起等待(防止進(jìn)程退出）
    }
}

import org.apache.dubbo.config.bootstrap.DubboBootstrap;
import org.apache.dubbo.config.ApplicationConfig;
import org.apache.dubbo.config.RegistryConfig;
import org.apache.dubbo.config.ProviderConfig;
import org.apache.dubbo.config.ServiceConfig;
import com.xxx.DemoService;
import com.xxx.DemoServiceImpl;

public class DemoConsumer {
    public static void main(String[] args) {

        // 引用遠(yuǎn)程服務(wù)
        ReferenceConfig<DemoService> demoServiceReference = new ReferenceConfig<DemoService>(); 
        demoServiceReference.setInterface(DemoService.class);
        demoServiceReference.setVersion("1.0.0");
        
        ReferenceConfig<FooService> fooServiceReference = new ReferenceConfig<FooService>(); 
        fooServiceReference.setInterface(FooService.class);
        fooServiceReference.setVersion("1.0.0");

        // 通過(guò)DubboBootstrap簡(jiǎn)化配置組裝，控制啟動(dòng)過(guò)程
        DubboBootstrap bootstrap = DubboBootstrap.getInstance();
        bootstrap.application("demo-consumer") // 應(yīng)用配置
                .registry(new RegistryConfig("zookeeper://127.0.0.1:2181")) // 注冊(cè)中心配置
                .reference(demoServiceReference) // 添加ReferenceConfig
                .service(fooServiceReference)
                .start();    // 啟動(dòng)Dubbo

        ...
        
        // 和本地bean一樣使用demoService
        // 通過(guò)Interface獲取遠(yuǎn)程服務(wù)接口代理，不需要依賴(lài)ReferenceConfig對(duì)象
        DemoService demoService = DubboBootstrap.getInstance().getCache().get(DemoService.class);
        demoService.sayHello("Dubbo");

        FooService fooService = DubboBootstrap.getInstance().getCache().get(FooService.class);
        fooService.greeting("Dubbo");
    }
    
}

其它配置

API配置能力與XML配置是等價(jià)的，其它的各種配置都可以用API設(shè)置。

下面只列出不同的地方，其它參見(jiàn)上面的寫(xiě)法。

基本配置

可以在DubboBootstrap中設(shè)置全局基本配置，包括應(yīng)用配置、協(xié)議配置、注冊(cè)中心、配置中心、元數(shù)據(jù)中心、模塊、監(jiān)控、SSL、provider配置、consumer配置等。

// 注冊(cè)中心
RegistryConfig registry = new RegistryConfig();
registry.setAddress("zookeeper://192.168.10.1:2181");
...
  
// 服務(wù)提供者協(xié)議配置
ProtocolConfig protocol = new ProtocolConfig();
protocol.setName("dubbo");
protocol.setPort(12345);
protocol.setThreads(200);
...
  
// 配置中心
ConfigCenterConfig configCenter = new ConfigCenterConfig();
configCenter.setAddress("zookeeper://192.168.10.2:2181");
...
  
// 元數(shù)據(jù)中心
MetadataReportConfig metadataReport = new MetadataReportConfig();
metadataReport.setAddress("zookeeper://192.168.10.3:2181");
...
  
// Metrics
MetricsConfig metrics = new MetricsConfig();
metrics.setProtocol("dubbo");
...
  
// SSL
SslConfig ssl = new SslConfig();
ssl.setServerKeyCertChainPath("/path/ssl/server-key-cert-chain");
ssl.setServerPrivateKeyPath("/path/ssl/server-private-key");
...
  
// Provider配置（ServiceConfig默認(rèn)配置）
ProviderConfig provider = new ProviderConfig();
provider.setGroup("demo");
provider.setVersion("1.0.0");
...
  
// Consumer配置（ReferenceConfig默認(rèn)配置）
ConsumerConfig consumer = new ConsumerConfig();
consumer.setGroup("demo");
consumer.setVersion("1.0.0");
consumer.setTimeout(2000);
...
  
DubboBootstrap.getInstance()
    .application("demo-app")
    .registry(registry)
    .protocol(protocol)
    .configCenter(configCenter)
    .metadataReport(metadataReport)
    .module(new ModuleConfig("module"))
    .metrics(metrics)
  	.ssl(ssl)
  	.provider(provider)
  	.consumer(consumer)
  	...
  	.start();

方法級(jí)設(shè)置

...
 
// 方法級(jí)配置
List<MethodConfig> methods = new ArrayList<MethodConfig>();
MethodConfig method = new MethodConfig();
method.setName("sayHello");
method.setTimeout(10000);
method.setRetries(0);
methods.add(method);
 
// 引用遠(yuǎn)程服務(wù)
ReferenceConfig<DemoService> reference = new ReferenceConfig<DemoService>(); // 此實(shí)例很重，封裝了與注冊(cè)中心的連接以及與提供者的連接，請(qǐng)自行緩存，否則可能造成內(nèi)存和連接泄漏
...
reference.setMethods(methods); // 設(shè)置方法級(jí)配置
 
...

點(diǎn)對(duì)點(diǎn)直連

...

// 此實(shí)例很重，封裝了與注冊(cè)中心的連接以及與提供者的連接，請(qǐng)自行緩存，否則可能造成內(nèi)存和連接泄漏
ReferenceConfig<DemoService> reference = new ReferenceConfig<DemoService>(); 
// 如果點(diǎn)對(duì)點(diǎn)直連，可以用reference.setUrl()指定目標(biāo)地址，設(shè)置url后將繞過(guò)注冊(cè)中心，
// 其中，協(xié)議對(duì)應(yīng)provider.setProtocol()的值，端口對(duì)應(yīng)provider.setPort()的值，
// 路徑對(duì)應(yīng)service.setPath()的值，如果未設(shè)置path，缺省path為接口名
reference.setUrl("dubbo://10.20.130.230:20880/com.xxx.DemoService"); 
 
...