译文:nest 介绍和启航(一)

学习一个技术最好的方式就是看他的官网,大家好,我是云牧,这次翻译的是 nest 最新官网。

翻译方式是 chatgpt 辅助翻译 + 人工每行校对。错误的地方,欢迎大家语雀评论纠正。

语雀文档地址:nest 官网译文 (yuque.com)

过程中我会对一些感觉不恰当内容有少量的增加修改删除。

希望内容会对大家有所帮助。

Nest(NestJS)是一个用于构建高效、可扩展的 Node.js 服务器端应用程序的框架。

它使用渐进式 JavaScript,基于 TypeScript 构建,并完全支持 TypeScript(同时仍然允许开发者使用纯 JavaScript 编码),结合了面向对象编程(OOP)、函数式编程(FP)和函数响应式编程(FRP)的元素。

在底层,Nest 使用了强大的 HTTP 服务器框架,如 Express(默认)和可选的 Fastify 配置!

Nest 在这些常见的 Node.js 框架(Express / Fastify)之上提供了一层抽象,同时直接向开发者暴露了它们的 API。这使得开发者可以自由地使用为底层平台提供的众多第三方模块。

Philosophy 哲学

近年来,由于 Node.js 的出现,JavaScript 已成为 Web 前端和后端应用的"通用语言"。

这催生了一些令人惊叹的项目,如 Angular、React 和 Vue,它们提高了开发者的生产力,使得创建快速、可测试和可扩展的前端应用成为可能。

然而,尽管有许多出色的库、辅助工具和工具可用于 Node(和服务器端 JavaScript),但它们都没有有效地解决主要问题 - 架构。

Nest 提供了一个开箱即用的应用架构,允许开发者和团队创建高度可测试、可扩展、松耦合和易于维护的应用程序。该架构受到 Angular 的深刻启发。

Installation 安装

你可以使用 Nest CLI 搭建项目,或者克隆一个起始项目(两者都会产生相同的结果)。

使用 Nest CLI 搭建项目,请运行以下命令。这将创建一个新的项目目录,并在目录中生成初始的核心 Nest 文件和支持模块,为您的项目创建一个传统的基础结构。

使用 Nest CLI 创建新项目是推荐给初次使用者的。我们将在后续"第一步"章节中继续使用这种方法。

bash 复制代码
npm i -g @nestjs/cli
nest new project-name

要创建一个具有更严格功能集的新的 TypeScript 项目,请在 nest new 命令中传递 --strict 标志。

Alternatives 备选方案

或者,使用 Git 安装 TypeScript 入门项目:

bash 复制代码
git clone https://github.com/nestjs/typescript-starter.git project
cd project
npm install
npm run start

如果您想克隆存储库但不需要 Git 历史记录,可以使用 degit

打开你的浏览器并导航到 http://localhost:3000/

要安装 JavaScript 版本的起始项目,请使用上面的命令序列中的 javascript-starter.git 。

您还可以通过使用 npm(或 yarn)手动从头开始创建一个新项目,安装核心和支持文件。

在这种情况下,当然,您将负责自己创建项目的样板文件。

bash 复制代码
npm i --save @nestjs/core @nestjs/common rxjs reflect-metadata

在这一系列的文章中,你将学习到 Nest 的核心基础知识。为了熟悉 Nest 应用程序的基本构建模块,我们将构建一个基本的 CRUD 应用程序,其中包含了许多入门级别的功能。

Language 语言

我们对 TypeScript 非常喜爱,但最重要的是,我们热爱 Node.js。这就是为什么 Nest 兼容 TypeScript 和纯 JavaScript 的原因。

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

我们在提供的示例中主要使用 TypeScript。

Prerequisites 先决条件

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

Setup 设置

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

bash 复制代码
npm i -g @nestjs/cli
nest new project-name

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

将创建 project-name 目录,安装 node_modules 和一些其他样板文件,并将创建一个 src 目录,目录中包含几个核心文件。

bash 复制代码
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 包含一个异步函数,它将引导我们的应用程序:

typescript 复制代码
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 }) )。

Platform 平台

Nest 的目标是成为一个平台无关的框架。平台独立性使得开发人员可以在多种不同类型的应用程序中重复使用逻辑部分。

从技术上讲,只要创建了适配器,Nest 就能与任何 Node HTTP 框架一起使用。现有两个 HTTP 平台被支持:express 和 fastify。您可以选择最适合您需求的平台。

platform-express Express 是一个众所周知的 node.js 简约 Web 框架。 这是一个经过实战考验,适用于生产的库,拥有大量社区资源。 默认情况下使用 @nestjs/platform-express 包。 许多用户都可以使用 Express ,并且无需采取任何操作即可启用它。
platform-fastify Fastify 是一个高性能,低开销的框架,专注于提供最高的效率和速度。 Read how to use it here. 阅读如何使用它。

无论使用哪个平台,它都会暴露出自己的应用程序接口。分别被视为 NestExpressApplication 和 NestFastifyApplication 。

当您将类型传递给 NestFactory.create() 方法时,如下面的示例所示, app 对象将仅针对该特定平台提供可用的方法。但请注意,除非您确实希望访问底层平台 API,否则不需要指定类型。

typescript 复制代码
const app = await NestFactory.create<NestExpressApplication>(AppModule);

运行应用程序

安装过程完成后,您可以在系统命令行工具中运行以下命令,以启动应用程序:

bash 复制代码
npm run start

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

这个命令会启动应用程序,并在端口 src/main.ts 上监听 HTTP 服务器。一旦应用程序运行起来,打开浏览器并访问 http://localhost:3000/ 。你应该能看到 Hello World! 的消息。

要监视文件的变化,您可以运行以下命令来启动应用程序:

bash 复制代码
npm run start:dev

这个命令会监视你的文件,自动重新编译并重新加载服务器。

代码检查和格式化

CLI 在大规模开发中提供最佳实践,来搭建可靠的开发工作流程。因此,生成的 Nest 项目预装了代码检查器和格式化工具(分别是 eslint 和 prettier)

不确定格式化程序和代码检查工具的作用?Learn the difference here.

为了确保最大的稳定性和可扩展性,我们使用基础的 eslint 和 prettier cli包。这个设置允许与官方扩展的 IDE 集成非常顺畅。

对于无需 IDE 的无头环境(持续集成、Git 钩子等),Nest 项目附带了可立即使用的脚本。

bash 复制代码
# Lint and autofix with eslint
npm run lint

# Lint and autofix with eslint
npm run format
相关推荐
Python私教5 分钟前
Go语言现代web开发15 Mutex 互斥锁
开发语言·前端·golang
A阳俊yi6 分钟前
Vue(13)——router-link
前端·javascript·vue.js
好看资源平台19 分钟前
前端框架对比与选择:如何在现代Web开发中做出最佳决策
前端·前端框架
4triumph21 分钟前
Vue.js教程笔记
前端·vue.js
程序员大金38 分钟前
基于SSM+Vue+MySQL的酒店管理系统
前端·vue.js·后端·mysql·spring·tomcat·mybatis
清灵xmf41 分钟前
提前解锁 Vue 3.5 的新特性
前端·javascript·vue.js·vue3.5
程序员大金1 小时前
基于SpringBoot的旅游管理系统
java·vue.js·spring boot·后端·mysql·spring·旅游
白云~️1 小时前
监听html元素是否被删除,删除之后重新生成被删除的元素
前端·javascript·html
金灰1 小时前
有关JS下隐藏的敏感信息
前端·网络·安全
Yxmeimei1 小时前
css实现居中的方法
前端·css·html