一、关于 Dubbo3 的一些优化改进介绍
Dubbo3 的官方文档地址: https://cn.dubbo.apache.org/zh-cn/overview/what/overview/ 其针对一些问题进行了优化和改变。个人整理3个小的方面:
1. 在服务注册方面使用 @DubboService 注解,不再使用 @Service 这个关键词,以区别于 Spring 的 @Service 注解。即 @Service 注解从 3.0 版本开始就已经废弃了。
2. 在服务发现方面,使用 @DubboReference 注解,而 @Reference 注解从 3.0 版开始废弃,以区别于 Spring 的 @Reference 注解。
3. 在包引入方面,针对之前需要引入多个包,如 Dubbo-spring-boot-starter、Zkclient、Curate-framework、Curate-recipes、zookeeper 以及其 zookeeper 与 log4j之间的日志冲突问题等,甚是麻烦。又远离了 springboot 的简单配置的初衷,于是 Dubbo3 里只需要引入两个包 dubbo-spring-boot-starter 和 dubbo-zookeeper-spring-boot-starter。
二、搭建基本环境 zookeeper 以及可视化客户端
zookeeper 的下载就不多介绍了,去官网下载后在本地编辑 zoo.cfg 文件 ,windows 上的话运行 zkServer.cmd 文件即可启动。
关于 zookeeper 以及可视化客户端,可以使用 dubbo-admin,不过这个并不是核心功能的东西,我还是选择使用一些现成的工具吧,如 ZooInspector 或 prettyZoo。在这里提一下 ZooInspector的界面比较丑,不如 prettyZoo 好用。不过两者都有不足之处,就是显示出来的JSON内容为什么就不能加个格式化的按钮美观地展示出来!prettyZoo 界面截图如下:
三、 Dubbo3 + SpringBoot3的微服务调用程序代码示例
A. 服务提供方的代码
1. 服务提供方的程序结构截图
2. application.yml 配置文件内容
spring:
application:
name: hisroty-provider
server:
port: 8082
dubbo:
application:
name: history-server
registry:
address: zookeeper://127.0.0.1:2181
scan:
base-packages: cn.history.service
3. 文件 HistoryService.java 代码
package cn.fangha.service;
public interface HistoryService {
String getHistory();
}
4. 文件 cn/fangha/service/HistoryServiceImpl.java 代码
package cn.fangha.service;
import org.apache.dubbo.config.annotation.DubboService;
import org.springframework.stereotype.Component;
@Component
@DubboService
public class HistoryServiceImpl implements HistoryService {
@Override
public String getHistory() {
return "微服务返回的历史数据内容.";
}
}
5. 项目启动程序需要加上注解
Dubbo3 的话需要加上 @EnableDubbo 注解,这个在2.X版本的时候是不需要的。
package cn.fangha;
import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@EnableDubbo
public class HisrotyProviderApplication {
public static void main(String[] args) {
SpringApplication.run(HisrotyProviderApplication.class, args);
}
}
6. 依赖的包配置 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>3.3.5</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>cn.fangha</groupId>
<artifactId>hisroty-provider</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>hisroty-provider</name>
<description>hisroty-provider</description>
<url/>
<licenses>
<license/>
</licenses>
<developers>
<developer/>
</developers>
<scm>
<connection/>
<developerConnection/>
<tag/>
<url/>
</scm>
<properties>
<java.version>17</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>
<!--dubbo相关的依赖-->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>3.3.0</version>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-zookeeper-spring-boot-starter</artifactId>
<version>3.2.14</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
B. 服务消费方的代码
1. 服务消费方的程序结构截图
2. application.yml 配置文件内容
spring:
application:
name: history-serv
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/myblog?useUnicode=True&characterEncoding=utf-8&userSSL=true=utf-8
username: root
password: 123456
server:
port: 8081
dubbo:
application:
name: test-service
registry:
address: zookeeper://127.0.0.1:2181
3. 接口 cn/fangha/service/HistoryService.java 程序
其和服务提供方是一样的。
package cn.fangha.service;
public interface HistoryService {
String getHistory();
}
4. 控制器的程序代码:
控制器中,直接定义一个服务类,类的类型必须是在本项目中定义(保持和微服务方一样),然后在使用的时候直接用 @DubboReference 注解自动将其注入为 Dubbo 服务代理实例,如此即可发起远程服务调用。
package cn.fangha.controller;
import cn.fangha.service.HistoryService;
import org.apache.dubbo.config.annotation.DubboReference;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class TestController {
@DubboReference
private HistoryService historyService;
@GetMapping("/get_service")
@ResponseBody
public String test() {
String result = historyService.getHistory();
String outResult = "Receive from remote service ======> " + result;
return outResult;
}
}
5. 项目启动程序,同服务方一样需要加上注解
package cn.fangha;
import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@EnableDubbo
public class HistoryServApplication {
public static void main(String[] args) {
SpringApplication.run(HistoryServApplication.class, args);
}
}
6. 消费方的 pom.xml 配置文件
和 服务方大同小异,只是我这里引入了其它的 mysql 之类的包,未作删除。
<?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>3.3.5</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>cn.fangha</groupId>
<artifactId>history-serv</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>history-serv</name>
<description>history-serv</description>
<url/>
<licenses>
<license/>
</licenses>
<developers>
<developer/>
</developers>
<scm>
<connection/>
<developerConnection/>
<tag/>
<url/>
</scm>
<properties>
<java.version>17</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter-test</artifactId>
<version>3.0.3</version>
<scope>test</scope>
</dependency>
<!--dubbo相关的依赖-->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>3.3.0</version>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-zookeeper-spring-boot-starter</artifactId>
<version>3.2.14</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>
C. 微服务调用执行
1. 运行起 zookeeper 之后,将服务方运行起来,通过 zookeeper 的可视化工具,可以方便地检查服务是否正常运行并注册到 zk 中。
2. 运行起 消费方,当然我这里都是 springboot ,直接在页面API上进行了调用显示,也可以直接在单元测试程序中调用检验。
3. 访问消费方的 localhost:8081/get_service ,可以看到其能正常调用到另一个项目服务的内容。
四、其它小记
在使用最新版之前,我也使用了早前的的版本进行测试,即会引入如 Dubbo-spring-boot-starter、Zkclient、Curate-framework、Curate-recipes、zookeeper 这些依赖,碰到不少报错也解决不少问题,也成功进行了服务注册发现,但确实是非常麻烦。
比如在老版本里启动生产端,遇到报错:java.lang.NoSuchMethodError: 'org.apache.curator.framework.api.ProtectACLCreateModePathAndBytesable org.apache.curator.framework.api.CreateBuilder.creatingParentContainersIfNeeded()'
Caused by: java.lang.NoSuchMethodError: 'org.apache.curator.framework.api.ProtectACLCreateModePathAndBytesable org.apache.curator.framework.api.CreateBuilder.creatingParentContainersIfNeeded()'
at org.apache.curator.x.discovery.details.ServiceDiscoveryImpl.internalRegisterService(ServiceDiscoveryImpl.java:222)
还有报错: NoClassDefFoundError: org/apache/curator/RetryPolicy 缺少包:
2024-11-02T11:50:56.212+08:00 WARN 19264 --- [history-serv] [ main] ConfigServletWebServerApplicationContext : Exception encountered during context initialization - cancelling refresh attempt: java.lang.NoClassDefFoundError: org/apache/curator/RetryPolicy
2024-11-02T11:50:56.219+08:00 INFO 19264 --- [history-serv] [ main] .s.b.a.l.ConditionEvaluationReportLogger :
问题就是需要导入版本正确的包:curator-framework ,我这里开始用的 Curator Framework » 4.0.1( curator-framework 是一个 High-level API that greatly simplifies using ZooKeeper. 基于zk的高性能的API调用工具)后来改成了2.X的版本,这些问题就没报了。
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-framework</artifactId>
<version>4.0.1</version>
</dependency>
还有报错如:[bboShutdownHook] o.apache.dubbo.config.DubboShutdownHook : [DUBBO] Run shutdown hook now., dubbo version: 3.3.0, current host: 192.168.2.28
Exception in thread "main" java.lang.IllegalStateException: java.lang.NoSuchMethodError: 'org.apache.curator.framework.CuratorFrameworkFactory$Builder org.apache.curator.framework.CuratorFrameworkFactory$Builder.ensembleTracker(boolean)'
INFO 19368 --- [history-serv] [bboShutdownHook] o.apache.dubbo.config.DubboShutdownHook : [DUBBO] Run shutdown hook now., dubbo version: 3.3.0, current host: 192.168.2.28
Exception in thread "main" java.lang.IllegalStateException: java.lang.NoSuchMethodError: 'org.apache.curator.framework.CuratorFrameworkFactory$Builder org.apache.curator.framework.CuratorFrameworkFactory$Builder.ensembleTracker(boolean)'
Exception in thread "main" java.lang.IllegalStateException: java.lang.NoSuchMethodError: 'org.apache.curator.framework.CuratorFrameworkFactory$Builder org.apache.curator.framework.CuratorFrameworkFactory$Builder.ensembleTracker(boolean)'
真的是非常麻烦。建议碰到这些问题后,不要使用新的版本,SpringBoot的初衷就是不希望大家浪费大量的时间精力在这些各个jar包的冲突问题上,Dubbo 随着它慢慢发展完善,也一定会在版本问题上有更好的解决办法,如 Dubbo3 的出现就是如此。