避免 public 函数互相调用?一个反直觉的 API 设计规则

原创
alex 3周前 (11-01) 阅读数 23 #头条

避免 public 函数互相调用?一个反直觉的 API 设计规则

一个反直觉的规则

我第一次读 matklad 这篇博客时,第一反应是想反驳。“公共函数调用另一个公共函数”?我写代码这么多年,见过太多 API 为了减少重复而互相调用。DRY 原则说,重复逻辑应该被提取,而最自然的位置就是现有的公共函数。为什么作者说这是坏习惯?

文章开头作者自己也承认,这个规则是 “A small-scale rule of thumb”,而且他举不出一个完美的具体例子,只能让读者先信任他的判断 来源:HH。他说这话时带着点无奈。我理解那种感觉,有些规则你能感觉到它是对的,但就是没法用一个干净利落的例子让对方服气。

但读完之后我意识到,这跟 DRY 不是一回事。DRY 讲的是代码层面的重复,而这条规则讲的是接口层面的结构。公共函数之间互相调用,看起来像在消除重复,实际上是在模糊边界。边界一旦模糊,后续的参数增长和接口退化就更难被察觉。

DRY 的陷阱与 helper

作者给出的例子很朴素。假设你有一个公共函数 foo,它的一部分行为恰好被另一个公共函数 bar 处理了。DRY 直觉告诉你,在 foo 里直接调 bar 就好了。作者说这通常会在后面制造问题 来源:HH。

他给的 BAD 版本里,foo 调 bar,传一个 .frobnicate = true 的选项,而 bar 的签名是 options: struct { frobnicate: bool = false }。这看起来完全正常,但作者认为这是糟糕的设计。真正的解法是把公共逻辑抽成一个私有 helper 来源:HH。

于是 GOOD 版本里,foo 和 bar 都去调 helper,只是传不同的 mode。foo 传 .frobnicate,bar 传 .transmogrify。helper 是私有的,签名怎么改都行,不会影响公共接口 来源:HH。

为什么值得这么做

作者的 rationale 很清晰。公共 API 的目标是让调用点的代码最好写。如果公共 API 的一部分被用来实现另一部分,就会出现一个矛盾。你既想让外部用户方便,又想让自己在内部实现时方便。这两个方便方向不一样 来源:HH。

矛盾的具体表现是参数膨胀。公共函数会慢慢长出一些可选的参数,这些参数用户永远不会去设,只有内部调用才会用到。更糟糕的是,这种参数膨胀和接口退化可以发生在最初的代码共享之后,等你发现时,公共 API 已经被污染了 来源:HH。

如果提前把共享实现设成私有,矛盾就被拆掉了。你也许还要调整 helper 的签名,但因为是私有的,这只是本地改动,代价很小。改一个私有函数和改一个公共函数,心理负担完全不一样 来源:HH。

例外与 shortcut API

不过作者明确承认一个例外:“shortcut” APIs。当一个公共函数只是另一个常用公共函数调用链的便捷包装时,规则反过来,禁止私有调用。作者要求它必须是真正的快捷方式,不能变成中间层的错误 来源:HH。

我想到很多库里都有这种便捷入口。比如一个库提供 a() 和 b(),然后为了方便用户,又提供 c() 内部依次调 a 和 b。作者说这种 c() 要确保它只是拼接,不掺入额外逻辑,否则就变成了 midlayer mistake 来源:HH。

这个例外本身很值得琢磨。规则说“不要公共调公共”,例外说“如果调了,就别在中间加私有逻辑”。两者合起来,其实是在区分两种结构。一种是公共 API 之间共享底层实现,应该抽私有 helper;另一种是公共 API 作为公开组合入口,应该保持纯组合。

多源视角与边界

我顺手查了 HN 上的讨论,想看看有没有人反驳或补充。结果那篇帖子只有 1 point,0 条评论 来源:HN。这意味着目前没有公开的反驳或验证,规则还只能依赖作者自述。作者在 P.S. 里提到一个 Stack Overflow 问题,有人问“我听说公共函数调用公共函数是坏的,真的吗?”最 upvoted 的答案说是坏的,因为会让测试一个方法时 mock 变复杂。作者认为这是对测试方法的误导,他说你不应该 mock 你的方法 来源:HH。

我对这个规则的边界没有完全把握。作者把它定位为 rule of thumb,一种小规模的经验法则,意味着存在未量化的适用条件。哪些情况适用、哪些不适用,他没有展开。我不确定这是否能推广到所有语言和所有模块规模,至少我见过的代码库里,公共调公共的坏味道确实存在,但好闻的例子也有。

我的判断是,这条规则值得一试。下次再看到公共函数 A 调用公共函数 B 时,先问一句,如果 A 和 B 的调用方向变了,接口会不会跟着坏。如果会,就把共享部分抽成私有 helper。至于 shortcut API,保持它纯粹就好。


原文:

Avoid Public Functions Calling Other Public Functions · 来源:Hacker News

作者:itfan123 值班编辑 · 发布于 2026年11月1日

版权声明

所有资源都来源于爬虫采集,如有侵权请联系我们,我们将立即删除