Dev Tricks

TypeScript 中基于控制流的类型分析

Marius Schulz, “Control Flow Based Type Analysis in TypeScript”, September 30, 2016

TypeScript 2.0 带来了很多新特新。除了已经介绍的 非空类型，还有基于控制流的类型分析。

基于控制流的类型分析

官方的 What's new in TypeScript 页面总结了基于控制流的类型分析：

With TypeScript 2.0, the type checker analyses all possible flows of control in statements and expressions to produce the most specific type possible (the narrowed type) at any given location for a local variable or parameter that is declared to have a union type.

这是一个非常冗长的解释。下面，我们用一个例子来说明 TypeScript 是如何理解变量赋值，以及缩小变量类型范围的。

let command: string | string[];

command = "pwd";
command.toLowerCase(); // Here, command is of type 'string'

command = ["ls", "-la"];
command.join(" "); // Here, command is of type 'string[]'
1
2
3
4
5
6
7

注意，所有的代码都处在同一个作用域中。同样，类型检查器也会根据变量 command 所处的位置，判定它应该是什么具体类型：

  • command 赋值为字符串 "pwd" 后，就不再可能是一个字符串数组了（联合类型中唯一的另一个选项）。因此，TypeScript 认为 command 是一个 string 类型的变量，就能调用字符串方法 toLowserCase()。
  • 同理，command 赋值为字符串数组 ["ls", "-la"] 后，就不再可能是一个字符串了。因此，就能调用数组方法 join()。

同样是根据控制流分析，下面函数里的类型检查在 TypeScript 2.0 看来也是正确的：

function composeCommand(command: string | string[]): string {
    if (typeof command === "string") {
        return command;
    }

    return command.join(" ");
}
1
2
3
4
5
6
7

编译器现在理解，if 语句里的 command 是 string 类型，进入这个分支函数会提前返回。如果没走这个分支，那么 command 只可能是 string[] 类型，所以在调用 join() 方法的时候，被认定为类型正确。

TypeScript 2.0 之前，编译器是无法推断出上述语义的。因此，string 类型不会从 command 变量所属的联合类型中移除，就会产生如下的编译期错误：

Property 'join' does not exist on type 'string | string[]'.
1

严格空值检查

基于控制流的类型分析与空类型结合使用的时候特别有用。比如，我们在操作值之前，通常会做一个是否为空的判断，这样就能把可为空变量的空值情况排除掉：

type Person = {
    firstName: string;
    lastName?: string | null | undefined;
};

function getFullName(person: Person): string {
    const { firstName, lastName } = person;

    // Here, we check for a falsy value of the `lastName` property,
    // which covers `null` and `undefined` (and other values like "")
    if (!lastName) {
    return firstName;
    }

    return `${firstName} ${lastName}`;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

上例中，Person 类型定义了一个非空属性 firstName 和可为空属性 lastName。在将它们组合成一个完整姓名的时候，我们需要先判断 lastName 为 null 或 undefined 的情况，这样就能避免输出结果中出现 "null" 或 "undefined"。

为了清楚起见，我给属性 lastName 所在的类型加了一个 undefined，虽然这么写是没必要的。在严格空值检查模式下，undefined 类型会自动加入可选属性的类型上，因此无需显式写出来。更多这方面的内容，可以参考 非空类型 这篇文章。

明确赋值分析

另一个基于控制流的新特性是 明确赋值分析（definite assignment analysis）。在严格空值检查模式下，本地变量在使用前必须要先赋值：

let name: string;

// Error: Variable 'name' is used before being assigned.
console.log(name);
1
2
3
4

当然，如果变量允许为空（比如允许 undefined），就不会有问题：

let name: string | undefined;
console.log(name); // No error
1
2

明确赋值分析是另一个避免空值调用 BUG 的保护措施。这个功能是为了保证任何非空变量在使用前被正确的初始化了。

总结

基于控制流的类型分析是 TypeScript 类型系统一个特别强大的功能添加。类型检查器理解控制流中的赋值和分支语义，极大地减少了使用 type guard 的必要。通过消除“null”和“undefined”类型，可以方便地处理可为空变量。最后，控制流分析避免了在使用变量前没有明确赋值的问题。

本篇文章是 TypeScript Evolution 系列中的一篇。