解决fuels-rs项目中setup_program_test宏的依赖污染问题
2025-05-02 00:06:35作者:瞿蔚英Wynne
在fuels-rs项目中,setup_program_test宏存在一个重要的设计缺陷——它采用了不卫生的宏实现方式,导致了一系列依赖污染问题。这个问题不仅影响了代码的整洁性,还可能给使用者带来不必要的困扰。
问题本质
宏的不卫生性主要体现在它直接假设调用环境中已经存在某些特定的依赖项和类型。具体表现为:
- 宏内部直接使用了
::rand这样的绝对路径,这意味着如果用户代码中没有显式引入rand crate,宏调用就会失败 - 宏假设fuels相关的类型已经在当前作用域中可用,没有正确处理类型的命名空间
这种实现方式违反了Rust宏设计的最佳实践,即宏应该尽可能自包含,不对外部环境做出过多假设。
问题影响
这种设计缺陷会导致几个实际问题:
- 强制依赖:即使用户代码本身不需要rand功能,由于宏内部使用了rand,用户也不得不添加这个依赖
- 命名冲突:绝对路径的使用可能导致与其他crate中的同名项冲突
- 可维护性差:如果需要修改依赖项,必须修改宏本身,而不是通过配置或参数来调整
解决方案
针对这个问题,我们可以采用几种改进方法:
1. 依赖重导出
fuels-rs可以在自己的crate中重新导出rand的相关功能。这样:
pub use rand; // 在lib.rs中重导出
然后在宏中使用crate::rand而不是::rand。这种方式的好处是保持了API的稳定性,但需要注意:
- 重导出的版本升级需要考虑semver兼容性
- 会增加fuels-rs的公开接口表面积
2. 功能委托
更优雅的解决方案是将随机数生成等功能委托给fuels-rs导出的函数:
// 在lib.rs中
mod internal {
pub fn generate_random() -> u64 {
rand::random()
}
}
// 宏内部调用crate::internal::generate_random()
这种方式完全隐藏了实现细节,提供了更好的封装性。
3. 参数化设计
最灵活的方式是让宏接受随机数生成器作为参数:
setup_program_test!(rng = my_rng, ...);
这样用户可以根据需要提供自己的随机源。
实施建议
基于工程实践考虑,推荐采用第二种方案(功能委托)为主,理由如下:
- 完全隐藏实现细节,减少公开API的维护负担
- 不影响现有用户代码
- 未来可以灵活调整内部实现而不破坏兼容性
实施步骤应包括:
- 创建内部模块封装所有依赖功能
- 修改宏实现使用这些封装函数
- 更新文档说明
- 从e2e测试中移除直接的rand依赖
总结
宏的设计应当遵循最小意外原则,setup_program_test宏的当前实现由于忽略了卫生性考虑,给用户带来了不必要的约束。通过合理的封装和委托,我们可以既保持功能完整,又提供更干净的接口。这种改进对于提升fuels-rs的整体质量和用户体验具有重要意义。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C075
MiniMax-M2.1从多语言软件开发自动化到复杂多步骤办公流程执行,MiniMax-M2.1 助力开发者构建下一代自主应用——全程保持完全透明、可控且易于获取。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C01
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0130
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
最新内容推荐
Python Django图书借阅管理系统:高效智能的图书馆管理解决方案 Adobe Acrobat XI Pro PDF拼版插件:提升排版效率的专业利器 深入解析Windows内核模式驱动管理器:系统驱动管理的终极利器 SteamVR 1.2.3 Unity插件:兼容Unity 2019及更低版本的VR开发终极解决方案 OMNeT++中文使用手册:网络仿真的终极指南与实用教程 RadiAnt DICOM Viewer 2021.2:专业医学影像阅片软件的全面指南 中兴e读zedx.zed文档阅读器V4.11轻量版:专业通信设备文档阅读解决方案 PADS元器件位号居中脚本:提升PCB设计效率的自动化利器 谷歌浏览器跨域插件Allow-Control-Allow-Origin:前端开发调试必备神器 IEC61850建模工具及示例资源:智能电网自动化配置的完整指南
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
462
3.44 K
Ascend Extension for PyTorch
Python
269
309
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
190
75
暂无简介
Dart
714
171
React Native鸿蒙化仓库
JavaScript
284
331
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
843
421
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
105
119
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.26 K
692