请求进来 --- 中间件 --- 守卫 --- 拦截器 --- 通道 --- 处理(controller层) --- 拦截器 --- 返回
Pipe : 就是实现 PipeTransform 接口的 transform 方法,它的返回值就是传给 handler 的值。
-------------------------------------------
Nest框架内部是如何做到把TypeScript的类型定义变成功能实现?
Nest框架是一个基于Node.js的框架,它使用了TypeScript来提供强类型支持,并将类型定义与代码编译紧密结合。
TypeScript是一种静态类型检查的编程语言,它通过类型注解来在编译阶段检查代码的正确性。在Nest框架中,类型定义不仅仅是用来作为类型约束,还可以通过装饰器等方式对代码进行元编程,从而实现一些功能。
Nest框架使用了装饰器来定义控制器、提供者、中间件等组件,这些装饰器使用了TypeScript的类型系统来进行静态类型检查。在编译过程中,这些装饰器会被解析,并根据类型定义生成对应的代码。这意味着类型定义可以影响最终编译后的代码。
掘金小册
具体实现原理可以看这个章节。
-------------------------
下面简单对章节进行总结:
不知道大家有没有感觉很神奇,只是通过装饰器声明了一下,然后启动 Nest 应用,这时候对象就给创建好了,依赖也给注入了。
那它是怎么实现的呢?
Nest 的实现原理就是通过装饰器给 class 或者对象添加元数据,然后初始化的时候取出这些元数据,进行依赖的分析,然后创建对应的实例对象就可以了。
所以说,nest 实现的核心就是 Reflect metadata 的 api。
关于TypeScript部分,为什么跟Nest框架结合可以实现代码的功能改变,既元编程。
其实还有一个疑问,依赖的扫描可以通过 metadata 数据,但是创建的对象需要知道构造器的参数,现在并没有添加这部分 metadata 数据呀:
这就不得不提到 TypeScript 的优势了,TypeScript 支持编译时自动添加一些 metadata 数据:
import "reflect-metadata";
class Guang {
@Reflect.metadata("名字", "光光")
public say(a: number): string {
return '加油鸭';
}
}
按理说我们只添加了一个元数据,生成的代码也确实是这样的:
但是呢,ts 有一个编译选项叫做 emitDecoratorMetadata,开启它就会自动添加一些元数据。
开启之后再试一下:
所以说,只要开启了这个编译选项,ts 生成的代码会自动添加一些元数据。
然后创建对象的时候就可以通过 design:paramtypes 来拿到构造器参数的类型了,那不就知道怎么注入依赖了么?
所以,nest 源码里你会看到这样的代码:
这也是为什么 nest 会用 ts 来写,因为它很依赖这个 emitDecoratorMetadata 的编译选项。
你用 cli 生成的代码模版里也都默认开启了这个编译选项:
-----
这就是 nest 的核心实现原理:通过装饰器给 class 或者对象添加 metadata,并且开启 ts 的 emitDecoratorMetadata 来自动添加类型相关的 metadata,然后运行的时候通过这些元数据来实现依赖的扫描,对象的创建等等功能。
Nest 的装饰器都是依赖 reflect-metadata 实现的,而且还提供了一个 @SetMetadata 的装饰器让我们可以给 class、method 添加一些 metadata
---
Nest 的装饰器的实现原理就是 Reflect.getMetadata、Reflect.defineMetadata 这些 api。通过在 class、method 上添加 metadata,然后扫描到它的时候取出 metadata 来做相应的处理来完成各种功能。
Nest 的 Controller、Module、Service 等等所有的装饰器都是通过 Reflect.meatdata 给类或对象添加元数据的,然后初始化的时候取出来做依赖的扫描,实例化后放到 IOC 容器里。
实例化对象还需要构造器参数的类型,这个开启 ts 的 emitDecoratorMetadata 的编译选项之后, ts 就会自动添加一些元数据,也就是 design:type、design:paramtypes、design:returntype 这三个,分别代表被装饰的目标的类型、参数的类型、返回值的类型。
当然,reflect metadata 的 api 还在草案阶段,需要引入 reflect metadata 的包做 polyfill。
Nest 还提供了 @SetMetadata 的装饰器,可以在 controller 的 class 和 method 上添加 metadata,然后在 interceptor 和 guard 里通过 reflector 的 api 取出来。
理解了 metadata,nest 的实现原理就很容易搞懂了。