TypeScript 介绍
- TypeScript 是 JavaScript 的超集,提供了 JavaScript 的所有功能,并提供了可选的静态类型、Mixin、类、接口和泛型等特性。
- TypeScript 的目标是通过其类型系统帮助及早发现错误并提高 JavaScript 开发效率。
- 通过 TypeScript 编译器或 Babel 转码器转译为 JavaScript 代码,可运行在任何浏览器,任何操作系统。
- 任何现有的 JavaScript 程序都可以运行在 TypeScript 环境中,并只对其中的 TypeScript 代码进行编译。
- 在完整保留 JavaScript 运行时行为的基础上,通过引入静态类型定义来提高代码的可维护性,减少可能出现的 bug。
- 永远不会改变 JavaScript 代码的运行时行为,例如数字除以零等于 Infinity。这意味着,如果将代码从 JavaScript 迁移到 TypeScript ,即使 TypeScript 认为代码有类型错误,也可以保证以相同的方式运行。
- 对 JavaScript 类型进行了扩展,增加了例如
any
、unknown
、never
、void
。 - 一旦 TypeScript 的编译器完成了检查代码的工作,它就会 擦除 类型以生成最终的“已编译”代码。这意味着一旦代码被编译,生成的普通 JS 代码便没有类型信息。这也意味着 TypeScript 绝不会根据它推断的类型更改程序的 行为。最重要的是,尽管可能会在编译过程中看到类型错误,但类型系统自身与程序如何运行无关。
- 在较大型的项目中,可以在单独的文件 tsconfig.json 中声明 TypeScript 编译器的配置,并细化地调整其工作方式、严格程度、以及将编译后的文件存储在何处。
工具类型
TypeScript 提供了多种工具类型(实用类型)来帮助常见的类型转换,这些工具类型在全局范围内可用。
Awaited
Awaited<Type>
模拟异步函数中的 await
或 Promises
上的 .then()
方法返回值类型。
1 | type A = Awaited<Promise<string>>; |
ConstructorParameters
ConstructorParameters<Type>
从构造函数的类型生成一个包含所有参数类型的元组类型(如果 Type
不是函数,则生成 never
类型)。
1 | type T0 = ConstructorParameters<ErrorConstructor>; |
Exclude
Exclude<UnionType, ExcludedMembers>
从联合类型中删除指定类型。
1 | type T0 = Exclude<"a" | "b" | "c", "a">; |
Extract
Extract<Type, Union>
通过从 Type
中提取可分配给 Union
的所有联合成员来构造一个类型。
1 | type T0 = Extract<"a" | "b" | "c", "a" | "f">; |
InstanceType
InstanceType<Type>
构造一个由 Type
中构造函数的实例类型组成的类型。
1 | class C { |
NonNullable
NonNullable<Type>
通过从 Type
中排除 null
和 undefined
来构造一个类型。
1 | type T0 = NonNullable<string | number | undefined>; |
Omit
Omit<Type, Keys>
从对象类型中删除 keys(字符串文字或字符串文字的并集)来构造一个类型。
1 | interface Person { |
OmitThisParameter
OmitThisParameter<Type>
从类型中删除 this
参数,创建一个没有 this
参数的新函数类型,泛型会被擦除,只有最后一个重载签名可以被传播到新的函数类型中。如果 Type
没有显式声明 this
参数,则结果只是 Type
。
1 | function toHex(this: Number) { |
Parameters
Parameters<Type>
根据函数类型 Type
的参数中使用的类型构造元组类型。
1 | declare function f1(arg: { a: number; b: string }): void; |
Partial
Partial<Type>
更改对象中的所有属性为可选。
1 | interface Point { |
Pick
Pick<Type, Keys>
从对象类型中选择指定 keys(字符串文字或字符串文字的并集)来构造一个类型。
1 | interface Person { |
Readonly
Readonly<Type>
构造一个所有属性都设置为 readonly
的类型。
1 | interface Todo { |
Record
Record
是定义具有特定键类型和值类型的对象类型的简写方式,用于将一种类型的属性映射到另一种类型。Record<Keys, Type>
将构造一个新的对象类型,其属性键为 Keys
,属性值为 Type
。
1 | const nameAgeMap: Record<string, number> = { |
这里的 Record<string, number>
相当于 { [key: string]: number }
。
Required
Required<Type>
更改对象中的所有属性为必须的。
1 | interface Car { |
ReturnType
ReturnType<Type>
提取函数类型的返回类型。
1 | declare function f1(): { a: number; b: string }; |
ThisParameterType
ThisParameterType<Type>
提取函数类型的 this
参数的类型,如果函数类型没有 this
参数,则为 unknown
。
1 | function toHex(this: Number) { |
ThisType
ThisType<Type>
用作上下文 this
类型的标记,但不返回转换后的类型,必须启用 noImplicitThis
标志才能使用。该接口只是一个在 lib.d.ts
中声明的空接口,除了在对象字面量的上下文类型中被识别之外,该接口的行为类似于任何空接口。
1 | type ObjectDescriptor<D, M> = { |
内部字符串操作类型
为了帮助进行字符串操作,TypeScript 包含一组可用于字符串操作的类型。这些类型内置于编译器中以提高性能,并且无法在 TypeScript 附带的 .d.ts 文件中找到。
Uppercase
Uppercase<StringType>
将字符串中的每个字符转换为大写版本。
1 | type Greeting = "Hello, world" |
Lowercase
Lowercase<StringType>
将字符串中的每个字符转换为等效的小写字母。
1 | type Greeting = "Hello, world" |
Capitalize
Capitalize<StringType>
将字符串中的第一个字符转换为等效的大写字母。
1 | type LowercaseGreeting = "hello, world"; |
Uncapitalize
Uncapitalize<StringType>
将字符串中的第一个字符转换为等效的小写字母。
1 | type UppercaseGreeting = "HELLO WORLD"; |
装饰器
- 自从 ES2015 引入
class
,当我们需要在多个不同的类之间共享或者扩展一些方法或行为的时候,代码会变得错综复杂。 - 装饰器是一种特殊类型的声明,它能够附加到类声明、方法、访问符、属性、类方法的参数上,以达到扩展类的行为。
- 装饰器使用
@expression
形式,expression
表达式求值后必须为一个函数,它会在运行时被调用,它接收三个参数target
、name
和descriptor
,然后可选性的返回被装饰之后的descriptor
对象。
装饰器工厂
装饰器工厂只是一个函数,它返回装饰器将在运行时调用的表达式。通过装饰器工厂方法,可以额外传参,普通装饰器无法传参。
1 | function log(param: string) { |
装饰器组合
多个装饰器可以同时应用到一个声明上,它们可以书写在同一行上:
1 | x |
也可以书写在多行上:
1 |
|
当多个装饰器应用在一个声明上时会进行如下步骤的操作:
- 由上至下依次对装饰器表达式求值。
- 求值的结果会被当作函数,由下至上依次调用。这会将以下输出打印到控制台:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17function first() {
console.log("first(): factory evaluated");
return function(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
console.log("first(): called");
};
}
function second() {
console.log("second(): factory evaluated");
return function(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
console.log("second(): called");
};
}
class ExampleClass {
()
()
method() { }
}1
2
3
4first(): factory evaluated
second(): factory evaluated
second(): called
first(): called
类装饰器
通过类装饰器扩展类的属性和方法,类装饰器表达式会在运行时当作函数被调用,装饰类的构造函数作为其唯一的参数。
如果类装饰器返回一个值,它将用提供的构造函数替换类声明。如果你选择返回一个新的构造函数,则必须注意维护原始
prototype
,在运行时应用装饰器的逻辑不会为你做这件事。
下面一个示例,说明了如何覆盖构造函数以设置新的默认值。
1 | function reportableClassDecorator<T extends { new (...args: any[]): {} }>(constructor: T) { |
方法装饰器
方法装饰器的表达式会在运行时当作函数被调用,不能用于声明文件、重载或任何其他环境上下文(例如在 declare
类中)。具有以下三个参数:
target
: 对于静态成员来说是类的构造函数,对于实例成员是类的原型对象。name
: 成员的名字。descriptor
: 成员的属性描述符。
如果你熟悉 Object.defineProperty
,你会立刻发现这正是 Object.defineProperty
的三个参数。比如通过装饰器完成一个方法只读功能,其实就是修改数据描述符中的 writable
的值 :
1 | function readonly(value: boolean = true) { |
访问器装饰器
访问器装饰器应用于访问器的属性描述符,可用于观察、修改或替换访问器的定义。访问器装饰器不能在声明文件或任何其他环境上下文(例如在 declare
类中)中使用,不允许同时装饰单个成员的 get
和 set
访问器。访问器装饰器的表达式将在运行时作为函数调用,参数与方法装饰器相同。
1 | function configurable(value: boolean) { |
属性装饰器
属性装饰器的表达式将在运行时作为函数调用,参数与方法装饰器相同,但它的第三个参数为 undefined
,因为此刻的属性还没有初始化,所以没有配置项。属性装饰器不能在声明文件或任何其他环境上下文(例如在 declare
类中)中使用。
例如我们可以使用属性装饰器来记录有关属性的元数据:
1 | import "reflect-metadata"; |
我们使用函数声明定义了 @format
装饰器和 getFormat
函数,这里的 @format("Hello, %s")
装饰器是一个装饰器工厂。当调用 @format("Hello, %s")
时,它使用 reflect-metadata
库中的 Reflect.metadata
函数为属性添加元数据条目。当调用 getFormat
时,它会读取元数据值。
参数装饰器
参数装饰器应用于类构造函数或方法声明的函数,只能用于观察参数是否已在方法上声明。参数装饰器不能在声明文件、重载或任何其他环境上下文(例如在 declare
类中)中使用。
参数装饰器的表达式将在运行时作为函数调用,具有以下三个参数:
- 静态成员的类的构造函数,或实例成员的类的原型。
- 成员的名称。
- 参数在函数参数列表中的序号索引。
下面示例,@required
装饰器添加一个元数据条目,将参数标记为必需。然后 @validate
装饰器将现有的 greet
方法包装在一个函数中,该函数在调用原始方法之前验证参数。
1 | import "reflect-metadata"; |
元数据
TypeScript 包括对为具有装饰器的声明发出某些类型的元数据的实验性支持。要启用此实验性支持,您必须在命令行或 tsconfig.json 中设置 emitDecoratorMetadata
编译器选项:
1 | tsc --target ES5 --experimentalDecorators --emitDecoratorMetadata |
1 | { |
emitDecoratorMetadata
标志启用对与模块 reflect-metadata
一起使用的装饰器的发射类型元数据的实验性支持。启用后,只要导入了 reflect-metadata
库,就会在运行时公开额外的设计时类型信息。
1 | // @emitDecoratorMetadata |
装饰器执行顺序
对于如何应用应用于类内部各种声明的装饰器,有一个明确定义的顺序:
- 对每个实例成员应用属性装饰器、访问器、参数装饰器、方法。
- 对每个静态成员应用属性装饰器、访问器、参数装饰器、方法。
- 构造方法参数装饰器。
- 类装饰器。打印顺序为:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36function extension(params: string) {
return function(target: any) {
console.log(params);
}
}
function method(params: string) {
return function(target: any, name: string, descriptor: PropertyDescriptor) {
console.log(params);
}
}
function attribute(params: string) {
return function(target: any, name: string) {
console.log(params);
}
}
function argument(params: string) {
return function(target: any, name: string, index: number) {
console.log(params, index);
}
}
'类装饰器') (
class Employee {
constructor('构造方法参数装饰器') n: string) { (
this.name = n;
}
'静态属性装饰器') (
static id: number;
'属性装饰器') (
name!: string;
'set 方法装饰器') (
set age('set 方法参数装饰器') n: number){} (
'静态方法装饰器') (
static work('静态方法参数装饰器') name: string, ('静态方法参数装饰器') department: string) {} (
'方法装饰器') (
salary('参数装饰器') name: string, ('参数装饰器') department: string) {} (
}1
2
3
4
5
6
7
8
9
10
11
12属性装饰器
set 方法参数装饰器 0
set 方法装饰器
参数装饰器 1
参数装饰器 0
方法装饰器
静态属性装饰器
静态方法参数装饰器 1
静态方法参数装饰器 0
静态方法装饰器
构造方法参数装饰器 0
类装饰器
混入(Mixins)
- 在 TypeScript 中,
implements
只会继承属性的类型,而不会继承实际的逻辑,所以需要根据不同的功能定义多个可复用的类,将它们作为mixins
。 - 因为
extends
只支持继承一个父类,我们可以通过implements
来连接多个mixins
,并且使用原型链将父类的方法实现复制到子类。 - 这就像组件拼合一样,由一堆细粒度的
mixins
快速搭建起一个功能强大的类。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43// @strict: false
// Each mixin is a traditional ES class
class Jumpable {
jump(this) {
this.x++;
}
}
class Duckable {
duck(this) {
this.y--;
}
}
// 在基类上实现期望的 mixins
// class Sprite implements Jumpable, Duckable {
// x = 0;
// y = 0;
// jump: () => void;
// duck: () => void;
// }
// 或创建一个与基类同名的接口,合并期望的 mixins
class Sprite {
x = 0;
y = 0;
}
interface Sprite extends Jumpable, Duckable {}
// 第一个参数是要混合的主体,第二个参数是要混入的构造函数数组,主要逻辑就是把原型链上面的方法拷贝到要混合的主体上面
function applyMixins(derivedCtor: any, constructors: any[]) {
constructors.forEach((baseCtor) => {
Object.getOwnPropertyNames(baseCtor.prototype).forEach((name) => {
Object.defineProperty(
derivedCtor.prototype,
name,
Object.getOwnPropertyDescriptor(baseCtor.prototype, name) || Object.create(null)
);
});
});
}
// 在运行时通过 JS 将 mixins 应用到基类中
applyMixins(Sprite, [Jumpable, Duckable]);
let player = new Sprite();
player.jump();
player.duck();
console.log(player.x, player.y); // 1, -1 - 没有使用
extends
而是使用了implements
,把类当成了接口,仅使用它们的类型而非其实现。我们也没有在类里面实现接口,因为这是我们在用 mixin 时想避免的。 - 为将要 mixin 进来的属性方法创建出占位属性,这告诉编译器这些成员在运行时是可用的,这样就能使用 mixin 带来的便利,虽说需要提前定义一些占位属性。
- 最后,创建了一个帮助函数,帮我们做混入操作。它会遍历 mixins 上的所有属性,并复制到目标上去,把之前的占位属性替换成真正的实现代码。