SpringBoot 集成 Dubbo + zookeeper全注解方式（各种坑的说明）

最新推荐文章于 2024-06-06 19:22:16 发布

置顶诗人与黑客

最新推荐文章于 2024-06-06 19:22:16 发布

阅读量2.1k

点赞数 1

本文链接：https://blog.csdn.net/qq_41899174/article/details/86751255

版权

java 同时被 3 个专栏收录

15 篇文章 0 订阅

订阅专栏

springBoot

4 篇文章 0 订阅

订阅专栏

dubbo

2 篇文章 0 订阅

订阅专栏

大家知道springBoot发明的初衷是为了减少xml的配置，而dubbo的传统方式就是xml配置，所以既然用了springBoot就应该遵循它的规则，在集成dubbo时改为全编程式注解的方式。下面我来为大家详细介绍集成的步骤：

一：安装zookeeper

首先去官网下载zookeeper，下载地址为：http://mirror.bit.edu.cn/apache/zookeeper/；我选择的版本是 zookeeper-3.5.4；下载完以后解压到本地目录，然后复制conf目录下的zoo_sample.cfg文件，并改名为zoo.cfg。在安装目录下新建data和log文件夹，随后编辑该文件：

注意：dataDir和dataLogDir是zookeeper解压的本地目录，视自己放的位置而更改。

# The number of milliseconds of each tick
tickTime=2000
# The number of ticks that the initial 
# synchronization phase can take
initLimit=10
# The number of ticks that can pass between 
# sending a request and getting an acknowledgement
syncLimit=5
# the directory where the snapshot is stored.
# do not use /tmp for storage, /tmp here is just 
# example sakes.
dataDir=C:/zookeeper-3.4.13/data
dataLogDir=C:/zookeeper-3.4.13/log

# the port at which the clients will connect
clientPort=2181
# the maximum number of client connections.
# increase this if you need to handle more clients
#maxClientCnxns=60
#
# Be sure to read the maintenance section of the 
# administrator guide before turning on autopurge.
#
# http://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_maintenance
#
# The number of snapshots to retain in dataDir
#autopurge.snapRetainCount=3
# Purge task interval in hours
# Set to "0" to disable auto purge feature
#autopurge.purgeInterval=1

完成以上步骤后就可以进入C:\zookeeper-3.4.13\bin 双击zkserver.cmd启动zookper。

二：创建服务提供者工程

建议使用idea工具！！！我先是在本地磁盘建了一个文件夹springBoot-dubbo，然后选择File - open打开这个文件夹，接着在这个文件夹上创建model工程，如下图所示：

选择spring initializr

选择Web，再选择Web复选框

4. 填写Project name，点击finish

5. 打开项目目录，删除以下文件夹和文件

如果相同的依赖太多，你也可以考虑创建pom父工程，统一依赖管理。

1.服务者的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">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.2.RELEASE</version>
        <relativePath/>
    </parent>
    <groupId>com.wenxue</groupId>
    <artifactId>springBoot-dubbo-provider</artifactId>
    <packaging>jar</packaging>
    <version>0.0.1-SNAPSHOT</version>
    <name>springBoot-dubbo-provider</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

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

        <!--sproingBoot整合dubbo的依赖-->
        <dependency>
            <groupId>io.dubbo.springboot</groupId>
            <artifactId>spring-boot-starter-dubbo</artifactId>
            <version>1.0.0</version>
        </dependency>

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

    </dependencies>

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

</project>

2.添加application.propertis文件，配置dubbo相关信息

#提供服务名称，可任意抒写
spring.dubbo.application.name=provider
#zookeeper地址及端口号
spring.dubbo.registry.address=zookeeper://127.0.0.1:2181
#dubbo协议
spring.dubbo.protocol.name=dubbo
#duboo端口号
spring.dubbo.protocol.port=20880
#这是你要发布到dubbo提供服务的接口所在包位置
spring.dubbo.scan=com.wenxue.demo.dubboService

#tomcat端口号
server.port=8888

3.编写接口及实现类（重点）：

package com.wenxue.demo.dubboService.impl;

import com.alibaba.dubbo.config.annotation.Service;
import com.wenxue.demo.dubboService.TestDubboService;

@Service(version = "1.0.0")//该注解的作用就是发布服务
public class TestDubboServiceImpl implements TestDubboService {

    @Override
    public void toProvider() throws Exception {
        System.out.println("恭喜你连接成功");
    }
}

注意：上面的@Service注解是“com.alibaba.dubbo.config.annotation” 包下的，不是spring的，如果导错了包将会无法发布服务。

工程目录结构如下：

三：创建消费者工程

创建过程同上。

1.消费者的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">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.2.RELEASE</version>
        <relativePath/>
    </parent>
    <groupId>com.wenxue</groupId>
    <artifactId>springBoot-dubbo-consumer</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springBoot-dubbo-consumer</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

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

        <!--springBoot整合dubbo的依赖-->
        <dependency>
            <groupId>io.dubbo.springboot</groupId>
            <artifactId>spring-boot-starter-dubbo</artifactId>
            <version>1.0.0</version>
        </dependency>

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
      
    </dependencies>

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

</project>

2.编写applicat.properties:

#消费者名称，可任意抒写
spring.dubbo.application.name=consumer
#zookeeper地址及端口号
spring.dubbo.registry.address=zookeeper://127.0.0.1:2181
#消费方 调用 服务费 @Reference注入 所在包位置
spring.dubbo.scan=com.wenxue.demo.controller

#tomcat端口号
server.port=8889

这里要特别注意，消费方的spring.dubbo.scan是消费方调用服务费所在包的位置，也就是打注解@Reference的包位置。我看过网上很多人都把服务费和消费方的spring.dubbo.scan都说成是服务方接口所在的包位置，经过本人测试这是不准确的。

3.编写Controller:

package com.wenxue.demo.controller;

import com.alibaba.dubbo.config.annotation.Reference;
import com.wenxue.demo.dubboService.TestDubboService;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.RequestMapping;

@Component
@RequestMapping("/")
public class TestDubboController {

    @Reference(version = "1.0.0")//该注解的作用就是订阅服务
    private TestDubboService testServices;

    @RequestMapping("/testDubbo")
    public void testDubbo() throws Exception {
        testServices.toProvider();
    }
}

4.定义服务方接口

方式一：由于消费方和服务方不在同一个工程，所以需要将服务方的接口拷贝过来。

方式二：如果你觉得拷贝包太麻烦了的话，还可以有第二种方案，那就是导入服务方的工程依赖

      <!--引入服务方工程的目的为了注入服务方的接口-->
        <!--<dependency>-->
            <!--<groupId>com.wenxue</groupId>-->
            <!--<artifactId>springBoot-dubbo-provider</artifactId>-->
            <!--<version>0.0.1-SNAPSHOT</version>-->
        <!--</dependency>-->

以上两种方式任君选择，不过本人建议使用第一种，以免增加maven仓库的导入量。或许读者你也会疑问：“导入了服务费的工程，不需要dubbo不也可以调用吗？”但是经过我测试是不可以的。这说明了springBoot的底层做了某些特殊的封装。

5.启动工程

接下来先启动服务者，再启动消费者就可以了。(如果你想看的更加清楚，可以下载dubbo-admin.war，放入tomcat启动后访问http://localhost:8088/dubbo-admin-2.5.4 。就可以看见服务的发布与订阅是否成功与失败。密码账户默认都是是root)

6.测试调用：

第一大坑：

*如果不出意外，你会发现，在controller调用远程服务时出现了“java.lang.NullPointerException: null”的异常，那就恭喜你已经中了第一坑。哈哈。

那是因为TestDubboService并没有成功被订阅，所以是空对象。造成这种现象的原因一般都是：“因为你消费方的接口的包路径与服务方的包路径不同所导致的！所以，一定要从服务方连包带接口拷贝到消费方！一定要从服务方连包带接口拷贝到消费方！一定要从服务方连包带接口拷贝到消费方！重要的事情说三遍！！！”

如下图所示：

最后测试调用：

访问：http://localhost:8889/testDubbo ，如果控制台打印出“恭喜你连接成功了！” 那就没问题了

第二大坑：

上面的例子，我们并没有返回数据给前端，这时候我们修改代码，将void改成String:

接着修改接口返回的数据：

然后重新启动工程，再次访问，如果不出意外，服务端就会出现无法返回的情况，如果在debug模式下，可能会执行三次(那是因为请求失败，重复尝试造成的)。

并且在客户端会报错：javax.servlet.ServletException: Circular view path [login]: would dispatch back to the current handler URL [/login] again. Check your ViewResolver setup! (Hint: This may be the result of an unspecified view, due to default view name generation.)

如果出现了以上情况，那么恭喜你已经踩入第二个坑了。出现这种情况的原因是在服务提供方的接口只注册了dubbo，但是没有托管给spring，所以需要加上@Component注解。这里容易混淆的就是@Servcie注解，dubbo和spring都有这个注解，随意很容易让人导出包，所以这里推荐使用@Component来区分。

再次重新启动工程，再次访问http://localhost:8889/testDubbo 就可以了。

第三大坑：

我们上面的列子中，并没有操作数据库，使用spring的@Transactional，我们现在给它加上这个注解，然后启动，没有任何问题，但是访问的时候，只要执行到这个方法，它会报错：com.alibaba.dubbo.rpc.RpcException: Forbid consumer 172.16.24.127 access service com.wenxue.demo.dubboService.TestDubboService from registry 127.0.0.1:2181 use dubbo version 2.5.3, Please check registry access list (whitelist/blacklist).

那么恭喜你已经中了第三个坑。这是为什么呢？

是因为我们一般的service发布dubbo服务时，dubbo能够扫描到类上dubbo的@service注解，并为其生成代理，而当我们使用@Transactionnal注解时，将会采用cglib为service生成代理，生成的类为原service的子类，而bubbo并没有允许子类继承父类的注解，因此就扫描不到这个注解并生成代理了。
解决办法：

进行分层处理，讲事务操作和发布接口放在不同包，或不同类中。

注意：

测试这个@Transactional的时候，一定要注意springBoot默认没有集成org.springframework下的spring-tx的包，是无法使用事务注解的，需要单独引入：

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>5.1.4.RELEASE</version>
        </dependency>

或者集成mybatis的时候使用 spingBoot-mybatis的包，这个包集成了上面的spring-tx所以可以使用spring的事务。

        <!-- SpringBoot的Mybatis启动器 -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.1.1</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

其它可能存在的问题说明：

1.一定要导入log4j的jar，否则会报错；

2.使用debug时，会出现服务端连续执行三次的情况；那是因为调用后消费端没有得到响应，从而再次尝试，出现这种情况，可能是返回结果是出现问题（比较常见的就是接口为依赖注入给Spring）。

3.在执行远程调用时可能会出现空指针异常，那是因为服务端的接口没有注入进来，可能是因为消费方接口包路径与服务方的接口路径不一致，或者是消费方的spring.dubbo.scan=xxx 路径定义错了。

如果你们看了我的文章，还是有疑问，或是其它问题，请扫描下方二维码联系本人，谢谢！

诗人与黑客

关注

1
点赞
踩
13

收藏

觉得还不错? 一键收藏
3
评论
SpringBoot 集成 Dubbo + zookeeper全注解方式（各种坑的说明）

大家知道springBoot发明的初衷是为了减少xml的配置，而dubbo的传统方式就是xml配置，所以既然用了springBoot就应该遵循它的规则，在集成dubbo时改为全编程式注解的方式。下面我来为大家详细介绍集成的步骤：一：安装zookeeper 首先去官网下载zookeeper，下载地址为：http://mirror.bit.edu.cn/apache...
复制链接

扫一扫

专栏目录