TypeScript的索引類型與映射類型,以及常用工具泛型的實現

相信現在很多小伙伴都在使用 TypeScript(以下簡稱 TS),在 TS 中除了一些常用的基本類型外,還有一些稍微高級一點的類型,這些就是我本次文章要講的內容:索引類型與映射類型,希望小伙伴們看過這篇文章后能對 TS 有更深一步的理解。

索引類型

下面我通過一個官方的例子來說明下什么是索引類型:

function pluck(o, names) {
  return names.map((n) => o[n])
}

這是個簡單的函數,names 是一個數組,里面是 key 值,我們可以從“o”里面取出這些 key 值,理想情況下 names 里面的 key 應該都是“o”里面包含的,否則最終的結果里面就會有 undefined,這個函數返回的結果也應該是“o”中都包含的 value 值,那么我們如何才能做到這些類型約束呢,如果只用一些基礎類型,很難達到滿意的效果,下面使用索引類型改寫下:

function pluck<T, K extends keyof T>(o: T, names: K[]): T[K][] {
  return names.map((n) => o[n])
}

interface Person {
  name: string
  age: number
}
let person: Person = {
  name: 'Jarid',
  age: 35
}
let strings: string[] = pluck(person, ['name']) // ok, string[]

改寫后這個函數是一個泛型函數,泛型為 T 和 K,其中 K 有點特殊,K extends keyof T,是什么意思呢,其中 keyof 就是索引類型查詢操作符,我們從字面意思理解,它就是 T 的 key,就是 T 上已知的公共屬性名的聯合,對于上面的代碼,keyof Person就是'name'|'age',那么K extends keyof T就是K extends 'name'|'age',這樣我們就獲取到了 Person 上所有 key 組成的一個聯合類型,然后參數o: T, names: K[],就很好理解了,names 就是 K 組成的一個數組。返回值中T[K][]我們需要拆開來看 T[K]和[],就是 T[K]組成的一個數組,那么 T[K]是什么類型呢,它就是索引訪問操作符,類似于 js 中對象的取值操作,不過這里取的是類型,因為 K 是'name'|'age',所以 T[K]就是string|number,這些就是索引類型,其實也不難理解,下面再說下映射類型,它和索引類型結合起來可以做很多事情。

映射類型

映射類型也很容易理解,我們先看一個簡單的例子

type Keys = 'option1' | 'option2'
type Flags = { [K in Keys]: boolean }

這個就是一個簡單的映射類型,其中的in可以理解為是我們平時用的for...in,就是去遍歷 Keys,然后把 boolean 賦給每一個 key,上面的 Flags 得到的結果就是

type Flags = {
  option1: boolean
  option2: boolean
}

很簡單吧,那么這個東西有什么用處呢,請看下面的例子:

// Person
type Person {
    name: string
    age: number
}

我們想把這個 Person 里面的屬性都變成只讀的,像這樣:

// Readonly Person
type Person {
    readonly name: string
    readonly age: number
}

如果我們有很多這樣的類型,那么改起來會很麻煩,因為每次都要把這個類型重新寫一遍。其實我們可以使用剛才的索引類型和映射類型來寫一個泛型:

type Readonly<T> = {
  readonly [P in keyof T]: T[P]
}

[P in keyof T]就是遍歷 T 中的 key,T[P]就是當前的 key 的類型,其實[P in keyof T]: T[P]就是把 T 遍歷了一遍,但是我們在屬性前面加了個 readonly,這樣我們調用這個泛型的時候,它就會把傳入的類型的 key 遍歷一遍,遍歷的同時在前面加個 readonly,最終給我們返回一個新的類型。我們在調用的時候只需要這么用:

type Readonly<T> = {
  readonly [P in keyof T]: T[P]
}
type Person {
    name: string
    age: number
}
type ReadonlyPerson = Readonly<Person>

索引類型和映射類型除了能實現 Readonly,還能實現很多有意思的東西,我們平時在使用 TS 的時候,TS 已經內置了一些常用的輔助泛型,剛才的 Readonly 就是其一,另外還有很多,我從 TS 的類型定義文件里找了一些,這些泛型從簡單到復雜的都有,但基本上都是用上面提到的兩個類型實現的,下面我們一起來分析一下。

TS 常用的輔助泛型及其實現方式

首先來看第一個

/**
 * Make all properties in T optional
 */
type Partial<T> = {
  [P in keyof T]?: T[P]
}

相信這個泛型很多人都用過,就是把類型都變成可選的,和剛才的 Readonly 是類似的實現方式,只是這個是在后面加了個問號,這樣一來屬性就變成可選的了。
與之相對的還有一個 Required

/**
 * Make all properties in T required
 */
type Required<T> = {
  [P in keyof T]-?: T[P]
}

注意這個稍有點不同,它是-?,其實就是減去問號,這樣就可以把問號去掉,從而變成必選的屬性。再來看下一個

/**
 * From T, pick a set of properties whose keys are in the union K
 */
type Pick<T, K extends keyof T> = {
  [P in K]: T[P]
}

如果你理解了最開始的那個 pluck 函數,這個就很好理解了,我們傳入 T 和 K,其中 K 是 T 的 keys 組成的聯合類型,再看返回值[P in K]: T[P],就是把 K 遍歷了一遍,同時賦值上原類型,那么綜合來看 Pick 就是幫我們提取出某些類型的,比如通過Pick<Person, 'name'>我們就可以得到{name: string},再來看下一個

/**
 * Exclude from T those types that are assignable to U
 */
type Exclude<T, U> = T extends U ? never : T

這個泛型傳入一個 T 和 U,然后它判斷了 T 是否屬于 U,屬于的話返回 never 否則返回原類型 T,注意 never 在最終的類型中是不會存在的,所以它可以幫助我們消除某些屬性,其實這個 Exclude 就是消除了T extends U的類型,比如我們使用Exclude<'a'|'b','b'|'c'>,最終會得到'a',與之相反的有:

/**
 * Extract from T those types that are assignable to U
 */
type Extract<T, U> = T extends U ? T : never

這個正好相反,是從 T 中取出 U 中擁有的類型。

有了 Exclude,我們就可以和 Pick 結合來實現另外一個:

/**
 * Construct a type with the properties of T except for those in type K.
 */
type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>

這個泛型是先使用了Exclude<keyof T, K>,去除了 keyof T 中的 K,然后又使用 Pick 取出了這些類型,這樣我們就可以從 T 中去除 K 里面包含的 keys 了,達到和 Pick 相反的效果。

我們再來看另一個稍微復雜一點的

type NonNullObject<O> = Pick<
  O,
  {
    [K in keyof O]: O[K] extends null | undefined ? never : K
  }[keyof O]
>

這個不是 TS 內置的類型,但也是一個很有用的類型,我們來一點一點分析。首先這個泛型使用了 Pick,我們知道 Pick 就是取出一些屬性,我們先看傳給 Pick 的第二個參數


{
  [K in keyof O]: O[K] extends null | undefined ? never : K
}[keyof O]

它遍歷了 O 的 keys,然后進行了一個判斷,如果是extends null | undefined則返回 never,否則返回 K,K 就是 O 中的 key 值,注意這里和之前的一些泛型有些不一樣,之前的都是O[K],而這里的屬性的值還是 K,最終我們得到的是類似K:K這樣的東西,比如{name: string, age: null}這個,經過上面的轉化會變成{name:'name', age:never},可能有些小伙伴還不清楚為什么要這樣轉換,我們接著往下分析,經過這個轉換之后,又進行了一個操作[keyof O],對于 Person,keyof O 就是'name'|'age',那么這里就就是{name:'name', age:never}['name'|'age'],這樣就很清晰了,其實就是一個取值操作,這樣我們就可以得到'name'|never,還記得 never 的特性嗎,它可以幫我們消除一些類型,那么最終的就是'name',這也是為什么我們寫成類似 K:K 這樣,就是要把 null|undefined 對應的 key 轉換成 never,然后再通過 keyof 把他們全都取出來,別忘了最外面還有一個 Pick,這樣我們就從原始類型中去除了 null|undefined。

另外還有一個比較有用的是 ReturnType

/**
 * Obtain the return type of a function type
 */
type ReturnType<T extends (...args: any) => any> = T extends (
  ...args: any
) => infer R
  ? R
  : any

它可以幫我們取到函數返回值的類型,這個 ReturnType 接收的一個參數是函數,然后進行了一個判斷T extends (...args: any) => infer R,就是判斷是否是函數,這里有個東西是 infer,通過這個操作符我們可以獲取 R 的引用,就是函數的返回值,最終再把 R 返回出去,就獲得了函數 T 的返回值。

其實除了我分析的這些泛型,TS 還內置了其他的很多泛型,比如還有獲取函數的參數的,獲取構造函數類型的,總的來說各種泛型基本上都可以用索引類型和映射類型實現,希望大家看過這篇文章后能多多使用這兩種類型,在自己的項目里也能開發一些常用的輔助泛型,來提升工作效率。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,646評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,595評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,560評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,035評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,814評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,224評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,301評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,444評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,988評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,804評論 3 355
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,998評論 1 370
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,544評論 5 360
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,237評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,665評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,927評論 1 287
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,706評論 3 393
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,993評論 2 374

推薦閱讀更多精彩內容