12

我已经看到在指定索引范围时使用了两种替代约定，例如

subString(int startIndex, int length);

对比

subString(int startIndex, int endIndex);

就你可以用它们做什么而言，它们显然是等价的，唯一的区别是你是指定结束索引还是范围的长度。

我假设在所有情况下 startIndex 都是包容性的，而 endIndex 是排斥性的。

在定义 API 时，是否有任何令人信服的理由来选择其中一个？

4

4 回答 4

7

我更喜欢这个，length因为它让我在文档中询问/查找的问题少了一个。

对于endIndex基于的 - 这是一个包容性或排他性的终点？

（对于任何一种变体，都可以询问相同的问题，但startIndex它会是一个不正当的 API，使其具有排他性）。

于 2013-01-11T06:18:47.827 回答
3

如何消除位置参数的歧义...

  1. 使用更长的名称 subStringFromUpto( startIndex , stopIndex )

  2. 在整个库中使用统一约定

这么多年过去了，我们没有找到更好的吗？

啊，是的，也许在 Smalltalk 中，因为这个问题被标记为与语言无关......

aString copyFrom: startIndex to: stopIndex.
aString substringOfLength: length startingAt: startIndex.

不那么含糊，但也许我们还得再等 30 年才能更广泛地采用这种风格
（它可能看起来太简单了，不能认真）

于 2013-01-11T17:47:55.933 回答
2

这是一个很好的问题，我认为使用哪种偏好归结为最常见的用例。大多数用例使用任一 API 都同样简单，但请考虑以下情况：

您想获得一个从 5 开始并在字符串末尾结束的子字符串。使用基于索引的版本（假设它的第二个索引是独占的），它很简单：

str.subString(5, str.length());

使用基于长度的 API：

str.subString(5, str.length() - 5);

第二种方法不那么简洁和明显。但是，这可以通过简单地说明如果长度会导致剩余字符串溢出来解决，它将优雅地支持这一点（例如str.subString(5, str.length());，将抓取从索引 5 到结尾的所有内容，即使它可能要求的字符数可能比剩余的字符数多）。除了支持负索引等高级功能外，Ruby 还使用他们的String#splice方法来做到这一点。

在我看来，基于索引的方法更具体，尤其是在不允许使用负索引的情况下。这使得对 API 的期望变得非常明显，这可能是一件好事；让自己更难射中自己的脚。然而，像 Ruby 这样有据可查的 API 可以很容易地赋予程序员权力，并且可以进行一些优雅的子字符串化。

我还发现，一般来说，当我执行子字符串操作时，我经常知道我的起点和终点。使用基于长度的方法，调用 API 时将需要额外的计算（例如substring(startIndex, endIndex - startIndex)）。

于 2013-01-11T06:28:17.853 回答
0

有人应该对典型的调用站点进行研究，以找出哪种方法产生更简洁的代码（因此可能是正确的代码）。

我喜欢这样的论点，即使用“长度”您不必查看文档，但您可能已经在查看文档以确定第二个整数是“结束”还是“长度”。如果您将其命名为 endExclusive，那么它就像自我记录一样。

于 2016-07-13T17:16:16.420 回答