为什么 Typescript 无法弄清楚我的代码中的类型？

问题描述

为什么 Typescript 编译器会抱怨以下代码？

type Foo = {
  a: string
}

type Bar = {
  b: number
}

type Baz = Foo | Bar;

function f(x: Baz): number {
  if (x.a) { // property 'a' does not exist on type Bar!
    return 0;
  }

  if (x.b) { // property 'b' does not exist on type Foo!
    return 1;
  }

  return -1;
}

Link to Playground

解决方法

为什么编译器不能（或不会）允许这些属性访问

考虑本 github thread linked in the comments by jcalz 中提到的以下情况：

interface Vec2 {
  x: number
  y: number
}

interface Vec3 {
  x: number
  y: number
  z: number
}

const m = { x: 0,y: 0,z: "hello world" };
const n: Vec2 = m; // N.B. structurally m qualifies as Vec2!
function f(x: Vec2 | Vec3) {
  if (x.z) return x.z.toFixed(2); // This fails if z is not a number!
}
f(n); // compiler must allow this call

Playground

这里代码的作者做了一个不幸的假设，仅仅因为一个属性存在且真实，它就是某种类型。但这是双重错误的：您可能有正确类型的假值（在这种情况下为零或 NaN）或不同类型的真值。但还有一些更微妙的问题：

type Message =
  { kind: "close" } |
  { kind: "data",payload: object }

function handle(m: Message) {
  switch (m.kind) {
    case "close":
      console.log("closing!");
      // forgot 'break;' here
    case "data":
      updateBankAccount(m.payload);
  }
}

在这种情况下，您希望编译器抱怨意外的属性访问，而不仅仅是默默地传播 undefined。抓住这类事情是我们首先使用静态分析的重要原因。

Typescript 编译器已经是一项了不起的工程壮举，它不仅在动态语言而且在超动态语言之上构建了一个静态类型系统。您在此处查找的内容称为 type narrowing，您可以在其中获取可能不止一种类型的值，然后将其缩小到特定类型。 TS 编译器支持（至少）五种不同的习惯用法来实现这一点：

instanceof 运算符。
typeof 运算符。
in 运算符。
A user-defined type guard。
A discriminated union。

让我们依次看看：

实例

这个很适合用户定义的类：

class A {
  public a: number
  constructor () {
    this.a = 4;
  }
}

class B {
  public b: number
  constructor () {
    this.b = 5;
  }
}

type AB = A | B;
function abba(x: AB): number {
  if (x instanceof A) return x.a;
  if (x instanceof B) return x.b;
  return 0;
}

Playground

类型

这个非常适合 JS 原语（未定义、数字、字符串、布尔值等）。

type snumber = string | number;

function f(x: snumber): string {
  if (typeof x === 'number') {
    return x.toFixed(2); // strings don't have toFixed
  } else {
    return x.repeat(2);  // numbers don't have repeat
  }
}

Playground

在

这个很适合结构类型的对象：

type A = {
  a: number
}

type B = {
  b: string
}

type AB = A | B;

function f(x: AB): number {
  if ('a' in x) return x.a;
  if ('b' in x) return 5;
  return 0;
}

Playground

精明的读者会注意到这与上面第一个激励示例存在相同的问题，即对象上属性的存在并不能以任何方式保证类型。这是 TS 团队的一个务实决定，它允许一个简单的选择加入习语想要获得值或 undefined 的不常见行为，很像演员表是程序员对可能的结果负责的隐含承诺。

用户定义的类型保护

这几乎适用于任何事情，但比之前的选项更冗长。这个直接来自TS Handbook：

function isFish(pet: Fish | Bird): pet is Fish { // note the 'is'
  return (pet as Fish).swim !== undefined;
}

let pet = getSmallPet();

if (isFish(pet)) {
  pet.swim();
} else {
  pet.fly();
}

歧视工会

当您有一堆非常相似的对象，而这些对象仅在单个属性的（静态可知！）值上有所不同时，此方法效果最佳：

type A = {
  a: string
  kind: 'is-an-a'
}

type B = {
  b: number
  kind: 'is-a-b'
}

type AB = A | B;

function f(x: AB): string {
  switch (x.kind) {
    case 'is-an-a': return x.a;
    case 'is-a-b':  return '' + x.b;
  }
}

请注意，正如我所说，您将使判别式（在本例中为 kind 属性）成为静态已知值，通常是字符串文字或枚举的成员。您不能使用变量，因为它们的值在编译时是未知的。

Playground

所以总而言之，Typescript 编译器可以解决这个问题，你只需要使用一个它可以静态验证的习惯用法，而不是一个它不能验证的习惯用法，它为你提供了相当多的选项.

narrowing typescript typescript typescript