2. Nest.js 第一步

第一步

在这组文章中，您将学习Nest的核心基础知识。为了熟悉Nest应用程序的基本构建块，我们将构建一个基本的CRUD应用程序，其功能涵盖了入门级的许多基础知识。

语言

Nest利用了最新的语言特性，所以要在普通JavaScript中使用它，我们需要一个Babel编译器。

在我们提供的示例中，我们将主要使用TypeScript，但你也可以将代码片段切换为普通的JavaScript语法(只需单击每个代码片段右上角的语言按钮即可)。

预备知识

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

安装

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

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

[!hint]
要用TypeScript更严格的特性集创建一个新项目，把--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包含一个async函数，它将引导我们的应用程序:

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接口。这个对象提供了一组方法，这些方法将在后面的章节中描述。基本上。在上面的例子中，我们只需启动HTTP侦听器，让应用程序等待入站HTTP请求。

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

[!hint]
默认情况下，如果在创建应用程序时发生任何错误，应用程序将以代码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()方法时，如下面的例子所示，应用对象将拥有专门用于该特定平台的方法。但是请注意，除非您确实想要访问底层平台API，否则您不需要指定类型。

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

运行程序

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

$ npm run start

[!hint]+
为了加快开发过程(构建速度提高20倍)，您可以通过向启动脚本传递-b swc标志来使用SWC构建器，如下所示:npm run start -- -b swc。

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

要观察文件中的变化，可以运行以下命令来启动应用程序:

npm run start:dev

该命令将监视您的文件，自动重新编译并重新加载服务器(热重载)。

Linting 和 formatting

CLI尽最大努力构建可靠的大规模开发工作流。因此，生成的Nest项目附带了预安装的代码检查器和格式化器(分别是eslint和prettier)。

[!hint]+
不确定formatters和linters的作用?在这里了解它们的区别。

为了确保最大的稳定性和可扩展性，我们使用了基本的eslint和prettier的cli包。这种设置允许通过设计将IDE与官方扩展集成在一起。

对于没有IDE的环境(持续集成、Git钩子等)，Nest项目提供了现成的npm脚本。

# Lint and autofix with eslint
$ npm run lint

# Format with prettier
$ npm run format