Typescript - 泛型

泛型,顾名思义广泛的类型,是一种让组件一次支持多种类型的技术方案。大型软件系统的研发需要更为抽象的接口定义,以此达到更为合理的代码复用。

Hello world

在了解泛型之前,先看一个简单的加法函数定义

function add (x: number, y: number): number {
    return x + y;
}

当开发者想更多地使用此方法向外提供能力时,比如字符串的相加,此时就得对其进行改造,让接受的参数和返回的值包含字符串类型。可以使用any来兼容多种类型,代码如下:

function add (x: any, y: any): any {
    return x + y;
}

使用any固然可以达到所谓泛型的效果,可以支持多种类型值的传入和返回,但此时也会丢失对类型的校验能力。比如,传入2个number类型的值进行加法运算,从朴素的认知出发,应该返回number类型,但函数的这种定义形式只能返回any的类型。
typescript提供类型变量(type variables)可以解决上述的问题。类型变量作用于类型,而非实际的值,值的类型在使用时传入。使用类型变量改造前面的代码后,代码如下:

function add<T> (x: T, y: T): T {
    return x + y;
}

add函数添加类型变量T,这样就可以获取到使用者传入的实际类型,类型系统也能据此做相应的类型校验。添加类型变量后,函数在调用时也需要传入相应的类型,使用示例如下:

const result = add<number>(3, 4);

类型变量的传入使用<>而不是()包裹,这里将number赋值给类型变量T,表明传入参数和返回类型都是number

Generic Types

函数的泛型定义类似于函数的定义,但与其不同的是没有函数体,包含参数列表和返回类型的说明。比如将add赋值给另外一个定义的变量,代码如下

const myAdd: (x: T, y: T) => T = add;

也可以使用其他类型变量名来替换T,跟定义函数时使用不同的参数名称类似,比如将T换成InputType,代码如下:

const myAdd: (x: InputType, y: InputType) => InputType = add;

函数泛型的定义还可以使用调用签名的方式(call signature),形式类似于对象常量(object literal),代码如下:

const myAdd: { <T>(x: T, y: T): T } = add;

调用签名可以通过interface进行定义,这样在一处定义,其他使用此类型的地方都可以引用,该定义如下:

interface GenericAdd {
    <T>(x: T, y: T):  T
}
// myAdd在使用时需要传入相应的类型
const myAdd: GenericAdd = add;

在有些场景下,可以将类型变量T作为整个GenericAdd的类型变量,这样整个interface内部都可以使用这个类型变量,此时可以将类型变量提升作用域。代码如下:

interface GenericAdd<T> {
     (x: T, y: T):  T
}
// myAdd的输入和输出类型均为number
const myAdd: GenericAdd<number> = add;

通过上面的修改,我们生成了一个generic interface

Generic Classes

泛型类跟泛型接口形式类似,在类名后使用<>包裹类型变量,并在类中使用该类型变量。
这里可以直接看官方的文档示例代码,代码如下:

class GenericNumber<NumType> {
  zeroValue: NumType;
  add: (x: NumType, y: NumType) => NumType;
}
 
let myGenericNumber = new GenericNumber<number>();
myGenericNumber.zeroValue = 0;
myGenericNumber.add = function (x, y) {
  return x + y;
};

上述的代码传入number类型,当然也可以传入string类型,代码如下:

let stringNumeric = new GenericNumber<string>();
stringNumeric.zeroValue = '';
stringNumeric.add = function (x, y) {
  return x + y;
};

console.log(stringNumeric.add(stringNumeric.zeroValue, "test"));

不管是number还是string,这些都是简单的类型,用户同样可以传入更为复杂的自定义类型。

⚠️ generic class中的静态属性不能应用类型变量。详情参考这里

Generic Constraints

使用类型变量时,需要关注对类型使用的限制。以前面的add函数为例,假设在字符串相加的场景中需要判断字符串的长度,传入的字符串长度不能小于2,否则不执行字符串加法。代码可能如下:

function add<T> (x: T, y: T): T {
// Property 'length' does not exist on type 'Type'.
    if (x.length < 2 || y.length < 2) {
        return console.log('字符串的长度不能小于2');
    }
    return x + y;
}

在类型校验阶段,会抛出错误Property 'length' does not exist on type 'T'.。很明显,number类型的值是没有length属性的。
假设该方法只处理具有length属性类型的参数的加法,那么可以做相应的类型约束,让T从包含length属性的基础类型继承。代码如下:

interface WithLength {
    length: number;
}

function add<T extends WithLength> (x: T, y: T): T {
    if (x.length < 2 || y.length < 2) {
        return console.log('长度不能小于2');
    }
    return x + y;
}

对类型添加约束后,函数调用时类型系统会根据约束校验参数和返回值是否合法。

Using Type Parameters in Generic Constraints

受益于typescript提供的类型运算的能力,类型变量可以从其他类型变量生成而来。同样来看官方文档提供的获取对象属性的示例代码,代码如下:

function getProperty<Type, Key extends keyof Type>(obj: Type, key: Key) {
  return obj[key];
}
 
let x = { a: 1, b: 2, c: 3, d: 4 };
 
getProperty(x, "a");
//⚠️ m 不是 x 对象的属性,编译阶段会报错
getProperty(x, "m");

函数getProperty接收两个类型变量TypeKey,其中Key是基于对Type的类型运算生成的。keyof是对给定类型的运算,如果Type为对象类型,则其结果为一个对象key组成的union。以上面的代码为例:Key = 'a' | 'b' | 'c' | 'd'

Using Class Types in Generics

在typescript中使用泛型构建实例工厂,需要关注构造函数的使用。如下代码:

function create<Type>(c: { new (): Type }): Type {
  return new c();
}

这里需要注意定义构造函数的签名,构造函数返回的实例类型需给传入的class类型一致。
下面是一个更为复杂的示例:

class BeeKeeper {
  hasMask: boolean = true;
}
 
class ZooKeeper {
  nametag: string = "Mikle";
}
 
class Animal {
  numLegs: number = 4;
}
 
class Bee extends Animal {
  keeper: BeeKeeper = new BeeKeeper();
}
 
class Lion extends Animal {
  keeper: ZooKeeper = new ZooKeeper();
}
 
function createInstance<A extends Animal>(c: new () => A): A {
  return new c();
}
 
createInstance(Lion).keeper.nametag;
createInstance(Bee).keeper.hasMask;

这个示例展示了如何使用prototype(通过classextend语法糖)约束类构造函数和类类型之间的关系。

小结

本文介绍了泛型/泛型约束/泛型类及其简单的使用示例,揭开typescript泛型神秘的面纱,让读者能否快速了解和使用泛型。同时本文也是typescript类型运算系列的第一篇,后续会带来其他类型运算的文章,敬请期待。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,458评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,454评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,171评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,062评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,440评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,661评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,906评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,609评论 0 200
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,379评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,600评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,085评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,409评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,072评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,088评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,860评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,704评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,608评论 2 270

推荐阅读更多精彩内容