第一步

在这组文章中,你将学习 Nest 的核心基础。为了熟悉 Nest 应用程序的基本构建块,我们将构建一个基本的 CRUD 应用程序,其功能在入门级别涵盖了很多内容。

语言

我们热爱 TypeScript,但最重要的是 - 我们热爱 Node.js。这就是为什么 Nest 与 TypeScript 和纯 JavaScript 兼容。Nest 利用最新的语言特性,因此要将其与原生 JavaScript 一起使用,我们需要 Babel 编译器。

我们在提供的示例中主要使用 TypeScript,但你始终可以切换代码片段到原生 JavaScript 语法(只需点击每个片段右上角的语言按钮即可切换)。

前提条件

请确保在你的操作系统上安装了 Node.js(版本 >= 20)。

设置

使用 Nest CLI 设置新项目非常简单。安装了 npm 后,你可以在 OS 终端中使用以下命令创建新的 Nest 项目:

$ npm i -g @nestjs/cli
$ nest new project-name
提示

要使用 TypeScript 的 更严格 功能集创建新项目,请将 --strict 标志传递给 nest new 命令。

将创建 project-name 目录,安装 node 模块和一些其他样板文件,并创建一个 src/ 目录并填充几个核心文件。

src
app.controller.spec.ts
app.controller.ts
app.module.ts
app.service.ts
main.ts

以下是这些核心文件的简要概述:

app.controller.ts带有单个路由的基本控制器。
app.controller.spec.ts控制器的单元测试。
app.module.ts应用程序的根模块。
app.service.ts带有单个方法的基本服务。
main.ts应用程序的入口文件,使用核心函数 NestFactory 创建 Nest 应用程序实例。

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);
}
bootstrap();

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

要创建 Nest 应用程序实例,我们使用核心 NestFactory 类。NestFactory 公开了几个静态方法,允许创建应用程序实例。create() 方法返回一个应用程序对象,该对象满足 INestApplication 接口。此对象提供了一组方法,这些方法将在后续章节中描述。在上面的 main.ts 示例中,我们简单地启动 HTTP 监听器,让应用程序等待入站 HTTP 请求。

请注意,使用 Nest CLI 搭建的项目创建了一个初始项目结构,鼓励开发人员遵循将每个模块保存在自己专用目录中的约定。

提示

默认情况下,如果在创建应用程序时发生任何错误,你的应用将以代码 1 退出。如果你想让它抛出错误而不是退出,请禁用 abortOnError 选项(例如,NestFactory.create(AppModule, {{ '{' }} abortOnError: false {{ '}' }}))。

平台

Nest 旨在成为一个平台无关的框架。平台独立性使得创建可重用的逻辑部分成为可能,开发人员可以在多种不同类型的应用程序中利用这些部分。从技术上讲,一旦创建了适配器,Nest 就能够与任何 Node HTTP 框架一起工作。有两个 HTTP 平台开箱即用:expressfastify。你可以选择最适合你需求的平台。

platform-expressExpress 是一个著名的 Node 极简 Web 框架。它是一个经过实战测试的、生产就绪的库,社区实现了许多资源。@nestjs/platform-express 包默认使用。许多用户使用 Express 就足够了,不需要采取任何行动来启用它。
platform-fastifyFastify 是一个高性能、低开销的框架,高度专注于提供最大效率和速度。阅读如何使用它 这里

无论使用哪个平台,它都会公开自己的应用程序接口。这些分别被视为 NestExpressApplicationNestFastifyApplication

当你将类型传递给 NestFactory.create() 方法时,如下例所示,app 对象将具有专用于该特定平台的方法。但是,你不需要指定类型,除非你实际上想访问底层平台 API。

const app = await NestFactory.create<NestExpressApplication>(AppModule);

运行应用程序

安装过程完成后,你可以在 OS 命令提示符下运行以下命令来启动应用程序监听入站 HTTP 请求:

$ npm run start
提示

为了加快开发过程(构建速度提高 20 倍),你可以使用 SWC 构建器,方法是将 -b swc 标志传递给 start 脚本,如下所示:npm run start -- -b swc

此命令启动应用程序,HTTP 服务器监听 src/main.ts 文件中定义的端口。应用程序运行后,打开浏览器并导航到 http://localhost:3000/。你应该看到 Hello World! 消息。

要监视文件中的更改,你可以运行以下命令来启动应用程序:

$ npm run start:dev

此命令将监视你的文件,自动重新编译和重新加载服务器。

代码检查和格式化

CLI 尽最大努力搭建一个可扩展的可靠开发工作流。因此,生成的 Nest 项目预装了代码检查器格式化器(分别是 eslintprettier)。

提示

不确定格式化器与检查器的作用?了解差异 这里

为确保最大稳定性和可扩展性,我们使用基础 eslintprettier cli 包。此设置允许通过设计与官方扩展进行整洁的 IDE 集成。

对于 IDE 不相关的无头环境(持续集成、Git 钩子等),Nest 项目提供了现成可用的 npm 脚本。

# 使用 eslint 检查并自动修复
$ npm run lint

# 使用 prettier 格式化
$ npm run format