C 子例程参数数量的最佳实践

Question

我最近开始开发用 C 编写的 API。我看到一些子例程需要 8 个（八）个参数，对我来说，在调用该特定子例程时传递 8 个参数看起来很丑陋且麻烦。我想知道是否可以实施一些更容易接受和更清洁的方法。

Answer 1

如果多个参数可以在逻辑上分组在一起，您可以考虑创建一个包含它们的结构，并简单地将该结构作为参数传递。例如，您可以传递一个 POINT 结构，而不是传递两个坐标值 x 和 y。

但是，如果这样的分组不适用，那么如果您确实需要它们，则任何数量的参数都应该没问题，尽管这可能表明您的函数做得有点太多，并且您可以将工作分散到更多但更小的函数上。

Answer 2

函数调用中的大量参数通常会显示出设计问题。有一些方法可以明显减少参数的数量，例如创建传递的结构而不是单个变量或具有全局变量。我建议您不要做任何这些事情，并关注设计。那里没有快速或简单的修复，但必须维护代码的人会为此感谢您。

Answer 3

是的，8 几乎可以肯定太多了。

这里有一些老式的软件工程术语供您参考。内聚力和耦合度。 内聚是子例程自身结合在一起的程度，而耦合 是指例程之间的接口有多干净（或者例程的自给自足程度）。

对于联轴器，一般越松越好。仅通过参数进行接口（“数据耦合”）是良好的低耦合，而使用全局变量（“公共耦合”）是非常高的耦合。当你有大量参数时，通常的情况是有人试图用一层薄薄的数据耦合来隐藏它们的共同耦合。其糟糕的设计和油漆工作。

内聚力越高（内聚力越大）越好。任何修改八个不同事物的例程也很可能会遭受低内聚性的困扰。我必须查看代码才能确定，但​​我愿意打赌，很难用简短的句子清楚地解释该例程的作用。看不见的东西，我猜它在时间上是有凝聚力的（只是一堆需要大致在同一时间完成的事情）。

Answer 4

8可能是一个合适的数字。或者这 8 个中的许多人都应该属于一个适当的类作为成员，那么你可以传递该类的单个实例......仅通过这种高级讨论很难判断。

编辑：在 C 中，类与本例中的结构类似。

Answer 5

我也建议使用结构。
也许您想重新考虑您的 API 设计。

请记住，您的 API 将由开发人员使用，并且很难使用 8 参数函数调用。

Answer 6

某些 API（如 pthreads）使用的一种模式是“属性对象”，它被传递到函数中，而不是一堆离散的参数。这些属性对象是不透明的结构，具有创建、销毁、修改和查询它们的功能。总而言之，这比简单地将 10 个参数转储到函数需要更多的代码，但它是一种更健壮的方法。有时，一些额外的代码可以使您的代码更容易理解，这是值得付出努力的。

再次，有关此模式的一个很好的示例，请参阅 pthreads API。我写了 a几个月前，我写了一篇关于 pthreads API 设计的长文，这是我在其中讨论的方面之一。

Answer 7

不是从丑/不丑的角度而是从性能的角度来考虑这个问题似乎也很有趣。

我知道有一些 x86 调用约定 可以使用寄存器传递两个第一个参数和堆栈对于所有其他参数。因此，我认为，如果使用这种类型的调用约定，并且在函数总体需要超过 2 个参数的情况下始终使用指向结构的指针来传递参数，则函数调用可能会更快。在 Itanium 上，寄存器始终用于将参数传递给函数。

我认为这可能值得测试。

Answer 8

如果 API 对于这么多参数显得很麻烦，请使用指向结构的指针来传递以某种方式相关的参数。

在没有亲眼目睹的情况下，我不会评判你的设计。有些合法的函数需要大量参数，例如：

1. 具有大量多项式系数的滤波器。
2. 颜色空间使用子像素掩码和 LUT 索引进行变换。
3. n 维不规则多边形的几何算术。

还有一些非常糟糕的设计导致参数原型很大。如果您寻求更多切题的回应，请分享有关您的设计的更多信息。

Answer 9

您可以做的另一件事是将一些参数转换为状态。 OpenGL 函数的参数较少，因为您有如下调用：

glBindFramebuffer( .. ) ;
glVertexAttribPointer( .. ) ;
glBindTexture( .. ) ;
glBindBuffer( .. ) ;
glBindVertexArray( .. ) ;

// the actual draw call
glDrawArrays( .. ) ;

所有这些（glBind* 类型调用）都代表“更改状态”，所有这些都会影响下一次绘制调用。想象一下带有 20 个参数的绘制调用......绝对难以管理！

用于绘图的旧 Windows C api 也有状态，存储在“不透明指针”对象（HDC's、HWND's..）内。不透明指针基本上是 C 语言创建无法直接访问的私有数据成员的方法。例如，在 Windows 绘图 API 中，您可以通过 createDC。您可以通过以下方式设置 DC 的内部值
SetDC* 函数，例如 设置DCBrushColor。

现在您已经为 DC 设置了颜色和所有内容，您可以使用 Rectangle 函数绘制到 DC 中。您传递了 HDC 作为第一个参数，其中包含有关使用哪种颜色画笔等的信息。Rectangle 然后只需要 5 个参数，即 hdc 、x、y、宽度和高度。