【TypeScript】TS泛型

TypeScript泛型

泛型-基本介绍

• 泛型是可以在保证类型安全前提下，让函数等与多种类型一起工作，从而实现复用，常用于：函数、接口、class 中
• 需求：创建一个 id 函数，传入什么数据就返回该数据本身(也就是说，参数和返回值类型相同)

function id(value: number): number { return value }

• 比如，id(10) 调用以上函数就会直接返回 10 本身。但是，该函数只接收数值类型，无法用于其他类型
• 为了能让函数能够接受任意类型，可以将参数类型修改为 any。但是，这样就失去了 TS 的类型保护，类型不安全

function id(value: any): any { return value }

• 泛型在保证类型安全(不丢失类型信息)的同时，可以让函数等与多种不同的类型一起工作，灵活可复用
• 实际上，在 C# 和 Java 等编程语言中，泛型都是用来实现可复用组件功能的主要工具之一

泛型-泛型函数

定义泛型函数

function id<Type>(value: Type): Type { return value }

function id<T>(value: T): T { return value }

• 解释:
  1. 语法：在函数名称的后面添加 <>(尖括号)，尖括号中添加类型变量，比如此处的 Type
  2. 类型变量 Type，是一种特殊类型的变量，它处理类型而不是值
  3. 该类型变量相当于一个类型容器，能够捕获用户提供的类型(具体是什么类型由用户调用该函数时指定)
  4. 因为 Type 是类型，因此可以将其作为函数参数和返回值的类型，表示参数和返回值具有相同的类型
  5. 类型变量 Type，可以是任意合法的变量名称

调用泛型函数

const num = id<number>(10)
const str = id<string>('a')

• 解释：

  1. 语法：在函数名称的后面添加 <>(尖括号)，尖括号中指定具体的类型，比如，此处的 number
  2. 当传入类型 number 后，这个类型就会被函数声明时指定的类型变量 Type 捕获到
  3. 此时，Type 的类型就是 number，所以，函数 id 参数和返回值的类型也都是 number

• 同样，如果传入类型 string，函数 id 参数和返回值的类型就都是 string

• 这样，通过泛型就做到了让 id 函数与多种不同的类型一起工作，实现了复用的同时保证了类型安全

简化泛型函数调用

// 省略 <number> 调用函数
let num = id(10)
let str = id('a')

• 解释:

  1. 在调用泛型函数时，可以省略 <类型> 来简化泛型函数的调用
  2. 此时，TS 内部会采用一种叫做类型参数推断的机制，来根据传入的实参自动推断出类型变量 Type 的类型
  3. 比如，传入实参 10，TS 会自动推断出变量 num 的类型 number，并作为 Type 的类型

• 推荐：使用这种简化的方式调用泛型函数，使代码更短，更易于阅读

• 说明：当编译器无法推断类型或者推断的类型不准确时，就需要显式地传入类型参数

泛型约束

• 默认情况下，泛型函数的类型变量 Type 可以代表多个类型，这导致无法访问任何属性
• 比如，id(‘a’) 调用函数时获取参数的长度：

function id<Type>(value: Type): Type {
  console.log(value.length)
  return value
}

id('a')

• 解释：Type 可以代表任意类型，无法保证一定存在 length 属性，比如 number 类型就没有 length
• 此时，就需要为泛型添加约束来收缩类型(缩窄类型取值范围)
• 添加泛型约束收缩类型，主要有以下两种方式：1 指定更加具体的类型 2 添加约束

指定更加具体的类型

比如，将类型修改为 Type[](Type 类型的数组)，因为只要是数组就一定存在 length 属性，因此就可以访问了

function id<Type>(value: Type[]): Type[] {
  console.log(value.length)
  return value
}

添加约束

// 创建一个接口
interface ILength { length: number }

// Type extends ILength 添加泛型约束
// 解释：表示传入的 类型 必须满足 ILength 接口的要求才行，也就是得有一个 number 类型的 length 属性
function id<Type extends ILength>(value: Type): Type {
  console.log(value.length)
  return value
}

• 解释:
  1. 创建描述约束的接口 ILength，该接口要求提供 length 属性
  2. 通过 extends 关键字使用该接口，为泛型(类型变量)添加约束
  3. 该约束表示：传入的类型必须具有 length 属性
• 注意:传入的实参(比如，数组)只要有 length 属性即可（类型兼容性)

多个类型变量

泛型的类型变量可以有多个，并且类型变量之间还可以约束(比如，第二个类型变量受第一个类型变量约束)
比如，创建一个函数来获取对象中属性的值：

function getProp<Type, Key extends keyof Type>(obj: Type, key: Key) {
  return obj[key]
}
let person = { name: 'jack', age: 18 }
getProp(person, 'name')

• 解释:
  1. 添加了第二个类型变量 Key，两个类型变量之间使用 , 逗号分隔。
  2. keyof 关键字接收一个对象类型，生成其键名称(可能是字符串或数字)的联合类型。
  3. 本示例中 keyof Type 实际上获取的是 person 对象所有键的联合类型，也就是：'name' | 'age'
  4. 类型变量 Key 受 Type 约束，可以理解为：Key 只能是 Type 所有键中的任意一个，或者说只能访问对象中存在的属性

// Type extends object 表示： Type 应该是一个对象类型，如果不是 对象 类型，就会报错
// 如果要用到 对象 类型，应该用 object ，而不是 Object
function getProperty<Type extends object, Key extends keyof Type>(obj: Type, key: Key) {
  return obj[key]
}

---

泛型接口

泛型接口：接口也可以配合泛型来使用，以增加其灵活性，增强其复用性

interface IdFunc<Type> {
  id: (value: Type) => Type
  ids: () => Type[]
}

let obj: IdFunc<number> = {
  id(value) { return value },
  ids() { return [1, 3, 5] }
}

• 解释:
  1. 在接口名称的后面添加 <类型变量>，那么，这个接口就变成了泛型接口。
  2. 接口的类型变量，对接口中所有其他成员可见，也就是接口中所有成员都可以使用类型变量。
  3. 使用泛型接口时，需要显式指定具体的类型(比如，此处的 IdFunc)。
  4. 此时，id 方法的参数和返回值类型都是 number;ids 方法的返回值类型是 number[]。

JS 中的泛型接口

实际上，JS 中的数组在 TS 中就是一个泛型接口。

const strs = ['a', 'b', 'c']
// 鼠标放在 forEach 上查看类型
strs.forEach

const nums = [1, 3, 5]
// 鼠标放在 forEach 上查看类型
nums.forEach

• 解释:当我们在使用数组时，TS 会根据数组的不同类型，来自动将类型变量设置为相应的类型
• 技巧:可以通过 Ctrl + 鼠标左键(Mac：Command + 鼠标左键)来查看具体的类型信息