后端想先有一层模块化的框架,NestJS 官方怎么写出第一份应用?

后端想先有一层模块化的框架来放接口。按 NestJS 官方 First steps 把最初那份应用结构建起来。这跟已经写过的 Fastify、Hono 不是同一套东西,不要把下面当成那两篇的续。站内 新写一个小 HTTP API 还习惯 Express,Fastify 官方 Getting Started 先建什么? 和 边缘上要挂几个接口,Hono 说同一份代码能跟哪些运行时走? 各自讲的是另外的工具。这里只按 Nest 文档把初始目录搭起来。

Documentation 把 Nest(NestJS)写成一套用来做高效、可扩展的 Node.js 服务端程序的框架,小到单文件 API,大到多人协作的系统都能放进去。它本身用 TypeScript 开发,也允许写普通 JavaScript,还吸收了 OOP、FP 和 FRP 里的一些做法。文档说,底层默认走 Express,也可以改成 Fastify,或直接用 Node.js 自带的 node:http。官方把它写成加在这些常见 HTTP 库之上的一层抽象,同时又把底层 API 暴露出来,方便继续使用对应生态里的模块。组织方式上,它给出一层现成的应用骨架,让测试、扩展和拆分更容易下手,并写明这种安排很大程度上受到 Angular 的启发。第一次接触时,文档建议走 Nest CLI。First steps 那一章也按这条路继续。同一页还写了另外两条路:可以克隆 TypeScript 起步仓库,或给 nest new 加上 --minimal,生成代码集中在一个文件里的小项目。入门仍按 CLI 的常规模板走即可。

脚手架命令是:

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

First steps 先核对运行环境。这一组文章会带出一个覆盖不少基础能力的 CRUD 程序,用来认识 Nest 应用里那些常用的积木。Nest 用 TypeScript 写成、跑在 Node.js 上,同时支持普通 JavaScript。若坚持写 JS,文档要求配 Babel,因为要用到较新的语言特性。文中例子默认是 TypeScript,代码块右上角可以把片段切到 JavaScript 语法。跑程序需要 Node.js v20.19 或更新(在 22.x 这条线上则是 v22.12 及以上)。nest new、nest generate 这类生成器还要更高:v22.22.3+、v24.15+ 或 v26+。页上建议装目前的 active LTS,这样两项都能满足。

CLI 创建项目时会问用哪一种模块系统:默认是 ESM,配套测试是 Vitest。也可以选 CommonJS,那时改用 Jest。它还会问要不要接入 NestJS Observe,也就是官方的可观测性平台。若选择加入,生成结果里会带上已经接到 AppModule 和 NestFactory.create() 的 @nestjs/observe SDK。在可以一问一答的终端里,这个提示默认是 yes。持续集成这类无人值守的环境会跳过,并且不会自动加入 Observe。不想看到这道题时,可以用 --observe 或 --no-observe 明确表态。生成出来的 TypeScript 项目会打开 strict 模式,若要关掉,到写好的 tsconfig.json 里把 "strict" 设为 false。

命令会建出名为 project-name 的目录,装好依赖,并在 src/ 里放上这几个文件。app.controller.ts 是带一条路由的控制器。旁边的 app.controller.spec.ts 是它的单元测试。app.module.ts 是应用的根模块,app.service.ts 提供一个带单一方法的服务。入口在 main.ts,用 NestFactory 创建实例。文档里的 main.ts 写成:

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module.js';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(process.env.PORT ?? 3000);
}
await bootstrap();

也就是监听 PORT 环境变量,没有设置时用 3000。create() 返回的对象实现 INestApplication,上面这个例子会启动 HTTP 监听,等待进来的请求。官方还写了,CLI 生成的结构鼓励每个模块放在自己的目录里。平台方面,First steps 写 Nest 能对接 Express、Fastify 和 node:http,生成项目时默认包是 @nestjs/platform-express。从 v12.3 起,文档推荐新应用改用 Node adapter,并写它会在 v13 变成默认,但目前还不是,需要另外安装 @nestjs/platform-node,再把它传给 NestFactory.create()。第一次只想把结构跑起来,可以先不必换适配器。

依赖装完后启动:

npm run start

HTTP 服务会落在 src/main.ts 里写下的那个端口(未设置 PORT 时就是 3000)。浏览器打开 http://localhost:3000/,应看到 Hello World!。开发时若希望改文件就自动编译并重启,用 npm run start:dev。页上还提到,想加快开发构建,可以给启动脚本加上 -b swc,写成 npm run start -- -b swc。生成出来的 TypeScript 项目会预装 oxlint 和 Prettier,并提供 npm run lint、npm run format 这两条脚本,方便在没有编辑器介入的环境里做检查和排版。

第一次 npm run start 之后,http://localhost:3000/ 有打出 Hello World 吗?