聊聊 TypeScript 中的類型保護

• 2020 年 5 月 14 日
• 筆記
• typescript

聊聊 TypeScript 中的類型保護

在 TypeScript 中使用聯合類型時，往往會碰到這種尷尬的情況：

interface Bird {
  	// 獨有方法
    fly();
  	// 共有方法
    layEggs();
}

interface Fish {
  	// 獨有方法
    swim();
  	// 共有方法
    layEggs();
}

function getSmallPet(): Fish | Bird {
    // ...
}

let pet = getSmallPet();
pet.layEggs(); // 正常
pet.swim();    // ts 報錯

如上所示，getSmallPet 函數中，既可以返回 Fish 類型的對象，又可以返回 Bird 類型的對象。由於返回的對象類型不確定，所以使用聯合類型對象共有的方法時，一切正常，但是使用聯合類型對象各自獨有的方法時，ts 會報錯。

那麼如何解決這個問題呢？最粗暴的方法當然是將聯合類型轉換為 any，不過這種方法不值得提倡，畢竟我們寫的是 TypeScript 而不是 AnyScript。

此時，我們使用今天的主角——類型保護，閃亮登場，它可以完美的解決這個問題。

孔乙己說過，茴香豆有四種寫法，同理，實現類型保護，也有四種寫法。

類型斷言

類型斷言是最常用的一種類型保護方法，即直接指定類型。由於，TypeScript 中識別的類型大多是靠 TypeScript 的自動類型推算算出來的，所以會出現上面所說的那種問題，即 TypeScript 不知道具體對象類型是什麼，所以不確定有沒有聯合類型各自獨有的方法。

當使用類型斷言直接指定類型時，相當於你讓 TypeScript 開啟了上帝模式，可以直接知道具體類型是聯合類型中的那個，此時再使用對象的獨有方法就符合 TypeScript 的推斷了。

interface Bird {
  // 獨有方法
  fly();
  // 共有方法
  layEggs();
}

interface Fish {
  // 獨有方法
  swim();
  // 共有方法
  layEggs();
}

function getSmallPet(): Fish | Bird {
  // ...
}

let pet = getSmallPet();
pet.layEggs(); // 正常
// 通過鴨子類型來進行判斷
if ((pet as Bird).fly) {
  // 類型斷言
  (pet as Bird).fly()
} else {
  // 類型斷言
  (pet as Fish).swim()
}

如果嫌棄通過 as 來進行類型斷言不夠上流，還可以使用類泛型的寫法，即：

let pet = getSmallPet();
pet.layEggs(); // 正常
// 通過鴨子類型來進行判斷
if ((<Bird>pet).fly) {
  (<Bird>pet).fly()
} else {
  (<Fish>pet).swim()
}

tips：友情提示，雖然使用類泛型寫法進行類型斷言看起來高端一些，但是由於在 tsx 中語法存在歧義，所以為了統一起見，推薦使用 as 的方法進行類型斷言。

in 語法

在 JS 中，我們經常使用 in 語法來判斷指定的屬性是否在指定的對象或其原型鏈中。

同理，在 TypeScript 中，我們可以通過這種方法確認對象類型。

interface Bird {
  // 獨有方法
  fly();
  // 共有方法
  layEggs();
}

interface Fish {
  // 獨有方法
  swim();
  // 共有方法
  layEggs();
}

function getSmallPet(): Fish | Bird {
  // ...
}

let pet = getSmallPet();
pet.layEggs(); // 正常
// 使用 in 語法進行類型保護
if ('fly' in pet) {
  pet.fly()
} else {
  pet.swim()
}

原理同類型斷言一樣，都是引導 TypeScript 的類型推斷，確定對象類型。

instanceof 語法

當聯合類型中使用的是 class 而不是 interface 時，instanceof 語法就派上用場了，通過 instanceof 語法可以區分不同的 class 類型。

class Bird {
  // 獨有方法
  fly() {};
  // 共有方法
  layEggs() {};
}

class Fish {
  // 獨有方法
  swim() {};
  // 共有方法
  layEggs() {};
}

function getSmallPet(): Fish | Bird {
  // ...
}

let pet = getSmallPet();
pet.layEggs(); // 正常
// 使用 in 語法進行
if (pet instanceof Bird) {
  pet.fly()
} else {
  pet.swim()
}

typeof 語法

typeof 語法不同於 in 語法以及 instanceof 語法，in 語法以及 instanceof 語法都是用來引導類型推斷進行不同對象類型推斷，而 typeof 語法常用於基本類型的推斷（或者是聯合使用基本類型和對象類型）。

簡而言之，當使用 typeof 能夠區分聯合類型中的不同類型時，即可使用它。

function getSmallPet(): number | string {
  // ...
}

let pet = getSmallPet();
if (typeof pet === 'number') {
  pet++
} else {
  pet = Number(pet) + 1
}

總結

就如茴香豆的四種寫法的本質依然是茴香豆一樣，類型保護的四種寫法的本質也是一樣的，即，引導 TypeScript 中的類型推斷將類型推斷的多選題變為單選題，這就是類型保護的本質。