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

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

2025-06-29 08:16:52作者:胡易黎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进行日志记录的项目。

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

项目优选

收起