如何在 TypeScript 中进行方法重载？

Question

我想实现这样的目标：

 class TestClass {
    someMethod(stringParameter: string): void {
        alert("Variant #1: stringParameter = " + stringParameter);
    }

    someMethod(numberParameter: number, stringParameter: string): void {
        alert("Variant #2: numberParameter = " + numberParameter + ", stringParameter = " + stringParameter);
    }
}

var testClass = new TestClass();
testClass.someMethod("string for v#1");
testClass.someMethod(12345, "string for v#2");

这是我不想做的一个例子（我真的很讨厌 JS 中重载 hack 的那部分）：

 class TestClass {
    private someMethod_Overload_string(stringParameter: string): void {
        // A lot of code could be here... I don't want to mix it with switch or if statement in general function
        alert("Variant #1: stringParameter = " + stringParameter);
    }

    private someMethod_Overload_number_string(numberParameter: number, stringParameter: string): void {
        alert("Variant #2: numberParameter = " + numberParameter + ", stringParameter = " + stringParameter);
    }

    private someMethod_Overload_string_number(stringParameter: string, numberParameter: number): void {
        alert("Variant #3: stringParameter = " + stringParameter + ", numberParameter = " + numberParameter);
    }

    public someMethod(stringParameter: string): void;
    public someMethod(numberParameter: number, stringParameter: string): void;
    public someMethod(stringParameter: string, numberParameter: number): void;

    public someMethod(): void {
        switch (arguments.length) {
        case 1:
            if(typeof arguments[0] == "string") {
                this.someMethod_Overload_string(arguments[0]);
                return;
            }
            return; // Unreachable area for this case, unnecessary return statement
        case 2:
            if ((typeof arguments[0] == "number") &&
                (typeof arguments[1] == "string")) {
                this.someMethod_Overload_number_string(arguments[0], arguments[1]);
            }
            else if ((typeof arguments[0] == "string") &&
                     (typeof arguments[1] == "number")) {
                this.someMethod_Overload_string_number(arguments[0], arguments[1]);
            }
            return; // Unreachable area for this case, unnecessary return statement
        }
    }
}

var testClass = new TestClass();
testClass.someMethod("string for v#1");
testClass.someMethod(12345, "string for v#2");
testClass.someMethod("string for v#3", 54321);

如何在 TypeScript 语言中进行方法重载？

原文由 Void-995 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

根据规范，TypeScript 确实支持方法重载，但它非常笨拙，并且包含大量手动检查参数类型的工作。我认为这主要是因为在纯 JavaScript 中最接近方法重载的方法也包括检查，TypeScript 试图不修改实际的方法主体以避免任何不必要的运行时性能成本。

如果我理解正确，您必须首先为每个重载编写一个方法声明，然后 一个 方法实现检查其参数以确定调用哪个重载。实现的签名必须与所有重载兼容。

 class TestClass {
    someMethod(stringParameter: string): void;
    someMethod(numberParameter: number, stringParameter: string): void;

    someMethod(stringOrNumberParameter: any, stringParameter?: string): void {
        if (stringOrNumberParameter && typeof stringOrNumberParameter == "number")
            alert("Variant #2: numberParameter = " + stringOrNumberParameter + ", stringParameter = " + stringParameter);
        else
            alert("Variant #1: stringParameter = " + stringOrNumberParameter);
    }
}

原文由 svick 发布，翻译遵循 CC BY-SA 3.0 许可协议

Answer 2

为清楚起见更新。 TypeScript 中的方法重载是一个有用的功能，因为它允许您使用需要表示的 API 为现有库创建类型定义。

但是，在编写自己的代码时，您很可能能够使用可选或默认参数来避免重载的认知开销。这是比方法重载更具可读性的替代方法，并且还可以保持 API 诚实，因为您将避免使用不直观的顺序创建重载。

TypeScript 重载的一般规律是：

如果您可以删除重载签名并且所有测试都通过，则不需要 TypeScript 重载

您通常可以使用可选参数或默认参数 - 或联合类型或一些面向对象来实现相同的目标。

实际问题

实际问题要求超载：

 someMethod(stringParameter: string): void {

someMethod(numberParameter: number, stringParameter: string): void {

现在，即使在支持具有单独实现的重载的语言中（注意：TypeScript 重载共享一个实现） - 建议程序员提供顺序一致性。这将使签名：

 someMethod(stringParameter: string): void {

someMethod(stringParameter: string, numberParameter: number): void {

stringParameter 始终是必需的，所以它首先出现。你可以把它写成一个有效的 TypeScript 重载：

 someMethod(stringParameter: string): void;
someMethod(stringParameter: string, numberParameter: number): void;
someMethod(stringParameter: string, numberParameter?: number): void {
    if (numberParameter != null) {
        // The number parameter is present...
    }
}

但是根据 TypeScript 重载法则，我们可以删除重载签名，我们所有的测试仍然会通过。

 someMethod(stringParameter: string, numberParameter?: number): void {
    if (numberParameter != null) {
        // The number parameter is present...
    }
}

实际问题，按实际顺序

如果您决定坚持原来的顺序，那么重载将是：

 someMethod(stringParameter: string): void;
someMethod(numberParameter: number, stringParameter: string): void;
someMethod(a: string | number, b?: string | number): void {
  let stringParameter: string;
  let numberParameter: number;

  if (typeof a === 'string') {
    stringParameter = a;
  } else {
    numberParameter = a;

    if (typeof b === 'string') {
      stringParameter = b;
    }
  }
}

现在有很多分支来确定参数的放置位置，但如果你读到这里，你真的想保留这个顺序……但是等等，如果我们应用 TypeScript 重载法则会发生什么？

 someMethod(a: string | number, b?: string | number): void {
  let stringParameter: string;
  let numberParameter: number;

  if (typeof a === 'string') {
    stringParameter = a;
  } else {
    numberParameter = a;

    if (typeof b === 'string') {
      stringParameter = b;
    }
  }
}

已经有足够的分支

当然，考虑到我们需要做的类型检查的数量……也许最好的答案就是有两种方法：

 someMethod(stringParameter: string): void {
  this.someOtherMethod(0, stringParameter);
}

someOtherMethod(numberParameter: number, stringParameter: string): void {
  //...
}

原文由 Fenton 发布，翻译遵循 CC BY-SA 3.0 许可协议