有没有办法在TypeScript中进行方法重载?

时间:2012-10-02 10:03:27

标签: javascript typescript operator-overloading

有没有办法在TypeScript语言中进行方法重载?

我想实现这样的目标:

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);

6 个答案:

答案 0 :(得分:131)

根据规范,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);
    }
}

答案 1 :(得分:24)

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

但是,在编写自己的代码时,您可能能够使用可选参数或默认参数来避免重载的认知开销。这是方法重载的更易读的替代方法,也可以保证您的API诚实,因为您将避免使用不直观的排序创建重载。

TypeScript重载的一般规律是:

  

If you can delete the overload signatures and all of your tests pass, you don’t need TypeScript overloads

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

实际问题

实际问题要求超载:

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重载法则会发生什么? / p>

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 {
  //...
}

答案 2 :(得分:8)

我希望。我也想要这个功能,但是TypeScript需要与没有重载方法的无类型JavaScript互操作。即如果从JavaScript调用重载方法,那么它只能被调度到一个方法实现。

有关codeplex的一些相关讨论。例如

https://typescript.codeplex.com/workitem/617

我仍然认为TypeScript应该生成所有if'ing和切换,所以我们不需要这样做。

答案 3 :(得分:2)

JavaScript没有任何重载概念。 Typescript不是c#或Java。

但是您可以在Typescript中实现重载。

阅读这篇文章 http://www.gyanparkash.in/function-overloading-in-typescript/

答案 4 :(得分:1)

为什么不使用optional property defined interface作为函数参数..

对于这个问题的情况,使用一些可选属性定义的内联接口只能直接生成如下代码:

class TestClass {

    someMethod(arg: { stringParameter: string, numberParameter?: number }): void {
        let numberParameterMsg = "Variant #1:";
        if (arg.numberParameter) {
            numberParameterMsg = `Variant #2: numberParameter = ${arg.numberParameter},`;
        }
        alert(`${numberParameterMsg} stringParameter = ${arg.stringParameter}`);
    }
}

var testClass = new TestClass();
testClass.someMethod({ stringParameter: "string for v#1" });
testClass.someMethod({ numberParameter: 12345, stringParameter: "string for v#2" });

因为TypeScript中提供的重载是其他人的注释中提到的,只是一个函数的不同签名列表,而没有像其他静态语言那样支持相应的实现代码。因此,实现仍然只需要在一个函数体中完成,这使得在Typescript中使用函数重载不如支持真实重载特性的语言那样舒适。

然而,仍然有许多新的和方便的东西在打字稿中提供,这在遗留编程语言中是不可用的,其中匿名界面中的可选属性支持是这样一种方法来满足传统函数重载的舒适区域,我认为

答案 5 :(得分:0)

如果方法重载有很多变化,另一种方法是只创建一个包含所有args的类。因此,您可以按任意顺序仅传递所需的参数。

class SomeMethodConfig {
  stringParameter: string;
  numberParameter: number;

 /**
 *
 */
 constructor(stringParameter: string = '012', numberParameter?: number) { // different ways to make a param optional
   this.numberParameter = 456; // you can put a default value here
   this.stringParameter = stringParameter; // to pass a value throw the constructor if necessary
 }
}

您还可以使用默认值创建一个构造函数和/或传递一些强制性参数。然后像这样使用:

const config = new SomeMethodConfig('text');
config.numberParameter = 123; // initialize an optional parameter only if you want to do it
this.SomeMethod(config);