3. 第 2 章 - [NestJS] 简介
3.1. 来源
本章参考了以下来源:
- 官方 [NestJS] 网站:nestjs.com及其文档 docs.nestjs.com;
- 该框架的 GitHub 仓库:github.com/nestjs/nest。
3.2. [NestJS] 在 Web 应用程序中的作用
[NestJS] 是一个用 TypeScript 编写的 Node.js 框架,用于构建 Web 应用程序的服务器端——最常见的是 REST API(JSON)。它并不重新发明 HTTP 协议的处理:默认情况下,它依赖 Express,这是一个较为简朴的 Node.js 框架,负责接收原始 HTTP 请求并作出响应。[NestJS] 建立在其之上,提供了 Node.js 和 Express 自身都不强加的代码组织方式:划分为模块、控制器和服务;依赖注入;装饰器……
它的架构深受 [Angular] 启发(装饰器、模块、依赖注入)——这种相似性会在第 4 章对我们大有帮助,届时我们将在客户端遇到完全相同的概念。
[NestJS] 主要用于生成 JSON 响应:默认情况下,控制器方法返回的任何内容都会被自动转换为 JSON 并发送给客户端,无需任何特殊配置。
3.3. [NestJS] 开发模型
三个概念构成了 [NestJS] 应用程序的结构:
- 模块 (@[Module] 装饰器):模块把一组相互关联的功能组织在一起——它声明自己包含哪些控制器和服务、需要哪些其他模块,以及向其他模块提供什么。[NestJS] 应用程序总是从一个根模块开始,即 [AppModule],它汇集项目中的所有其他模块;
- 控制器 (@[Controller] 装饰器):控制器是应用程序的入口点——这是一个类,其中每个方法接收与特定 URL 对应的 HTTP 请求,并向客户端返回响应;
- 提供者 (装饰器 @[Injectable]):提供者是一个普通的类,通常负责业务逻辑或数据访问,[NestJS] 可以自动创建它,并将其提供(即“注入”)给任何需要它的控制器或服务。
实际上,需要某个提供者的类只需在其构造函数中把它声明为参数即可——[NestJS] 会创建所需的实例并自动传入,你自己无需编写 new:这称为基于构造函数的依赖注入,在 NestJS 中几乎总是采用这种做法。
3.4. 第一个示例:“hello”迷你项目
为了巩固这三个概念,下面是一个非常小的 [NestJS] 项目,它独立于案例研究(只有一个路由 /hello),你可以这样创建(请在已用 VSCode [File/Open Folder] 打开的空文件夹中键入这些命令。这些命令会创建一个名为 [hello-nest] 的文件夹):

该命令生成一个包含以下基本文件的项目:[src/main.ts]、src/app.module.ts、src/app.controller.ts、src/app.service.ts。仅这四个文件就足以说明 [NestJS] 应用程序的架构:一个入口点([main.ts])、一个根模块(app.module.ts)、一个控制器(app.controller.ts)和一个服务(app.service.ts)。
3.4.1. 服务
// src/app.service.ts
import { Injectable } from '@nestjs/common';
@Injectable()
export class AppService {
getHello(): string {
return 'Hello World!';
}
}
- 第 2 行:每个被使用的元素都要显式导入;这里,[Injectable] 是从 [@nestjs/common] 导入的,该模块包含 [NestJS] 的大部分装饰器和工具类;
- 第 4 行:装饰器 是紧贴在 TypeScript 类、方法或参数之前的注解(以 @ 符号开头),它在不改变其代码的情况下修改或增强其行为——几乎整个 NestJS 词汇体系都建立在这一机制之上。@[Injectable]() 将这个类标记为 提供者:[NestJS] 会自行创建它,并自动提供给在构造函数中请求它的任何其他类,而无需自己编写 new [AppService]();
- 第 6 行:: string 声明返回类型——这是 TypeScript 特有的功能,JavaScript 中没有。
3.4.2. 控制器
- 第 5 行:@Controller() 装饰其后的类,使其成为控制器:NestJS 会把与其路由对应的 HTTP 请求交给它。括号中的参数是添加在该类所有路由开头的可选前缀——这里为空:因此“hello”路由直接响应 /hello;
- 第 7 行:构造函数声明了一个名为 appService 、类型为 [AppService] 的参数,前面带有 TypeScript 修饰符 private readonly,它用一行代码既声明该参数,又将其注册为实例的属性(this.appService)。[NestJS] 判断出该控制器需要一个 [AppService],便创建它的一个实例(整个应用程序共享的单个实例),并在此自动提供:这就是前面提到的基于构造函数的依赖注入;
- 第 9 行:[@Get]('hello') 将其后的方法与路由 HTTP GET /hello 关联:正是这个装饰器使该操作在服务器启动后可以通过可测试的地址 http://localhost:3000/hello 访问。其他装饰器对其他 HTTP 动词起相同的作用:@[Post]()、@Put()、@Delete()、@Patch()(在案例研究中我们将使用 @[Post](),用于 /addAppointment 和 /deleteAppointment)。请注意,第 10 行的方法名 [getHello] 无关紧要,可以是任何名称;
- 第 11 行:控制器把工作委托给注入的服务,而不是自己编写响应:它只是一个简单的路由层,而业务逻辑位于服务中——我们将在第 3 章的案例研究中看到这一原则在更大规模上的应用。
3.4.3. 模块
- 第 6 行:@[Module]({...}) 装饰其后的类,将其变成模块:它把应用程序中一个内聚的部分组织在一起,并在作为参数传入的对象中声明其组成。可以使用四个属性:controllers (此模块公开的控制器)、providers (此模块提供的服务,可在模块内部注入)、imports (此模块所依赖的其他模块),以及 exports (此模块向导入它的模块开放的提供者);
- 如果没有 `controllers: [AppController]` 这一行,`[NestJS]` 会忽略这个控制器,其路由不会响应任何请求;如果没有 `providers: [AppService]`,控制器的依赖注入会在启动时失败。
3.4.4. 执行
在 VSCode 中,在 [hello-nest] 文件夹根目录下打开的终端中,输入以下命令:
在浏览器中打开 http://localhost:3000/hello 时,你会得到如下响应:

3.5. 提供者与依赖注入
用 @[Injectable]() 注解的类是提供者:[NestJS] 知道如何实例化它,并在构造函数中请求它的任何地方自动注入它,前提是它出现在模块的 providers 数组中。默认情况下,[NestJS] 提供者是单例:应用程序启动时只创建一个实例,所有需要它的组件共享同一个实例——这是理解案例研究(第 3 章)中 [ApplicationModelService] 服务作用的要点,该服务在服务器启动时缓存数据。
3.6. 案例研究中还会出现的其他装饰器
装饰器 | 作用 |
将控制器方法与 HTTP 路由关联 | |
获取 URL 中的可变段,例如 /getDoctorById/:id | |
获取 POST 请求的 JSON 请求体,并反序列化为一个类 | |
声明一个提供者(服务、DAO……) | |
声明一个模块,即控制器和提供者的集合 |
这些装饰器将在 [RdvMedecins] 服务器代码(第 3 章)中出现的确切位置逐一详细说明。