避免在函数体内检查参数的正确性

Question

我最近注意到我们代码库中较早编写的一个函数，我确信它在逻辑上是不正确的。函数是用 TypeScript 编写的，它的主体是这样的：

const getUserInitials = (user: IUser | null) => {
   if (!user) { return ""; }
   
   return (user.FirstName.charAt(0) + user.LastName.charAt(0)).toUpperCase();
}

我很确定这是不正确的，因为这种函数签名允许传递不正确的参数，然后在内部尝试通过返回空字符串来修复不正确的 arg 通道。我认为这应该改写为只保留IUser 类型（而不是IUser | null）的用户参数，并且应该在函数调用之外和之前进行这种参数检查，以便函数始终接收正确的参数。

在开发时是否应将其视为经验法则？我不是在谈论当你收到一个整数并且你的函数只有在你的整数必须不超过 100 时才需要运行的情况。显然，你需要检查函数内部的那种东西，因为有人可以通过不正确的值，这是您无法控制的。这似乎是对函数的合理关注，我们显然需要在内部检查它以提供正确的函数输出。

但在本例中，情况完全不同 - 函数合同说它会给你一个用户的首字母，但在某些情况下，它只会返回一个空字符串“”（这不是用户首字母，所以它是一个如我所见，违反了功能合同）。

我什至会说函数命名不正确，应该调用它

getInitials(user: IUser) => {...}

因为我们清楚地将用户作为参数，所以函数名中的“用户”一词是多余的。

1. 首先 - 在这种情况下，我对违反合同以及在调用函数之前检查参数正确性的必要性的理解是否正确？

2. 如果我是正确的 - 是否存在在静态类型语言中检查内部参数正确性的好方法（在我的示例中跳过案例，整数需要不超过 100 和类似的案例，哪个当然与语言类型系统无关）？

3. 我在函数名冗余中关于“用户”的说法正确吗？

提前谢谢你。

Answer 1

问题 1：是的，您应该在使用该参数调用函数之前检查该参数是否有效。

问题 3：根据经验，我会拒绝。 GetInitials 含糊不清。在您的示例中，当您调用该函数时，您不一定知道它是用于用户姓名的首字母。

（在面向对象的编程中，这不是问题，在这种编程中你会有 User.GetInitials() 所以在某种程度上 User 已经在名字中了。）

Answer 2

1. 你部分正确：

   a：检查函数的参数并设计它在异常情况下的行为永远不会有坏处。在 Typescript 这样的语言中尤其如此，它可以从无类型的 Javascript 中调用。您可能是对的，没有人应该在没有有效用户的情况下调用此函数， 但这并不意味着没有人会。

   b：如果您可以以有意义的方式解释 null 参数，那么这样做并返回合理的默认值通常是合理的。但是，我认为在这种情况下返回一个空字符串是不合理的。在这种情况下最好抛出错误。

   c：如果你不能返回一个合理的默认值，那么方法签名应该不允许空参数......但你可以仍然检查它们并 抛出一个比默认情况下可能发生的错误更有意义的错误。不幸的是，许多人使用 eslint 的配置方式会抱怨此类检查，而这通常是这些 | null 添加到方法签名的来源。

2. 静态输入是不够的。如果您的语言阻止使用错误类型的参数有意义地调用您的函数，那么您永远不需要检查类型。 Typescript 不是那种语言。

3. 绝对不是。在打字稿中，方法参数不是方法签名的一部分。 getInitials(user: User) 与getInitials(firstName: string, lastName: string) 功能相同。如果你创建了一个名为getInitials 的函数，那么没有其他人可以在同一范围内创建另一个函数。不要认为你所做的一切都是一个特殊的情况，应该得到一个不合格的名字。