是否有 TypeScript 编译器选项来强制对对象属性进行类型检查？

Question

为了编写更健壮的代码，我正在考虑将 TypeScript 用于我的基于 Web 的项目。到目前为止，我对这门语言的经验相对较少，但我遇到了一个我很难搜索的问题。

考虑下面的 TypeScript 代码：

public static getResponseCode(resObj: object): number {
    let c: number = resObj["c"]
    return c;
}

有没有一种方法可以强制 TypeScript 编译器将我拉到这里并告诉我 resObj["c"] 可能不是数字，我需要先检查它是否是数字？例如。我可以强制 TypeScript 让我像这样（或类似的东西）重写代码吗？：

public static getResponseCode(resObj: object): number {
    if (typeof resObj["c"] !== "number") { return APIResponseCode.UnknownFailure; }

    let c: number = resObj["c"]
    return c;
}

我希望我得到的结果仅仅是因为resObj["c"] 的类型是any。我可以在这里做什么？ TypeScript 中是否有通用模式？

Answer 1

您可以打开noImplicitAny 编译器选项。然后，编译器会在任何时候隐式地抱怨任何事情。

我们在tsconfig.json 中设置了 noImplictAny。

{
    "compilerOptions": {
        "noImplicitAny": true
    }
}

或者我们在命令行中这样设置tsc --noImplicitAny。

这会迫使你做某事。

例如，您可以显式使用 any。

public static getResponseCode(resObj: object): number {
    const resAny = resObj as any;
    if (resAny.c && typeof resAny.c !== "number") {
        return APIResponseCode.UnknownFailure;
    }

    const c: number = resAny.c;
    return c;
}

或者您可以使用带有a union type and a type guard 的接口。

interface ResObj {
    c: boolean | string | number | object;
}

public static getResponseCode2(resObj: ResObj): number {

    if (typeof resObj.c !== "number") {
        return APIResponseCode.UnknownFailure;
    }

    const c: number = resObj.c;
    return c;
}

Answer 2

TypeScript 不进行运行时类型检查。根据您要执行的操作，您有几个选择。首先是为resObj定义一个接口：

interface ResObj { c: number; }

现在

public static getResponseCode(resObj: ResObj): number {
  let c: number = resObj.c;
  return c;
}

如果您传递 getResponseCode 与 ResObj 不匹配的内容（带有不是数字的 c 属性），您的代码现在将无法编译。

如果您希望c 可能是一个数字，或者可能是一个字符串，该怎么办？在这种情况下，请使用联合类型：

interface ResObj { c: number | string; }

您上面的getResponseCode 的原始版本现在将无法编译。 TypeScript 会抱怨它不知道如何将string | number 转换为number。

如果您按照您的建议编写代码：

public static getResponseCode(resObj: ResObj): number {
  if (typeof resObj.c !== "number") { return APIResponseCode.UnknownFailure; }

  let c: number = resObj.c;
  return c;
}

TypeScript 会很高兴，因为它的流分析检测到 typeof 检查并知道当它到达 return 语句时，c 只能是一个数字。

对于更复杂的情况，您可以使用所谓的类型保护，它明确告诉 TypeScript 特定函数保证其参数的特定类型：

function isNumber(c: string | number): c is number {
  return typeof c === 'number';
}

现在你可以写了

public static getResponseCode(resObj: ResObj): number {
  if (!isNumber(resObj.c)) { return APIResponseCode.UnknownFailure; }

  let c: number = resObj.c;
  return c;
}