第一步
在这一系列文章中,您将学习 Nest 的核心基础知识。为了熟悉 Nest 应用程序的基本构建块,我们将构建一个基本的 CRUD 应用程序,其功能在入门级别涵盖了很多内容。
语言
我们热爱 TypeScript,但最重要的是 - 我们热爱 Node.js。这就是为什么 Nest 兼容 TypeScript 和纯 JavaScript 的原因。Nest 利用了最新的语言特性,所以要在原生 JavaScript 中使用它,我们需要一个 Babel 编译器。
我们在提供的示例中主要使用 TypeScript,但您始终可以切换代码片段到原生 JavaScript 语法(只需点击每个代码片段右上角的语言切换按钮)。
先决条件
请确保您的操作系统上安装了 Node.js(版本 >= 20)。
设置
使用 Nest CLI 设置新项目非常简单。安装了 npm 后,您可以在操作系统终端中使用以下命令创建新的 Nest 项目:
$ npm i -g @nestjs/cli
$ nest new project-name
info 提示 要创建一个具有 TypeScript 更严格功能集的新项目,请在
nest new命令中传递--strict标志。
将创建 project-name 目录,安装 node modules 和一些其他样板文件,并创建 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 包含一个异步函数,它将引导我们的应用程序:
@@filename(main)
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();
@@switch
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();
要创建 Nest 应用程序实例,我们使用核心的 NestFactory 类。NestFactory 暴露了一些静态方法,允许创建应用程序实例。create() 方法返回一个应用程序对象,该对象实现了 INestApplication 接口。此对象提供了一组方法,这些方法将在后续章节中描述。在上面的 main.ts 示例中,我们只是启动了 HTTP 监听器,让应用程序等待入站 HTTP 请求。
请注意,使用 Nest CLI 搭建的项目创建了一个初始项目结构,鼓励开发人员遵循将每个模块保存在其专用目录中的约定。
info 提示 默认情况下,如果在创建应用程序时发生任何错误,您的应用程序将以代码
1退出。如果您希望它抛出错误,请禁用abortOnError选项(例如,NestFactory.create(AppModule, {{ '{' }} abortOnError: false {{ '}' }}))。
平台
Nest 旨在成为一个平台无关的框架。平台独立性使得创建可重用的逻辑部分成为可能,开发人员可以在多种不同类型的应用程序中利用这些部分。从技术上讲,一旦创建了适配器,Nest 就能够与任何 Node HTTP 框架一起工作。开箱即用支持两个 HTTP 平台:express 和 fastify。您可以选择最适合您需求的平台。
| 平台 | 描述 |
|---|---|
platform-express | Express 是一个著名的 Node 极简 Web 框架。它是一个经过实战测试、生产就绪的库,社区实现了大量资源。默认使用 @nestjs/platform-express 包。许多用户都能很好地使用 Express,无需采取任何操作即可启用它。 |
platform-fastify | Fastify 是一个高性能、低开销的框架,高度专注于提供最大的效率和速度。在这里了解如何使用它。 |
无论使用哪个平台,它都会暴露自己的应用程序接口。这些分别被视为 NestExpressApplication 和 NestFastifyApplication。
当您向 NestFactory.create() 方法传递类型时,如下面的示例所示,app 对象将具有专门针对该特定平台可用的方法。但是请注意,您不需要指定类型,除非您实际想要访问底层平台 API。
const app = await NestFactory.create<NestExpressApplication>(AppModule);
运行应用程序
安装过程完成后,您可以在操作系统命令提示符下运行以下命令来启动应用程序监听入站 HTTP 请求:
$ npm run start
info 提示 为了加快开发过程(构建速度快 20 倍),您可以通过在
start脚本中传递-b swc标志来使用 SWC 构建器,如下所示npm run start -- -b swc。
此命令启动应用程序,HTTP 服务器监听 src/main.ts 文件中定义的端口。应用程序运行后,打开浏览器并导航到 http://localhost:3000/。您应该看到 Hello World! 消息。
要监视文件中的更改,您可以运行以下命令来启动应用程序:
$ npm run start:dev
此命令将监视您的文件,自动重新编译和重新加载服务器。
代码检查和格式化
CLI 尽最大努力搭建可靠的大规模开发工作流程。因此,生成的 Nest 项目预装了代码检查器和格式化器(分别是 eslint 和 prettier)。
info 提示 不确定格式化器与代码检查器的作用?在这里了解区别。
为了确保最大的稳定性和可扩展性,我们使用基础的 eslint 和 prettier cli 包。这种设置允许通过设计与官方扩展进行整洁的 IDE 集成。
对于 IDE 不相关的无头环境(持续集成、Git 钩子等),Nest 项目附带了即用的 npm 脚本。
# 使用 eslint 进行代码检查和自动修复
$ npm run lint
# 使用 prettier 进行格式化
$ npm run format