首页
/ Bon项目v3.5.0版本发布:构建器模式与文档生成的增强

Bon项目v3.5.0版本发布:构建器模式与文档生成的增强

2025-06-29 14:26:35作者:胡易黎Nicole

Bon是一个Rust语言的构建器模式(Builder Pattern)代码生成库,它通过过程宏简化了构建器模式的实现。构建器模式是一种创建型设计模式,允许用户通过链式调用的方式逐步构建复杂对象,特别适合需要多个可选参数的场景。

本次发布的v3.5.0版本主要带来了两个重要改进:文档生成控制和宏属性顺序检查。这些改进虽然看似微小,但对于提升开发体验和代码质量有着实际意义。

文档生成控制:setters(doc(default(skip)))

在构建器模式中,我们经常需要为字段设置默认值。之前的版本中,这些默认值会被自动包含在生成的文档中,这在某些情况下可能不是开发者想要的。v3.5.0版本引入了setters(doc(default(skip)))属性,允许开发者显式地跳过默认值在文档中的显示。

这个特性的使用场景包括:

  1. 当默认值实现较为复杂,不适合直接展示在文档中时
  2. 当默认值可能随时间变化,不希望给用户造成"这是固定值"的印象时
  3. 当默认值的展示会干扰主要API文档的可读性时

使用方法很简单,只需要在字段上添加该属性即可:

#[builder]
struct Config {
    #[builder(setters(doc(default(skip))))]
    timeout: u64,
}

宏属性顺序检查

另一个改进是关于宏属性顺序的编译器警告。在Rust中,当同时使用#[tracing::instrument]#[builder]属性时,如果#[tracing::instrument]放在#[builder]之后,会导致生成的span名称带有难看的__orig_前缀。

v3.5.0版本会触发编译器警告来提醒开发者正确的属性顺序应该是:

#[tracing::instrument]  // 这个应该在前
#[builder]              // 这个应该在后
fn my_function() { ... }

这个改进虽然小,但对于保持代码整洁和提高调试体验很有帮助,因为正确的span名称可以让日志更加清晰易读。

其他修复

本次版本还修复了一个关于自由函数上重复#[builder]属性被忽略的问题。这意味着现在可以在自由函数上安全地使用多个#[builder]属性而不会出现意外行为。

总结

Bon v3.5.0虽然不是一个重大版本更新,但这些改进展示了项目对开发者体验的持续关注。文档生成控制的增强让API文档更加精准,宏属性顺序检查避免了潜在的调试困扰,这些细节的打磨使得Bon作为一个构建器模式代码生成工具更加完善和易用。

对于正在使用或考虑使用Bon的Rust开发者来说,这个版本值得升级,特别是那些需要精细控制文档内容或同时使用tracing进行日志记录的项目。

登录后查看全文
热门项目推荐

热门内容推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
138
188
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
94
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
187
266
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
893
529
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.08 K
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
371
387
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
337
1.11 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
401
377