我为什么喜欢NestJS

Dickensl

发布于 2022-06-14 13:49:54

1.9K0

发布于 2022-06-14 13:49:54

文章被收录于专栏：睿Talks睿Talks

一、前言

做过 Java EE 开发的朋友对 Spring 框架应该很熟悉了，它全面的功能和优秀的设计是得以广泛流行的原因。它通过灵活使用控制反转、依赖注入和面向切面编程等设计理念，极大的规范了大型应用的架构，降低了模块之间的耦合度，从而提升了应用的开发效率。在 NodeJS 的世界里，也存在一个全面借鉴 Spring 设计思想的框架，它在 github 上有将近 2w 的 star，npm 的周下载量超过 11w，它就是本文要介绍的 NestJS。

二、与其它框架的对比

市面上 NodeJS 的服务端框架有很多，如Koa、Express、EggJS、Midway等，它们功能都很强大，也有很好的生态，插件非常丰富，为什么还需要Nest呢？

如果是一个简单的应用，其实用什么框架都无所谓，一个框架用 100 行代码实现，另一个用 80 行，区别不大。但涉及到企业级的应用，分分钟有上万行的代码，代码的组织结构就变得很重要了。如果代码拆分不合理，一个 JS 文件就有上千行的代码，后期的维护成本会非常的高。再考虑到复杂项目参与者众多，没有一个规范去约束的话，每个人写出来的代码风格迥异，协作起来会很难受。上文提到的几个框架对项目代码的架构要么是没约束，要么就是约束比较弱或者看起来很别扭。相比之下Nest的实现就很简洁，用起来很顺手。具体细节将在下文进行描述。

Nest还通过依赖注入的形式实现了控制反转，只要声明模块中的依赖，Nest就会在启动的时候去创建依赖，然后自动注入到相应的地方。依赖注入最大的作用是代码解耦，依赖的对象根据不同的情况可以有多种实现，如单元测试的时候可以在不改业务代码的情况下将依赖的对象换成 Mock 数据。

Nest还践行了面向切面编程的思想，除了Middleware外，还有Exception Filter、Pipes、Guards和Interceptors几个预定义的切面，可以集中进行异常处理、数据验证、权限验证和逻辑扩展等功能。Nest自带如数据验证等一些常用的基于切面的功能，也可以通过继承的方式来进行扩展。这些预定义的切面是代码架构的组成部分，按照这些约定来组织代码会大大降低日后的维护成本。

类型系统是后端开发很重要的一环，Nest是使用TypeScript实现的框架，因此原生就支持TypeScript，而且还大量使用了注解，熟悉 Spring 的朋友会感到十分亲切。

另外，Nest是基于Express实现的，需要的话可以取到底层的对象，如request和response。

三、实战

下面的讲解将会基于一个简单的增删改查 API 服务器，完整项目代码在这里，在此就不一步步去介绍编写过程了。

模块化

Nest是以模块的形式组织项目的，模块中可以声明Controller、Provider、Import和Export。打开app.module.ts，内容如下：

@Module({
  imports: [CatsModule, MongooseModule.forRoot('mongodb://localhost/nest')],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

可以看到项目的根模块AppModule导入了项目中的另一个模块CatsModule和外部依赖MongooseModule。另外也声明了模块内部的Controller和Provider。我们一般说的Service是Provider的一种。Module、Controller和Provider的关系见下图：

Controller和Provider都在Module注册，容器会将Provider注入到Controller中，Module之间可以相互引用（Import）。像 ES6 的模块化一样，Import后只能使用别人Export出来的内容。

注解

再来看一下cats.controller.ts。

@Controller('cats')
export class CatsController {
  constructor(private readonly catsService: CatsService) {}

  @Get(':name')
  async findOne(@Param('name') name: string): Promise<Cat> {
    return this.catsService.findOne(name);
  }

  @Get()
  async findAll(): Promise<Cat[]> {
    return this.catsService.findAll();
  }

  @Post()
  @HttpCode(201)
  @Header('Cache-Control', 'none')
  async create(
    @Body(new ValidationPipe()) createCatDto: CreateCatDto,
  ): Promise<Cat[]> {
    return this.catsService.create(createCatDto);
  }
}

这文件有大量的注解，这是Nest有别于其它 NodeJS 框架的地方，像极了 Spring。很多注解的含义也与 Spring 的一致，像这里的@Controller、@Get和@Post都是用来声明路由和 http 请求类型的。@Get(':name')是获取 url 的参数，而@Param('name')是获取请求体的参数。@Body(new ValidationPipe()) createCatDto: CreateCatDto这行代码做了很多事，首先将请求体取出，然后校验数据类型是否合规，然后再将请求体转换为 DTO 对象供后续使用。DTO 的定义如下，也是通过注解定义校验逻辑：

export class CreateCatDto {
  @IsString()
  readonly name: string;
  @IsNumber()
  readonly age: number;
  @IsString()
  readonly breed: string;
}

切面

上面提到的ValidationPipe是内置的Pipe切面，用于校验参数类型。另外几种切面和请求处理的顺序见下图：

这里的Middleware就是Express原生的，其它几个切面的用法见官方文档，在此不多作介绍。

连接数据库

例子中使用mongoose连接和操作本地MongoDB数据库。为了更方便使用，Nest提供了@nestjs/mongoose包，对mongoose包装了一层，使其更符合Nest的使用风格。操作数据库的步骤如下：

app.module中定义连接的数据库：MongooseModule.forRoot('mongodb://localhost/nest')
cat.schema中定义 Schema
cats.module中声明依赖 Model：MongooseModule.forFeature([{ name: 'Cat', schema: CatSchema }])
cats.service中注入依赖 Model：constructor(@InjectModel('Cat') private readonly catModel: Model<Cat>) {}
cats.service中使用 Model：this.catModel.findOne({ name }).exec()