TypeScript 高级用法

北京字节跳动网络技术有限公司

本文主要介绍 TypeScript 的高级用法,适用于对 TypeScript 已经有所了解或者已经实际用过一段时间的同学,分别从类型、运算符、操作符、泛型的角度来系统介绍常见的 TypeScript 文章没有好好讲解的功能点,最后再分享一下自己的实践经历。

一、 类型

unknown

unknown 指的是不可预先定义的类型,在很多场景下,它可以替代 any 的功能同时保留静态检查的能力。

const num: number = 10;
(num as unknown as string).split('');  	// 注意,这里和any一样完全可以通过静态检查
复制代码

这个时候 unknown 的作用就跟 any 高度类似了,你可以把它转化成任何类型,不同的地方是,在静态编译的时候,unknown 不能调用任何方法,而 any 可以。

const foo: unknown = 'string';
foo.substr(1);   	// Error: 静态检查不通过报错
const bar: any = 10;
any.substr(1);		// Pass: any类型相当于放弃了静态检查
复制代码

unknown 的一个使用场景是,避免使用 any 作为函数的参数类型而导致的静态类型检查 bug:

function test(input: unknown): number {
  if (Array.isArray(input)) {
    return input.length;    // Pass: 这个代码块中,类型守卫已经将input识别为array类型
  }
  return input.length;      // Error: 这里的input还是unknown类型,静态检查报错。如果入参是any,则会放弃检查直接成功,带来报错风险
}
复制代码

void

在 TS 中,void 和 undefined 功能高度类似,可以在逻辑上避免不小心使用了空指针导致的错误。

function foo() {}  	// 这个空函数没有返回任何值,返回类型缺省为void
const a = foo();	// 此时a的类型定义为void,你也不能调用a的任何属性方法
复制代码

void 和 undefined 类型最大的区别是,你可以理解为 undefined 是 void 的一个子集,当你对函数返回值并不在意时,使用 void 而不是 undefined。举一个 React 中的实际的例子。

// Parent.tsx
function Parent(): JSX.Element {
  const getValue = (): number => { return 2 };   	/* 这里函数返回的是number类型 */
  // const getValue = (): string => { return 'str' };	/* 这里函数返回的string类型,同样可以传给子属性 */
  return <Child getValue={getValue} />
}
复制代码
// Child.tsx
type Props = {
  getValue: () => void;  // 这里的void表示逻辑上不关注具体的返回值类型,number、string、undefined等都可以
}
function Child({ getValue }: Props) => <div>{getValue()}</div>

复制代码

never

never 是指没法正常结束返回的类型,一个必定会报错或者死循环的函数会返回这样的类型。

function foo(): never { throw new Error('error message') }  // throw error 返回值是never
function foo(): never { while(true){} }  // 这个死循环的也会无法正常退出
function foo(): never { let count = 1; while(count){ count ++; } }  // Error: 这个无法将返回值定义为never,因为无法在静态编译阶段直接识别出
复制代码

还有就是永远没有相交的类型:

type human = 'boy' & 'girl' // 这两个单独的字符串类型并不可能相交,故human为never类型
复制代码

不过任何类型联合上 never 类型,还是原来的类型:

type language = 'ts' | never   // language的类型还是'ts'类型
复制代码

关于 never 有如下特性:

  • 在一个函数中调用了返回 never 的函数后,之后的代码都会变成deadcode
function test() {
  foo();  		// 这里的foo指上面返回never的函数
  console.log(111); 	// Error: 编译器报错,此行代码永远不会执行到
}
复制代码
  • 无法把其他类型赋给 never:
let n: never;
let o: any = {};
n = o;  // Error: 不能把一个非never类型赋值给never类型,包括any
复制代码

关于 never 的这个特性有一些很 hack 的用法和讨论,比如这个知乎下的尤雨溪的回答

二、运算符

非空断言运算符 !

这个运算符可以用在变量名或者函数名之后,用来强调对应的元素是非 null|undefined 的

function onClick(callback?: () => void) {
  callback!();		// 参数是可选入参,加了这个感叹号!之后,TS编译不报错
}
复制代码

你可以查看编译后的 ES5 代码,居然没有做任何防空判断。

function onClick(callback) {
  callback();
}
复制代码

这个符号的场景,特别适用于我们已经明确知道不会返回空值的场景,从而减少冗余的代码判断,如 React 的 Ref。

function Demo(): JSX.Elememt {
  const divRef = useRef<HTMLDivElement>();
  useEffect(() => {
    divRef.current!.scrollIntoView();	 // 当组件Mount后才会触发useEffect,故current一定是有值的
  }, []);
  return <div ref={divRef}>Demo</div>
}
复制代码

可选链运算符 ?.

相比上面!作用于编译阶段的非空判断,?.这个是开发者最需要的运行时(当然编译时也有效)的非空判断。

obj?.prop    obj?.[index]    func?.(args)
复制代码

?.用来判断左侧的表达式是否是 null | undefined,如果是则会停止表达式运行,可以减少我们大量的&&运算。

比如我们写出a?.b时,编译器会自动生成如下代码

a === null || a === void 0 ? void 0 : a.b;
复制代码

这里涉及到一个小知识点:undefined这个值在非严格模式下会被重新赋值,使用void 0必定返回真正的 undefined。

空值合并运算符 ??

??与||的功能是相似的,区别在于 ??在左侧表达式结果为 null 或者 undefined 时,才会返回右侧表达式

比如我们书写了let b = a ?? 10,生成的代码如下:

let b = a !== null && a !== void 0 ? a : 10;
复制代码

而 || 表达式,大家知道的,则对 false、''、NaN、0 等逻辑空值也会生效,不适于我们做对参数的合并。

数字分隔符_

let num:number = 1_2_345.6_78_9
复制代码

_可以用来对长数字做任意的分隔,主要设计是为了便于数字的阅读,编译出来的代码是没有下划线的,请放心食用。

三、操作符

键值获取 keyof

keyof 可以获取一个类型所有键值,返回一个联合类型,如下:

type Person = {
  name: string;
  age: number;
}
type PersonKey = keyof Person;  // PersonKey得到的类型为 'name' | 'age'
复制代码

keyof 的一个典型用途是限制访问对象的 key 合法化,因为 any 做索引是不被接受的。

function getValue (p: Person, k: keyof Person) {
  return p[k];  // 如果k不如此定义,则无法以p[k]的代码格式通过编译
}
复制代码

总结起来 keyof 的语法格式如下

类型 = keyof 类型
复制代码

实例类型获取 typeof

typeof 是获取一个对象/实例的类型,如下:

const me: Person = { name: 'gzx', age: 16 };
type P = typeof me;  // { name: string, age: number | undefined }
const you: typeof me = { name: 'mabaoguo', age: 69 }  // 可以通过编译
复制代码

typeof 只能用在具体的对象上,这与 js 中的 typeof 是一致的,并且它会根据左侧值自动决定应该执行哪种行为。

const typestr = typeof me;   // typestr的值为"object"
复制代码

typeof 可以和 keyof 一起使用(因为 typeof 是返回一个类型嘛),如下:

type PersonKey = keyof typeof me;   // 'name' | 'age'
复制代码

总结起来 typeof 的语法格式如下:

类型 = typeof 实例对象
复制代码

遍历属性 in

in 只能用在类型的定义中,可以对枚举类型进行遍历,如下:

// 这个类型可以将任何类型的键值转化成number类型
type TypeToNumber<T> = {
  [key in keyof T]: number
}
复制代码

keyof返回泛型 T 的所有键枚举类型,key是自定义的任何变量名,中间用in链接,外围用[]包裹起来(这个是固定搭配),冒号右侧number将所有的key定义为number类型。

于是可以这样使用了:

const obj: TypeToNumber<Person> = { name: 10, age: 10 }
复制代码

总结起来 in 的语法格式如下:

[ 自定义变量名 in 枚举类型 ]: 类型
复制代码

四、泛型

泛型在 TS 中可以说是一个非常重要的属性,它承载了从静态定义到动态调用的桥梁,同时也是 TS 对自己类型定义的元编程。泛型可以说是 TS 类型工具的精髓所在,也是整个 TS 最难学习的部分,这里专门分两章总结一下。

基本使用

泛型可以用在普通类型定义,类定义、函数定义上,如下:

// 普通类型定义
type Dog<T> = { name: string, type: T }
// 普通类型使用
const dog: Dog<number> = { name: 'ww', type: 20 }

// 类定义
class Cat<T> {
  private type: T;
  constructor(type: T) { this.type = type; }
}
// 类使用
const cat: Cat<number> = new Cat<number>(20); // 或简写 const cat = new Cat(20)

// 函数定义
function swipe<T, U>(value: [T, U]): [U, T] {
  return [value[1], value[0]];
}
// 函数使用
swipe<Cat<number>, Dog<number>>([cat, dog])  // 或简写 swipe([cat, dog])
复制代码

注意,如果对一个类型名定义了泛型,那么使用此类型名的时候一定要把泛型类型也写上去。

而对于变量来说,它的类型可以在调用时推断出来的话,就可以省略泛型书写。

泛型的语法格式简单总结如下:

类型名<泛型列表> 具体类型定义
复制代码

泛型推导与默认值

上面提到了,我们可以简化对泛型类型定义的书写,因为TS会自动根据变量定义时的类型推导出变量类型,这一般是发生在函数调用的场合的。

type Dog<T> = { name: string, type: T }

function adopt<T>(dog: Dog<T>) { return dog };

const dog = { name: 'ww', type: 'hsq' };  // 这里按照Dog类型的定义一个type为string的对象
adopt(dog);  // Pass: 函数会根据入参类型推断出type为string
复制代码

若不适用函数泛型推导,我们若需要定义变量类型则必须指定泛型类型。

const dog: Dog<string> = { name: 'ww', type: 'hsq' }  // 不可省略<string>这部分
复制代码

如果我们想不指定,可以使用泛型默认值的方案。

type Dog<T = any> = { name: string, type: T }
const dog: Dog = { name: 'ww', type: 'hsq' }
dog.type = 123;    // 不过这样type类型就是any了,无法自动推导出来,失去了泛型的意义
复制代码

泛型默认值的语法格式简单总结如下:

泛型名 = 默认类型
复制代码

泛型约束

有的时候,我们可以不用关注泛型具体的类型,如:

function fill<T>(length: number, value: T): T[] {
  return new Array(length).fill(value);
}
复制代码

这个函数接受一个长度参数和默认值,结果就是生成使用默认值填充好对应个数的数组。我们不用对传入的参数做判断,直接填充就行了,但是有时候,我们需要限定类型,这时候使用extends关键字即可。

function sum<T extends number>(value: T[]): number {
  let count = 0;
  value.forEach(v => count += v);
  return count;
}
复制代码

这样你就可以以sum([1,2,3])这种方式调用求和函数,而像sum(['1', '2'])这种是无法通过编译的。

泛型约束也可以用在多个泛型参数的情况。

function pick<T, U extends keyof T>(){};
复制代码

这里的意思是限制了 U 一定是 T 的 key 类型中的子集,这种用法常常出现在一些泛型工具库中。

extends 的语法格式简单总结如下,注意下面的类型既可以是一般意义上的类型也可以是泛型。

泛型名 extends 类型
复制代码

泛型条件

上面提到 extends,其实也可以当做一个三元运算符,如下:

T extends U? X: Y
复制代码

这里便不限制 T 一定要是 U 的子类型,如果是 U 子类型,则将 T 定义为 X 类型,否则定义为 Y 类型。

注意,生成的结果是分配式的

举个例子,如果我们把 X 换成 T,如此形式:T extends U? T: never

此时返回的 T,是满足原来的 T 中包含 U 的部分,可以理解为 T 和 U 的交集

所以,extends 的语法格式可以扩展为

泛型名A extends 类型B ? 类型C: 类型D
复制代码

泛型推断 infer

infer 的中文是“推断”的意思,一般是搭配上面的泛型条件语句使用的,所谓推断,就是你不用预先指定在泛型列表中,在运行时会自动判断,不过你得先预定义好整体的结构。举个例子

type Foo<T> = T extends {t: infer Test} ? Test: string
复制代码

首选看 extends 后面的内容,{t: infer Test}可以看成是一个包含t属性类型定义,这个t属性的 value 类型通过infer进行推断后会赋值给Test类型,如果泛型实际参数符合{t: infer Test}的定义那么返回的就是Test类型,否则默认给缺省的string类型。

举个例子加深下理解:

type One = Foo<number>  // string,因为number不是一个包含t的对象类型
type Two = Foo<{t: boolean}>  // boolean,因为泛型参数匹配上了,使用了infer对应的type
type Three = Foo<{a: number, t: () => void}> // () => void,泛型定义是参数的子集,同样适配
复制代码

infer用来对满足的泛型类型进行子类型的抽取,有很多高级的泛型工具也巧妙的使用了这个方法。

五、泛型工具

Partial<T>

此工具的作用就是将泛型中全部属性变为可选的。

type Partial<T> = {
	[P in keyof T]?: T[P]
}
复制代码

举个例子,这个类型定义在下面也会用到。

type Animal = {
  name: string,
  category: string,
  age: number,
  eat: () => number
}
复制代码

使用 Partial 包裹一下。

type PartOfAnimal = Partial<Animal>;
const ww: PartOfAnimal = { name: 'ww' }; // 属性全部可选后,可以只赋值部分属性了
复制代码

Record<K, T>

此工具的作用是将 K 中所有属性值转化为 T 类型,我们常用它来申明一个普通 object 对象。

type Record<K extends keyof any,T> = {
  [key in K]: T
}
复制代码

这里特别说明一下,keyof any对应的类型为number | string | symbol,也就是可以做对象键(专业说法叫索引 index)的类型集合。

举个例子:

const obj: Record<string, string> = { 'name': 'mbg', 'tag': '年轻人不讲武德' }
复制代码

Pick<T, K>

此工具的作用是将 T 类型中的 K 键列表提取出来,生成新的子键值对类型。

type Pick<T, K extends keyof T> = {
  [P in K]: T[P]
}
复制代码

我们还是用上面的Animal定义,看一下 Pick 如何使用。

const bird: Pick<Animal, "name" | "age"> = { name: 'bird', age: 1 }
复制代码

Exclude<T, U>

此工具是在 T 类型中,去除 T 类型和 U 类型的交集,返回剩余的部分。

type Exclude<T, U> = T extends U ? never : T
复制代码

注意这里的 extends 返回的 T 是原来的 T 中和 U 无交集的属性,而任何属性联合 never 都是自身,具体可在上文查阅。

举个例子

type T1 = Exclude<"a" | "b" | "c", "a" | "b">;   // "c"
type T2 = Exclude<string | number | (() => void), Function>; // string | number
复制代码

Omit<T, K>

此工具可认为是适用于键值对对象的 Exclude,它会去除类型 T 中包含 K 的键值对。

type Omit = Pick<T, Exclude<keyof T, K>>
复制代码

在定义中,第一步先从 T 的 key 中去掉与 K 重叠的 key,接着使用 Pick 把 T 类型和剩余的 key 组合起来即可。

还是用上面的 Animal 举个例子:

const OmitAnimal:Omit<Animal, 'name'|'age'> = { category: 'lion', eat: () => { console.log('eat') } }
复制代码

可以发现,Omit 与 Pick 得到的结果完全相反,一个是取非结果,一个取交结果。

ReturnType<T>

此工具就是获取 T 类型(函数)对应的返回值类型:

type ReturnType<T extends (...args: any) => any>
  = T extends (...args: any) => infer R ? R : any;
复制代码

看源码其实有点多,其实可以稍微简化成下面的样子:

type ReturnType<T extends func> = T extends () => infer R ? R: any;
复制代码

通过使用 infer 推断返回值类型,然后返回此类型,如果你彻底理解了 infer 的含义,那这段就很好理解。

举个例子:

function foo(x: string | number): string | number { /*..*/ }
type FooType = ReturnType<foo>;  // string | number
复制代码

Required<T>

此工具可以将类型 T 中所有的属性变为必选项。

type Required<T> = {
  [P in keyof T]-?: T[P]
}
复制代码

这里有一个很有意思的语法-?,你可以理解为就是 TS 中把?可选属性减去的意思。

除了这些以外,还有很多的内置的类型工具,可以参考TypeScript Handbook获得更详细的信息,同时 Github 上也有很多第三方类型辅助工具,如utility-types等。

六、项目实战

这里分享一些我个人的想法,可能也许会比较片面甚至错误,欢迎大家积极留言讨论

Q: 偏好使用 interface 还是 type 来定义类型?

A: 从用法上来说两者本质上没有区别,大家使用 React 项目做业务开发的话,主要就是用来定义 Props 以及接口数据类型。

但是从扩展的角度来说,type 比 interface 更方便拓展一些,假如有以下两个定义:

type Name = { name: string };
interface IName { name: string };
复制代码

想要做类型的扩展的话,type 只需要一个&,而 interface 要多写不少代码。

type Person = Name & { age: number };
interface IPerson extends IName { age: number };
复制代码

另外 type 有一些 interface 做不到的事情,比如使用|进行枚举类型的组合,使用typeof获取定义的类型等等。

不过 interface 有一个比较强大的地方就是可以重复定义添加属性,比如我们需要给window对象添加一个自定义的属性或者方法,那么我们直接基于其 Interface 新增属性就可以了。

declare global {
    interface Window { MyNamespace: any; }
}
复制代码

总体来说,大家知道 TS 是类型兼容而不是类型名称匹配的,所以一般不需用面向对象的场景或者不需要修改全局类型的场合,我一般都是用 type 来定义类型。

Q: 是否允许 any 类型的出现

A: 说实话,刚开始使用 TS 的时候还是挺喜欢用 any 的,毕竟大家都是从 JS 过渡过来的,对这种影响效率的代码开发方式并不能完全接受,因此不管是出于偷懒还是找不到合适定义的情况,使用 any 的情况都比较多。

随着使用时间的增加和对 TS 学习理解的加深,逐步离不开了 TS 带来的类型定义红利,不希望代码中出现 any,所有类型都必须要一个一个找到对应的定义,甚至已经丧失了裸写 JS 的勇气。

这是一个目前没有正确答案的问题,总是要在效率和时间等等因素中找一个最适合自己的平衡。不过我还是推荐使用 TS,随着前端工程化演进和地位的提高,强类型语言一定是多人协作和代码健壮最可靠的保障之一,多用 TS,少用 any,也是前端界的一个普遍共识。

Q: 类型定义文件(.d.ts)如何放置

A: 这个好像业界也没有特别统一的规范,我的想法如下:

  • 临时的类型,直接在使用时定义

如自己写了一个组件内部的 Helper,函数的入参和出参只供内部使用也不存在复用的可能,可以直接在定义函数的时候就在后面定义。

function format(input: {k: string}[]): number[] { /***/ }
复制代码
  • 组件个性化类型,直接定义在 ts(x)文件中

如 AntD 组件设计,每个单独组件的 Props、State 等专门定义了类型并 export 出去。

// Table.tsx
export type TableProps = { /***/ }
export type ColumnProps = { /***/ }
export default function Table() { /***/ }
复制代码

这样使用者如果需要这些类型可以通过 import type 的方式引入来使用。

  • 范围/全局数据,定义在.d.ts 文件中

全局类型数据,这个大家毫无异议,一般根目录下有个 typings 文件夹,里面会存放一些全局类型定义。

假如我们使用了 css module,那么我们需要让 TS 识别.less 文件(或者.scss)引入后是一个对象,可以如此定义:

declare module '*.less' {
  const resource: { [key: string]: string };
  export = resource;
}
复制代码

而对于一些全局的数据类型,如后端返回的通用的数据类型,我也习惯将其放在 typings 文件夹下,使用 Namespace 的方式来避免名字冲突,如此可以节省组件 import 类型定义的语句。

declare namespace EdgeApi {
  interface Department {
    description: string;
    gmt_create: string;
    gmt_modify: string;
    id: number;
    name: string;
  }
}
复制代码

这样,每次使用的时候,只需要const department: EdgeApi.Department即可,节省了不少导入的精力。开发者只要能约定规范,避免命名冲突即可。

关于 TS 用法的总结就介绍到这里,感谢大家的观看~


欢迎关注「 字节前端 ByteFE 」

简历投递联系邮箱「 tech@bytedance.com