实践:创建第一个 Nest 项目 | 青训营

118 阅读1分钟

实践环境

Cloud Studio / Node18+

安装 NestJS

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

$ npm i -g @nestjs/cli
$ nest new [项目名称]

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

src

  • app.controller.spec.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 应用实例的应用入口文件。

平台

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

运行应用

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

$ npm run start

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

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

截图演示

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

$ npm run start:dev

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

总结

使用 CloudStudio 可以快速的在网页上创建一个即时的在线 ide,可以创建多种框架的编程环境,在小项目或者小程序的编写都可以使用它来开发。NestJS 在开发上提供了很多的 API,基本上开箱即用。