Spring Boot 快速开发 Dubbo 服务

示例演示了如何使用 Dubbo Spring Boot Starter 方式快速开发 Dubbo 应用。

此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档,请参阅最新版本

Dubbo 还提供了包括XML、API 等多种启动与接入方式,更多开发方式和配置细节可参见配置手册

下载示例代码

完整示例代码在 dubbo-samples

  1. 下载源码
git clone -b master https://github.com/apache/dubbo-samples.git
  1. 进入示例目录
cd dubbo-samples/dubbo-samples-spring-boot
ls # 查看目录结构

快速运行示例

  1. 编译 Provider 在 dubbo-samples-spring-boot 目录,进入 dubbo-samples-spring-boot-provider 目录并执行 maven 命令
cd ./dubbo-samples-spring-boot-provider
mvn clean package
  1. 运行 Provider
java -jar ./target/dubbo-samples-spring-boot-provider-1.0-SNAPSHOT.jar
  1. 编译 Consumer 进入 dubbo-samples-spring-boot-consumer 目录并执行 maven 命令
cd ../dubbo-samples-spring-boot-consumer
mvn clean package
  1. 运行 consumer
java -jar ./target/dubbo-samples-spring-boot-consumer-1.0-SNAPSHOT.jar

详细解释

定义服务接口

dubbo-samples-spring-boot-interface/DemoService.java

package org.apache.dubbo.samples.basic.api;

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

提供方实现接口并暴露服务

dubbo-samples-spring-boot-provider/DemoServiceImpl.java

@DubboService
public class DemoServiceImpl implements DemoService {
    @Override
    public String sayHello(String name) {
        System.out.println("Hello " + name + ", request from consumer: " + RpcContext.getContext().getRemoteAddress());
        return "Hello " + name;
    }
}

配置 application.yml 文件

dubbo-samples-spring-boot-provider/resources/application.yml

dubbo:
  application:
    name: dubbo-springboot-demo-provider
  protocol:
    name: dubbo
    port: -1
  registry:
    id: zk-registry
    address: zookeeper://127.0.0.1:2181
  config-center:
    address: zookeeper://127.0.0.1:2181
  metadata-report:
    address: zookeeper://127.0.0.1:2181

定义 Spring Boot 主函数

dubbo-samples-spring-boot-provider/ProviderApplication.java

@SpringBootApplication
@EnableDubbo
public class ProviderApplication {
    public static void main(String[] args) throws Exception {
        new EmbeddedZooKeeper(2181, false).start();

        SpringApplication.run(ProviderApplication.class, args);
        System.out.println("dubbo service started");
        new CountDownLatch(1).await();
    }
}

其中,@EnableDubbo 必须配置。

引用远程服务

dubbo-samples-spring-boot-consumer/ConsumerApplication.java

public class ConsumerApplication {
    @DubboReference
    private DemoService demoService;
}

定义 application.yml

dubbo-samples-spring-boot-consumer/application.yml

dubbo:
  application:
    name: dubbo-springboot-demo-consumer
  protocol:
    name: dubbo
    port: -1
  registry:
    id: zk-registry
    address: zookeeper://127.0.0.1:2181
  config-center:
    address: zookeeper://127.0.0.1:2181
  metadata-report:
    address: zookeeper://127.0.0.1:2181

加载 Spring 配置,并调用远程服务

dubbo-samples-spring-boot-consumer/ConsumerApplication.java

@SpringBootApplication
@Service
@EnableDubbo
public class ConsumerApplication {
    @DubboReference
    private DemoService demoService;

    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(ConsumerApplication.class, args);
        ConsumerApplication application = context.getBean(ConsumerApplication.class);
        String result = application.doSayHello("world");
        System.out.println("result: " + result);
    }
}

其中,@EnableDubbo 必须配置。


最后修改 August 11, 2022: Update triple docs (#1371) (d7b8f42)