Spring boot 2.2.2 整合Dubbo详解
文档说明
本文用以帮助使用spring boot 2.0X整合Dubbo,过程详解。记录作者在整合过程中发现的坑及经验教训。
使用spring boot 2.2.2 整合zookeeper3.5.6版本组件
下载启动zookeeper
官网下载地址:https://zookeeper.apache.org/releases.html
如下图所示,按照红框框选进行操作即可,
apache-zookeeper-3.5.6-bin版本为可执行软件,下载后可直接使用;
apache-zookeeper-3.5.6中是源码下载后无法直接使用。
解压至指定文件夹中,创建data文件夹(存放zookeeper文件),创建start-zookeeper.bat文件
启动文件中输入命令如下
@echo off
set BASE_HOME=%~dp0
set DATA_HOME=%BASE_HOME%/data
set JAVA_HOME=C:/Program Files (x86)/Java/jre1.8.0_101
set ZOOKEEPER_HOME=%BASE_HOME%/apache-zookeeper-3.5.6-bin
echo %BASE_HOME%
set PATH=%JAVA_HOME%\jre1.8.0_144\bin;%JAVA_HOME%\bin;%HADOOP_HOME%\bin;%PATH%
echo Start Apache Zookeeper
rem start "Zookeeper" /D "%ZOOKEEPER_HOME%" /MIN "%ZOOKEEPER_HOME%/bin/zkServer.cmd" -Dzookeeper.admin.enableServer=false
start "Zookeeper" /D "%ZOOKEEPER_HOME%" /MIN "%ZOOKEEPER_HOME%/bin/zkServer.cmd"
EndLocal
重命名zookeeper默认配置文件zoo_sample.cfg文件名为zoo.cfg
双击start-zookeeper.bat启动zookeeper,完成zookeeper启动。启动成功页面如下
创建spring boot 工程
使用Dubbo进行跨服务调用时,分服务提供者、服务消费者。首先我们选择创建两个独立工程进行演示。编译软件为idea目前比较火的spring开发软件,不清楚的可自行百度。
1、创建提供者工程
这里创建一个简单的spring boot 2.2.2 web工程作为服务提供者,命名为demo-provider,按照不住操作即可
只需要依赖spring web即可
创建成功后,在pom.xml中加入dubbo依赖即可,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 https://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.2.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>demo-provider</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo-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>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.alibaba.boot</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>0.2.0</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
编写配置文件application.properties
server.port=80001
spring.application.name=privider
## Dubbo 服务提供者配置
dubbo.application.name=privider
dubbo.protocol.name=dubbo
dubbo.protocol.port=20880
dubbo.registry.address=zookeeper://127.0.0.1:2181
dubbo.provider.timeout=1000
在DemoProviderApplication启动类中增加@EnableDubbo注解,启用Dubbo
创建测试接口类DubboService,这里参数由服务消费工程传入
package com.example.demo;
public interface DubboService {
String testDubbo(String pararm);
}
创建接口实现类DubboServiceImpl,打印参数,判断是否接收到消费工程参数。
package com.example.demo;
import com.alibaba.dubbo.config.annotation.Service;
@Service
public class DubboServiceImpl implements DubboService {
@Override
public String testDubbo(String pararm) {
System.out.println(">>>>>>>>>>>>>provider>>pararm="+pararm);
return "success" + pararm;
}
}
提供者工程如下:
启动服务提供工程,注意是否出现输出dubbo等字段信息,若出现没有报错,则表示连接dubbo成功。
2、创建服务消费者工程
消费者工程创建参考服务提供者工程创建过程,工程依赖和服务提供工程一致,可复制服务提供工程重命名即可。
消费者工程application.properties配置如下:
server.port=10002
spring.application.name=consumer
## Dubbo 服务提供者配置
dubbo.application.name=consumer
dubbo.registry.address=zookeeper://127.0.0.1:2181
在DemoConsumerApplication启动中增加@EnableDubbo注解启用Dubbo
创建DubboService,注意接口类名称、路径需要和服务提供者接口类名称、路径一直,否则无法使用
package com.example.demo;
public interface DubboService {
String testDubbo(String pararm);
}
创建测试controller TestDubboController 使用@RestController标签注释类,使用@Reference标签注入DubboService,代码如下:
package com.example.demo;
import com.alibaba.dubbo.config.annotation.Reference;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class TestDubboController {
@Reference DubboService dubboService;
@RequestMapping
public void test(@RequestParam String pararm) {
dubboService.testDubbo(pararm);
}
}
消费者工程如下
在这里插入图片描述
运行服务消费者工程,出现连接dubbo信息表示连接成功:
3、测试
浏览器请求消费者测试接口,提供服务工程输出对应信息
完成
注意问题:
1、网络问题
出现如下错误,服务提供启动失败。出现以下信息说明网络中同时存在无线网络、本地网络、虚拟机网络等信息,影响dubbo链接。在控制面板\网络和 Internet\网络连接 禁用其他网络,只保留一个网络即可
2、接口名称、路径不一致
消费者工程启动时出现如下错误,检查消费工程中接口名称、路径是否和服务提供工程接口一致。因为使用@Reference标签注入接口时,会从zookeeper中查询对应服务提供,若找不到则会出现以下错误。
3、服务启动顺序
需先启动服务提供工程后,在启动消费工程。
优化
由于使用Dubbo进行跨服务调用,需保证接口名称路径一致,建议可将接口定义到单独基础模块工程,由提供者和消费者引入依赖或将基础模块工程打包成jar引入,直接使用即可。
如下图所示
在这里插入图片描述
在demo-parent工程中依赖dubbo模块,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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<packaging>pom</packaging>
<modules>
<module>demo-provider</module>
<module>demo-consumer</module>
<module>demo-common</module>
</modules>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>demo-dubbo-parent</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo-dubbo-parent</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>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.alibaba.boot</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>0.2.0</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
Demo-common工程之定义接口即可如下图:
Demo-common工程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>demo-dubbo-parent</artifactId>
<groupId>com.example</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>demo-common</artifactId>
</project>
demo-provider模块定义接口实现类即可,如下图:
demo-provider配置如下
demo-provider模块Pom.ml中引入common模块依赖即可
<?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>demo-dubbo-parent</artifactId>
<groupId>com.example</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>demo-provider</artifactId>
<dependencies>
<dependency>
<groupId>com.example</groupId>
<artifactId>demo-common</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
</dependencies>
</project>
demo-comsumer消费者工程中之定义测试controller
demo-comsumer配置如下
demo-comsumer消费者工程 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>demo-dubbo-parent</artifactId>
<groupId>com.example</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>demo-consumer</artifactId>
<dependencies>
<dependency>
<groupId>com.example</groupId>
<artifactId>demo-common</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
</dependencies>
</project>
git地址:https://github.com/xdai-2009/demo-dubbo-parent.git