第一步 First steps

导读

在本系列文章中，您将了解 Nest 的 核心基础知识。为了熟悉 Nest 应用程序的基本构建块，我们将构建一个基本的 CRUD 应用程序，该应用程序具有入门级的大量功能。

语言

我们喜欢 TypeScript，但最重要的是 - 我们喜欢 Node.js。这就是 Nest 与 TypeScript 和 纯 JavaScript 兼容的原因。Nest 利用了最新的语言功能，因此要将其与原始 JavaScript 一起使用，我们需要一个 Babel 编译器。

我们将在提供的示例中主要使用 TypeScript，但您始终可以 将代码片段 切换为原始 JavaScript 语法（只需单击每个代码片段右上角的语言按钮即可切换）。

先决条件

请确保您的操作系统上安装了 Node.js（版本 >= 16）。

设置

使用 Nest CLI 设置新项目非常简单。安装 npm 后，您可以在操作系统终端中使用以下命令创建一个新的 Nest 项目：

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

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

将创建 project-name 目录，安装节点模块和其他一些样板文件，并创建 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 包含一个异步函数，它将 引导 我们的应用程序：

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

async function bootstrap() {
  const app = await NestFactory.create(AppModule)
  await app.listen(3000)
}
bootstrap()
js
import { NestFactory } from '@nestjs/core'
import { AppModule } from './app.module'

async function bootstrap() {
  const app = await NestFactory.create(AppModule)
  await app.listen(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 平台支持：express 和 fastify。您可以选择最适合您需求的平台。

platform-expressExpress 是一个著名的 Node 极简主义 Web 框架。它是一个久经考验、可用于生产的库，拥有社区实现的大量资源。默认情况下使用 @nestjs/platform-express 包。许多用户都很好地使用了 Express，无需采取任何措施即可启用它。
platform-fastifyFastify 是一个高性能、低开销的框架，高度专注于提供最高的效率和速度。阅读如何使用它这里。

无论使用哪个平台，它都会公开自己的应用程序接口。它们分别被视为 NestExpressApplication 和 NestFastifyApplication。

当您将类型传递给 NestFactory.create() 方法时，如下例所示，app 对象将具有专门针对该特定平台的方法。但请注意，除非您确实想要访问底层平台 API，否则您不需要指定类型。

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

运行应用程序

安装过程完成后，您可以在操作系统命令提示符下运行以下命令来启动应用程序以监听入站 HTTP 请求：

bash
$ npm run start
提示

要加快开发过程（构建速度提高 20 倍），您可以使用 SWC builder，将 -b swc 标志传递给 start 脚本，如下所示 npm run start -- -b swc。

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

要监视文件中的更改，您可以运行以下命令来启动应用程序：

bash
$ npm run start:dev

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

代码检查和格式化

CLI 尽最大努力构建大规模可靠的开发工作流程。因此，生成的 Nest 项目预装了代码 linter 和 formatter（分别为 eslint 和 prettier）。

提示

不确定格式化程序和代码检查的作用？了解 此处 的区别。

为了确保最大的稳定性和可扩展性，我们使用基础 eslint 和 prettier cli 包。此设置允许在设计上将 IDE 与官方扩展完美集成。

对于与 IDE 无关的无头环境（持续集成、Git 钩子等），Nest 项目附带了随时可用的 npm 脚本。

bash
# Lint and autofix with eslint
$ npm run lint

# Format with prettier
$ npm run format