前言

有這樣一個對象，它有兩個屬性：name與title，在賦值的時候這兩個屬性只有一個能出現(xiàn)，例如：name出現(xiàn)的時候title就不能出現(xiàn)，title出現(xiàn)的時候name就不能出現(xiàn)。

此時，你會怎么用TypeScript來定義這個類型？本文將帶大家實現(xiàn)一個互斥類型來解決這個問題，歡迎各位感興趣的開發(fā)者閱讀本文。

前置知識

在實現(xiàn)之前，我們需要先來了解幾個基礎(chǔ)的知識。

對象中多屬性同類型的定義

有一個對象它包含5個可選屬性a、b、c、d、e，他們的類型都為string，大多數(shù)人的定義方式應(yīng)該如下所示：

type obj = {
  a?:string;
  b?:string;
  c?:string;
  d?:string;
  e?:string;
}

那么，有沒有更好的方式呢??，答案是有的，請看我的表演：

type obj = { [P in "a" | "b" | "c" | "d" | "e"]?: string };

never類型

在TypeScript中它有一個特殊的類型never，它是所有類型的子類型，無法再進(jìn)行細(xì)分，也就意味著除了其本身沒有類型可以再分配給它。

我們舉個例子來解釋下上述話語，如下所示：

• 我們定義了一個變量amazing，給其賦予了never類型。
• 我們分別給它賦了不同類型的值，全部編譯失敗，因為它無法再進(jìn)行細(xì)分了。

let amazing: never;
amazing = 12;// 報錯：amazing是never類型不能分配給number類型
amazing = true;// 報錯：amazing是never類型不能分配給boolean類型
amazing = "真神奇";// 報錯：amazing是never類型不能分配給string類型
amazing = {};// 報錯：amazing是never類型不能分配給{}類型
amazing = [];// 報錯：amazing是never類型不能分配給[]類型

剔除聯(lián)合類型中的屬性

有一組聯(lián)合類型"a" | "b" | "c" | "d"，我們想剔除屬性b和c，在TS中提供了一個名為Exclude的函數(shù)，它可以用來做這件事，接受兩個參數(shù)：

• UnionType 聯(lián)合類型
• ExcludedMembers 需要進(jìn)行剔除的屬性

使用方法如下所示：

type P = Exclude<"a" | "b" | "c" | "d", "b" | "c"> // "a" | "d"

將對象中的所有屬性轉(zhuǎn)為聯(lián)合類型

有一個對象它包含2個可選屬性name、title，我們想把它轉(zhuǎn)為聯(lián)合類型name | title ，在TS中提供了一個名為keyof的函數(shù)，他可以用來處理這個問題，使用方法如下所示：

type A =  { [P in "name" | "title"]?: string };

type UnionType = keyof A; // "name" | "title"

實現(xiàn)互斥類型

有了前置知識作為鋪墊，接下來我們就可以將其利用起來，定義一個互斥類型出來，解決文章開頭所講述的問題。

接下來，我們來梳理下實現(xiàn)思路：

• 實現(xiàn)一個排除類型，用于從A對象類型中剔除B對象類型中的屬性，并將排除后的屬性類型設(shè)為never，得到一個新對象類型。
• 基于排除類型實現(xiàn)互斥類型，將A、B對象類型代入排除類型中，彼此將其排除，用或運(yùn)算符將二者結(jié)果連接。

聰明的開發(fā)者可能已經(jīng)猜到原理了，沒錯，就是部分屬性設(shè)為never。??

實現(xiàn)代碼

接下來，我們來看下代碼的實現(xiàn)，如下所示：

// 定義排除類型：將U從T中剔除, keyof 會取出T與U的所有鍵, 限定P的取值范圍為T中的所有鍵, 并將其類型設(shè)為never
type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };

// 定義互斥類型，T或U只有一個能出現(xiàn)（互相剔除時，被剔除方必須存在）
type XOR<T, U> = (Without<T, U> & U) | (Without<U, T> & T);

注意：為了類型的可復(fù)用性，我們使用了泛型，對此不熟悉的開發(fā)者請移步：TypeScript中文網(wǎng)——泛型

測試用例

我們將文章開頭所說的問題代入上述實現(xiàn)代碼中，看一下它能否將其解決??，如下所示：

// A類型
type A = {
  name: string;
};

// B類型
type B = {
  title: string;
};

// A和B兩種類型只有一個能出現(xiàn)
type AOrB = XOR<A, B>;

// 傳值測試
const AOrB1: AOrB = { name: "姓名" }; // 編譯通過
const AOrB2: AOrB = { title: "標(biāo)題" }; // 編譯通過
const AOrB3: AOrB = { title: "標(biāo)題", name: "姓名" }; // 報錯: Type '{ title: string; name: string; }' is not assignable to type 'AOrB'.
const AOrB4: AOrB = { name: "姓名", otherKey: "" }; // 報錯：Type '{ name: string; otherKey: string; }' is not assignable to type 'AOrB'.

當(dāng)兩個屬性同時出現(xiàn)時，編輯器直接就拋出了類型錯誤（我們把排除后的所有屬性的類型設(shè)為了never，因此當(dāng)你給其賦任何值時它都會報類型錯誤），如下圖所示：

用例拆解

有一部分開發(fā)者可能對上述測試用例比較懵，把它們拆開都認(rèn)識，因為前置知識里都講了，但是寫到一起就不認(rèn)識了??，沒關(guān)系，那我就把它們都拆解出來吧，代碼如下所示：

type AOB = ({ name?: never } & {
      title: string;
    }) | ({ title?: never } & {
      name: string;
    });

// 傳值測試
const a: AOB = { name: "姓名" }; // 編譯通過
const b: AOB = { title: "標(biāo)題" }; // 編譯通過
const c: AOB = { title: "標(biāo)題", name: "姓名" }; // 報錯
const d: AOB = { title: "標(biāo)題", otherKey: "" }; // 報錯

看到這里，可能還有一部分開發(fā)者沒有理解，那就動起手來在編輯器里敲一敲，如果還沒理解的話，就先把這篇文章收藏，日后有時間了，在拿出來學(xué)一學(xué)。

寫在最后

至此，文章就分享完畢了。

到此這篇關(guān)于TypeScript中互斥類型實現(xiàn)的文章就介紹到這了,更多相關(guān)TypeScript互斥類型內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論