如何调试 Dubbo 协议调用过程

快来打我* 2024-02-20 12:58 37阅读 0赞

微服务架构下的快速交付、灵活部署等优势使得 **[Dubbo][]** 协议已成为了当今互联网基础建设里的一大热点。

Dubbo 协议是一款由阿里巴巴开发并开源的一款高性能 Java **[RPC][]** 框架，凭借着**高效的远程调用、服务注册与发现、灵活的配置**等特点，**在微服务后端开发场景中十分流行**。

虽然有着许多优势，但是 Dubbo 接口的调试过程并不容易。此前并没有一款专业好用的 Dubbo 接口调试工具，许多 Java 后端开发者不得不在开发环境中，直接以编写代码的方式调试接口，数据反馈链路较长。

![图片][c3962b40b82b0c985d2538bbd67994fe.png]

虽然这种调试方式对于能够完成自闭环的程序员而言确实不会出现过多的问题，但是一旦到了多人共同协作场景（开发+测试人员），这种高门槛的调试模式将会让验收周期变得十分漫长。

**[Apifox][]** 近期更新的 Dubbo 项目功能让 Java 团队的协作变得不再困难，已支持已在业界中广泛使用的 **「Dubbo 网络传输协议」 + 「Hessian 序列化格式」** 组合模式。

本文将以从 ZooKeeper 导入 Dubbo 接口为例，通过以下简单的三步即可在 Apifox 中导入 Dubbo 接口并开展调试工作！

### **1** ###

**导入 Dubbo 接口**

首先在 Apifox 团队首页中创建 Dubbo 项目。

![图片][e3f6848a953c01418c9dbe3f0cb29300.png]

在导入接口页选择 **ZooKeeper 类型**，根据页面指引，填写连接地址及端口号。若注册中心配置了鉴权机制，请点击右侧齿轮按钮并填写用户名和密码。

![图片][9b52fb333292f72aa709a70a4b597319.png]

选择需要导入至 Apifox 的 Dubbo 应用，点击「保存并导入」按钮完成导入。

![图片][06853bb83b180446428c815370618a93.png]

除了支持从 ZooKeeper 导入外，Apifox 还支持从 **Nacos 和阿里云 EDAS** 导入。

Apifox 作为客户端，仅支持导入 provider，不支持导入 consumer。因此导入 Dubbo 接口时须确保**将应用的 provider 的元数据上传到 ZooKeeper 或 Nacos 中**，以便接口能够正确导入至 Apifox。

从 ZooKeeper 导入成功后，你可以在左侧目录树看到由 **Package、服务和方法**这三个层级所展开的 Dubbo 接口。

![图片][31b934d142ae6bd28272c92cd78fe1d5.png]

以 demo/com.dubbo.example.DemoService:1.0.1 接口为例，接口的各层级对照图如下：

![图片][1bab581f92108a45850aa699acf2a234.png]

### **2** ###

**调试 Dubbo 接口**

接口请求和调试的目标地址为注册中心。

注册中心是管理和维护 Dubbo 服务接口的信息的核心组件。当一个 Dubbo 服务提供者（服务端）启动时，它会向注册中心提供的服务接口信息，包括**服务名称、IP 地址、端口号、以及其他元数据**，其它服务消费者（客户端）都可以通过注册中心发现并调用 Dubbo 接口。并且注册中心还支持动态负载均衡，提供服务治理和监控服务等功能，帮助及时发现和解决问题。

针对从 ZooKeeper 导入的接口，Apifox **将自动在环境管理中添加注册中心地址**，项目内的其它 Dubbo 接口也将会**默认使用该地址**。

![图片][6801975a37357404792a3b3eaf619738.png]

配置完成后，点击「调用」按钮，即可得到接口的返回结果。

![图片][3a4eeee425ae863e19be04982f9b5bec.png]

### **3** ###

**创建 Dubbo 接口文档**

在开发团队中管理多个 Dubbo 接口的有效方式之一就是**编写详尽的接口文档**。一份清晰的文档有利于团队内开发者之间的相互协作，有效避免消费者和提供者对接口参数产生分歧而导致的调用错误，提升团队整体的 Dubbo 接口协作效率。

从 ZooKeeper 导入 Apifox 的 Dubbo 接口支持自动生成接口文档。随着后期开发工作的展开，接口文档的内容也将随之更新。此时可以点击 Dubbo 接口中的“接口定义” 进行设置，为接口文档调整「请求」和「响应」。

![图片][376505a0cc237cac42b1be005ad54baf.png]

添加请求定义、响应定义和接口说明后，你可以点击「文档预览」 Tab 按钮查看 Dubbo 接口文档。点击右侧的「超链接」icon 还可以直接获取分享链接。其它成员打开后便可以直观的看到当前的 Dubbo 接口详情。

![图片][a841705d0f7bfb4eb4ba8344f7e749f8.png]

Apifox 作为先进的 API 设计/开发/测试工具，**不断兼容市面上流行的 API 协议，让开发人员不必再为某个 API 协议而苦苦寻找接口调试工具**。

除了 Dubbo 协议以外，Apifox 还支持常见的 Rest API、gRPC、WebSocket 等协议，更多详情请参考：[盘点开发者最常用的 API 协议，Apifox 全都支持！][API _Apifox]

可以说，光依靠 Apifox 一个工具就可以解决 **API 开发 → 调试 → 管理**问题，让更多的中国开发团队也能够体验到一流的一站式 API 管理方案。

### 知识扩展： ###

*  **[Dubbo 接口的泛化调用][Dubbo 1]**
 *  **[Dubbo 协议大全：支持哪些协议？][Dubbo 2]**

[Dubbo]: https://apifox.com/apiskills/dubbo-framework/
[RPC]: https://apifox.com/apiskills/comparison-of-rpc-frameworks/
[c3962b40b82b0c985d2538bbd67994fe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/a2cf5f13d2b24489bdf48ec02841c551.png
[Apifox]: http://apifox.com/?utm_source=opr&utm_medium=liam
[e3f6848a953c01418c9dbe3f0cb29300.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/b8a17f43bad04f7e9b9b3fb220046b01.png
[9b52fb333292f72aa709a70a4b597319.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/9d3df07f3482482fa2d82776638d8b12.png
[06853bb83b180446428c815370618a93.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/e7225efaf3704a51ae52247ce6e605a7.png
[31b934d142ae6bd28272c92cd78fe1d5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/43a5e33aebdd48cfa3f62253ff696ac8.png
[1bab581f92108a45850aa699acf2a234.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/ca970e45678643e491dfc669239f810d.png
[6801975a37357404792a3b3eaf619738.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/e31a468bb51a4fa0bce261b34e9f5649.png
[3a4eeee425ae863e19be04982f9b5bec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/40f92bcc89224b8cbe4e178f1646dffb.png
[376505a0cc237cac42b1be005ad54baf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/8c04221fc92e46528f9a73a98d31563b.png
[a841705d0f7bfb4eb4ba8344f7e749f8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/70c939ef95d64cb980aa9772744187d1.png
[API _Apifox]: http://mp.weixin.qq.com/s?__biz=Mzg2MTY1MzA1OQ==&mid=2247486332&idx=1&sn=3cc1c69889c184aff205f1ceaa0c537d&chksm=ce129a50f96513460d1ea2a3c50deb0dc35dfe8da34f500ab809597e20bf9ec12175874c0c4d&scene=21#wechat_redirect
[Dubbo 1]: https://apifox.com/apiskills/generalized-calls/
[Dubbo 2]: https://apifox.com/apiskills/dubbo-protocol-book/