Configuration Manual on Apache Dubbo

Spring Boot

Mon, 01 Jan 0001 00:00:00 +0000

For details about Spring Boot annotations and basic usage, please refer to User Guide - Spring Boot. Below are the configuration details and starter list supported by Spring Boot.

application.yaml

Below is the list of configuration components supported by the Dubbo framework, which can be specified in the Spring Boot configuration file.

Configuration Example

dubbo:
 application:
 name: dubbo-springboot-demo-provider
 logger: slf4j
 protocol:
 name: dubbo
 port: 50052
 registry:
 address: nacos://${nacos.address:127.0.0.1}:8848?username=nacos&password=nacos

dubbo

dubbo.metrics

dubbo.tracing

Starter List

dubbo-spring-boot-starter

Here are some version mappings of the dubbo-spring-boot-starter that correspond to Spring Boot and JDK dependencies:

XML Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Dubbo has a custom configuration component based on Spring Schema, and the configuration options supported by XML correspond to those described in the configuration reference manual. Please refer to the examples used in this article at dubbo-samples-spring-xml.

Complete XML Example

Service Provider

Define Service Interface

DemoService.java：

package org.apache.dubbo.demo;

public interface DemoService {
 String sayHello(String name);
}

Implement Interface in Service Provider

DemoServiceImpl.java：

package org.apache.dubbo.demo.provider;
import org.apache.dubbo.demo.DemoService;

public class DemoServiceImpl implements DemoService {
 public String sayHello(String name) {
 return "Hello " + name;
 }
}

Declare Service Exposure with Spring Configuration

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:dubbo="http://dubbo.apache.org/schema/dubbo"
 xmlns="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
 http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
 <context:property-placeholder/>

 <dubbo:application name="demo-provider"/>

 <dubbo:registry address="zookeeper://${zookeeper.address:127.0.0.1}:2181"/>

 <dubbo:provider token="true"/>

 <bean id="demoService" class="org.apache.dubbo.samples.basic.impl.DemoServiceImpl"/>

 <dubbo:service interface="org.apache.dubbo.samples.basic.api.DemoService" ref="demoService"/>

</beans>

Load Spring Configuration

public class Application {
 public static void main(String[] args) throws InterruptedException {
 ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("spring/dubbo-demo-provider.xml");
 context.start();

 System.out.println("dubbo service started");
 // to hang up main thread
 new CountDownLatch(1).await();
 }
}

Service Consumer

Reference Remote Service through Spring Configuration

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:dubbo="http://dubbo.apache.org/schema/dubbo"
 xmlns="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
 http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
 <context:property-placeholder/>

 <dubbo:application name="demo-consumer"/>

 <dubbo:registry address="zookeeper://${zookeeper.address:127.0.0.1}:2181"/>

 <dubbo:reference id="demoService" check="true" interface="org.apache.dubbo.samples.basic.api.DemoService"/>

</beans>

Load Spring Configuration and Call Remote Service

public class Application {
 public static void main(String[] args) throws IOException {
 ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("spring/dubbo-demo-consumer.xml");
 context.start();
 GreetingsService greetingsService = (GreetingsService) context.getBean("greetingsService");

 String message = greetingsService.sayHi("dubbo");
 System.out.println("Receive result ======> " + message);
 System.in.read();
 System.exit(0);
 }
}

More Examples

Version and Group

<dubbo:service interface="com.foo.BarService" version="1.0.0" />
<dubbo:service interface="org.apache.dubbo.example.service.DemoService" group="demo2"/>

Cluster Fault Tolerance

Configure failover retry count: