在springboot应用中使用dubbo-spring-boot-starter

最新推荐文章于 2025-05-15 21:32:18 发布

topN选手

最新推荐文章于 2025-05-15 21:32:18 发布

阅读量5.6k

点赞数

CC 4.0 BY-SA版权

文章标签： dubbo springboot maven dubbo-spring-boot-starter 分布式

本文链接：https://blog.youkuaiyun.com/qq_34784720/article/details/84628254

本文详细记录了在springboot应用中使用dubbo-spring-boot-starter的全过程，包括项目结构、provider和consumer的配置，以及运行注意事项。通过实例介绍了配置dubbo属性、启动类设置和依赖管理，特别强调了版本选择、启动类位置和配置文件加载的细节。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在springboot应用中使用dubbo-spring-boot-starter

开篇

dubbo-spring-boot-starter由于比较新，也没有详实的官方资料，网上乱七八糟各种抄袭的教程很多都不靠谱，让我踩了很多很多坑。在这里我将dubbo-spring-boot-starter的使用过程如实记录如下，突出实用，所有代码都经过验证，在github可以找到源码。

一. 项目结构介绍

项目为一个图书管理系统，前端使用vue.js单独建立工程，后台采用maven多模块的形式，父工程下建立子模块，模块名忽略掉前缀分别为controller（控制层），service（服务层），serviceI（服务接口层），dao（数据库操作层）。
controller层作为consumer，service层作为provider
项目结构如图：
在这里插入图片描述
这些模块之间具有严格的依赖关系：

controller只依赖于serviceI
service只依赖于serviceI和dao
serviceI和dao对其它模块没有依赖

父工程中引入dubbo-spring-boot-starter，版本为1.0.0。需要注意的是，要区分groupId

<groupId>com.alibaba.boot</groupId>

和

<groupId>com.alibaba.spring.boot</groupId>

这两个包内都有spring-boot-starter-parent，但并不是同一个组件，版本号也完全独立，之间的区别暂时还没研究，我们使用的是后者：

<dependency>
    <groupId>com.alibaba.spring.boot</groupId>
    <artifactId>dubbo-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

父工程的完整pom文件内容如下：

<?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>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.9.RELEASE</version>
    </parent>
    
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.bocsoft.library</groupId>
    <artifactId>library-boot</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>

    <modules>
        <module>library-boot-controller</module>
        <module>library-boot-serviceI</module>
        <module>library-boot-service</module>
        <module>library-boot-dao</module>
    </modules>
    
    <dependencies>
        <dependency>
            <groupId>commons-beanutils</groupId>
            <artifactId>commons-beanutils</artifactId>
            <version>1.9.2</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.6</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba.spring.boot</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>1.0.0</version>
        </dependency>
        <dependency>
            <groupId>org.apache.zookeeper</groupId>
            <artifactId>zookeeper</artifactId>
            <version>3.4.13</version>
            <exclusions>
                <exclusion>
                    <groupId>log4j</groupId>
                    <artifactId>log4j</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-log4j12</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.101tec</groupId>
            <artifactId>zkclient</artifactId>
            <version>0.11</version>
        </dependency>
        <dependency>
            <groupId>org.apache.curator</groupId>
            <artifactId>curator-framework</artifactId>
            <version>4.0.1</version>
        </dependency>
    </dependencies>
    
</project>

二. provider配置

service层作为provider，pom中引入web（必须要引，不然执行完启动类后就退出，不能作为一个web应用持续提供服务（有的博客说可以用web容器也可以不用web容器，但不用web容器怎样配置并没有找到资料）。也可以直接在父pom中引入web，这样controller和service层都不需要再单独引，但这样会给dao和serviceI层带来不必要的依赖）

service层引入web：

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

service层完整pom：

<?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>library-boot</artifactId>
        <groupId>com.bocsoft.library</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>library-boot-service</artifactId>
<dependencies>
    <dependency>
        <groupId>com.bocsoft.library</groupId>
        <artifactId>library-boot-serviceI</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>com.bocsoft.library</groupId>
        <artifactId>library-boot-dao</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

</project>

在配置文件application.yml中配置dubbo属性，完整配置文件：

mybatis:
  mapper-locations: classpath:mapper/*.xml
spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/library?characterEncoding=utf-8&useSSL=false
  dubbo:
    appname: library-boot-provider
    registry: zookeeper://127.0.0.1:2181
    protocol: dubbo
    port: 20880

pagehelper:
  helperDialect: mysql
  reasonable: true
  pageSizeZero: true
  params: count=countSql
  supportMethodsArguments: true

service层新建启动类，并使用@EnableDubboConfiguration启用dubbo配置：

@SpringBootApplication
@EnableDubboConfiguration
public class ProviderApplication {
    public static void main(String[] args) {
        SpringApplication.run(ProviderApplication.class, args);
    }
}

service层（实现类层，并非接口层）的实现类使用dubbo自带的service和springframework自带的service双重修饰：

@com.alibaba.dubbo.config.annotation.Service
@Service
public class BookServiceImpl implements BookService {
    @Autowired
    BookMapper bookMapper;
    ···
}

其中的坑：

有的资料只使用了@com.alibaba.dubbo.config.annotation.Service，取消了@org.springframework.stereotype.Service，但亲测不能正常运行；
有的资料配置了interfaceClass属性或version属性，如：

@com.alibaba.dubbo.config.annotation.Service(interfaceClass = BookService.class, version = "1.0.0")

亲测interfaceClass属性不必要，配不配置不影响；version版本号属性配置之后反而报错找不到实现类，因为在dubbo中注册的service名称变成了"service名称.版本号"，应该需要进一步配置consumer才能使用，对一般项目没有必要，我们这里直接不配置版本号。

三. consumer配置

controller层作为consumer，首先在pom中引入web，完整pom文件：

<?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>library-boot</artifactId>
        <groupId>com.bocsoft.library</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>library-boot-controller</artifactId>
    <packaging>war</packaging>
    <name>library-boot-controller Maven Webapp</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.bocsoft.library</groupId>
            <artifactId>library-boot-serviceI</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
</project>

然后在配置文件application.yml中配置dubbo，完整配置文件：

server:
  port: 8090
spring:
  dubbo:
    appname: library-boot-consumer
    registry: zookeeper://127.0.0.1:2181
    protocol: dubbo

controller中需要自动注入service的地方，采用dubbo中的@com.alibaba.dubbo.config.annotation.Reference注解取代springframework中的@Autowired注解：

@RestController
@RequestMapping(value = "/library/book")
public class BookController {
    @Reference(check = false)
    BookService bookService;

创建启动类并用@EnableDubboConfiguration修饰：

@org.springframework.boot.autoconfigure.SpringBootApplication
@EnableDubboConfiguration
public class ConsumerApplication {
    public static void main(String[] args){
        SpringApplication.run(ConsumerApplication.class, args);
    }
}

四. 运行与其他说明

采用zookeeper作为注册中心，首先启动zookeeper，确保地址与端口号与配置文件中的配置一致；然后启动provider（即service中的启动类），最后启动consumer（即controller中的启动类）。
SpringBoot中的启动类只会扫描自己所在的包及其子包下面的组件，因此启动类需要放到controller或service类的上层目录中，但不要直接放在java目录下，如图：

或在启动类上使用@ComponentScan显式声明需要扫描的包。
配置文件位置：
springboot启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件：
（1）项目的根目录下
（2）项目根目录中的config目录下
（3）项目的resources目录下（即classpath路径下）
（4）项目resources目录中config目录下
以上是按照优先级从高到低的顺序，所有位置的文件都会被加载，高优先级配置内容会覆盖低优先级配置内容（即如果有配置已经被加载，则后加载的不起作用），也可以通过配置spring.config.location来改变默认配置。我们这里将application.yml配置文件放在resources目录下，可以自动加载。
注意版本问题，尤其是还使用了mybatis，pagehelper分页插件的，版本的坑很多。
最后，在springboot中使用dubbo，不一定采用starter的形式，也可以采用springmvc中传统的xml方式配置dubbo，然后在consumer和provider的启动类上分别使用@ImportResource引入dubbo的xml配置，启动即可，亲测可用，但不如使用starter简洁，更符合boot的风格。

以上