栈记
Nest

快速起步

Nest CLI、项目结构与启动流程

说明

一个高效的 Nodejs 服务框架结合面相对象 OOP 的设计模式;底层基于 Express(默认) 或者 Fastify。

@nestjs/cli

npm i -g @nestjs/cli

# 查看帮助信息
nest --help

# 可以通过 参数 后 --help 查看某个命令的帮助信息
nest generate --help

创建项目

nest new project-name

目前生成项目仅支持选择包管理工具、值得注意的是项目的格式化是通过 prettier 来实现的,并且在 eslint 中也集成了相关的规则。

.
├── eslint.config.mjs
├── nest-cli.json  脚手架的配置文件,可以配置一些关于 generate 的选项
├── node_modules
├── package.json
├── pnpm-lock.yaml
├── README.md
├── src
│   ├── app.controller.spec.ts 测试文件
│   ├── app.controller.ts 控制器文件
│   ├── app.module.ts 模块文件
│   ├── app.service.ts 服务文件
│   └── main.ts  入口文件
├── test
│   ├── app.e2e-spec.ts
│   └── jest-e2e.json
├── tsconfig.build.json
└── tsconfig.json

新增模块

# 添加一个新的 名为 users 的 curd 模块不生成测试文件在 src/featture 中
nest generate resource feature/users --no-spec

# 如果不想每次都输出 --no-spec 可以在 nest-cli.json 中进行配置
{
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "generateOptions": {
    "spec": false
  }
}

执行上述指令后会生成一个新的 curd 模块,期间会让你选择是否使用 RESTAPI 风格等;除此之外还以只创建一些核心内容; 都会默认在 src 下创建一个新的文件夹。

比如 pip、filter、guard 等都可以通过 --help 查看相关的指令;

模块的完整接口如下

├── dto
│   ├── create-user.dto.ts
│   └── update-user.dto.ts
├── entities
│   └── user.entity.ts
├── users.controller.ts
├── users.module.ts
└── users.service.ts

模块概述

在标准的开发流程中,会涉及到一些核心的概念:

  • dto 全名 Data Transfer Object,数据传输对象,就是客户端往服务端传递的数据对象;

  • entity 数据的实体对象,通常会和数据库中的表结构一一对应;也成为数据映射对象;

  • vo 全名 View Object,视图对象,服务端返回给客户端的数据对象;

  • controller 控制器,负责处理客户端的请求,接收参数,并决定调用哪个 service 来处理业务逻辑;并最终返回结果给客户端;

  • service 服务,负责处理具体的业务逻辑;通常会调用 repository 来操作数据库;

  • module 模块,将相关的 controller 和 service 组织在一起形成一个独立的功能模块;

  • di 依赖注入,全名 Dependency Injection,是一种设计模式,通过将依赖关系注入到对象中来实现解耦;在 nestjs 中通过构造函数注入的方式来实现依赖注入;

初始化项目 - app.controller.ts

import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }
}

在 constructor 中注入 AppService,随后在对应的路由方法中调用对应的逻辑;

初始化项目 - app.service.ts

import { Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  getHello(): string {
    return 'Hello World!';
  }
}

通过 Injectable 装饰器将 AppService 标记为一个可注入的服务;也可以称之为提供者

初始化项目 - app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';

@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

在 module 中有四个比较重要的属性:

  • providers 提供者,接收注入的服务集合;

  • controllers 控制器,当前模块的控制器集合;

  • imports 导入,当前模块依赖的其他模块;

  • exports 导出,当前模块需要被其他模块使用的提供者(service);

换句话说,providers 中基本存放的都是 service,(暂时这么理解)

imports 中导入的则是你需要使用的其他模块;而 exports 则是你需要被其他模块使用的服务;比如购物车模块需要用户的信息,代码可能就是下面这种;

// cart.module.ts
import { Module } from '@nestjs/common';
import { CartService } from './cart.service';
import { UserModule } from '../user/user.module';

@Module({
  imports: [UserModule], // 导入 UserModule 模块
  providers: [CartService],
})
export class CartModule {}

// user.module.ts
import { Module } from '@nestjs/common';
import { UserService } from './user.service';

@Module({
  providers: [UserService],
  exports: [UserService], // 导出 UserService 服务
})
export class UserModule {}

初始化项目 - main.ts

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(process.env.PORT ?? 3000);
}
void bootstrap();

将 AppModule 作为根模块创建服务器实例,并监听对应的端口;

On this page