Spring Boot 整合 Dubbo

心城以北
1,267 阅读1分钟

持续创作，加速成长！这是我参与「掘金日新计划 · 10 月更文挑战」的第1天，点击查看活动详情

整合概述：

  • spring-boot 2.6.3
  • spring-cloud 2021.0.1.0
  • dubbo 2.7.15

接口定义 API 模块

通常我们开发 dubbo 服务接口，我们通常定义为一个公共模块，这样就可以在服务提供者应用、服务发布者应用分别实现和使用。

创建 api 模块定义接口信息。用于实验

public interface OrderService {

    String createOrder(CreateOrderDto createOrderDto);

    OrderDto queryOrder(QueryOrderDto queryOrderDto);
}

服务提供者 Provider

添加依赖 pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>rpc-dubbo</artifactId>
        <groupId>com.ssm</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>rpc-dubbo-consumer</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>


    <dependencies>
        <dependency>
            <groupId>com.ssm</groupId>
            <artifactId>rpc-dubbo-api</artifactId>
            <version>1.0-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>

        <!-- Spring Boot dependencies -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>${dubbo.version}</version>
        </dependency>

        <!-- Zookeeper dependencies -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-dependencies-zookeeper</artifactId>
            <version>${dubbo.version}</version>
            <type>pom</type>
            <exclusions>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-log4j12</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

核心配置文件 application.properties

我们在 application.properties中可以配置 zk 的注册信息以及 @DubboService 的服务类。

server.port=18080
spring.application.name=rpc-dubbo-consumer

##### Dubbo 相关配置 #####
#VM 参数: -Ddubbo.application.logger=log4j2
#Dubbo 服务名
dubbo.application.name=${spring.application.name}
#Zookeeper 地址
dubbo.registry.address=zookeeper://127.0.0.1:2181
#Dubbo 接口文件夹
dubbo.scan.base-packages=com.ssm.rpc.service.impl
#Dubbo Protocol
dubbo.protocol.name=dubbo
#Random Port
dubbo.protocol.port=-1
#Dubbo Registry
dubbo.registry.file = ${user.home}/dubbo-cache/${spring.application.name}/dubbo.cache

主启动类

为启动类，添加 @EnableDubbo注解，去扫描 dubbo.scan.base-packages 配置的包下面的 Dubbo 接口

package com.ssm.rpc;

import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@EnableDubbo
@SpringBootApplication
public class DubboConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(DubboConsumerApplication.class, args);
    }
}

dubbo 服务发布

dubbo 服务发布者 OrderServiceImpl 我们需要实现 OrderService 接口，然后声明为 DubboService 注解，标记为是一个 Dubbo 提供的服务类。

@DubboService
public class OrderServiceImpl implements OrderService {

    @Override
    public String createOrder(CreateOrderDto createOrderDto) {
        return "order_create_success";
    }

    @Override
    public OrderDto queryOrder(QueryOrderDto queryOrderDto) {
        OrderDto orderDto = new OrderDto();
        orderDto.setId(new Random().nextLong());
        return orderDto;
    }
}

服务消费者 Consumer

添加依赖 pom.xml

基础配置同服务提供者, 我们采用单测的方式，所以我们加一下单测的依赖即可。

<!-- 单元测试 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter</artifactId>
    <scope>test</scope>
</dependency>

主启动类

一个普通的 Spring Boot 启动方法即可

@SpringBootApplication
public class DubboConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(DubboConsumerApplication.class, args);
    }
}

核心配置文件 application.properties

核心配置文件 application.properties 只需要配置 dubbo 注册中心 zookeepr 地址即可

server.port=28080
spring.application.name=rpc-dubbo-consumer

##### Dubbo 相关配置 #####
#VM 参数: -Ddubbo.application.logger=log4j2
#Dubbo 服务名
dubbo.application.name=${spring.application.name}
#Zookeeper 地址
dubbo.registry.address=zookeeper://127.0.0.1:2181

单元测试文件

我们可以通过 @DubboReference 引用 OrderService 即可，然后就可以直接调用 OrderService 暴露的方法。

@SpringBootTest(classes = DubboConsumerApplication.class)
class OrderServiceTest {

    @DubboReference(check = false)
    private OrderService orderService;

    @Test
    void queryOrder() {
        OrderDto orderDto = orderService.queryOrder(new QueryOrderDto());
        Assert.notNull(orderDto, "order is null");
    }
}

测试结果：

queryOrder 查询通过，单测打钩。

FAQ 常见问题

dubbo 服务查询

查看方式我们可以直接查询 zookeeper 注册中心上的状态。我们可以通过 zooviewer 查看如下：

启动日志错误

解决方案：在启动参数中，增加 -Ddubbo.application.logger=log4j2 参数， Idea 中配置如下图所示

avatar
文章
阅读
粉丝