React / 系统课时

创建 TypeScript 后端项目

创建 TypeScript 后端项目

本课从空目录搭建一个可开发、可构建、可运行的 Node.js TypeScript 后端项目。完成后,你将得到严格类型检查、热重载脚本、生产构建目录和清晰的源码结构。

学习目标

  • 检查 Node.js 与 npm 是否可用
  • 初始化 TypeScript、开发运行和生产构建配置
  • 建立可验证的后端目录结构

前置检查

先确认终端能够找到 Node.js 和 npm。版本号会因本机环境不同而变化,只要两条命令都能正常输出即可。

bash
node --version
npm --version

预期输出

text
v<MAJOR>.<MINOR>.<PATCH>
<NPM_MAJOR>.<NPM_MINOR>.<PATCH>

若提示命令不存在,应先安装仍在维护期的 Node.js LTS,并重新打开终端,使环境变量生效。

初始化项目与开发依赖

创建项目目录,生成 package.json,再安装 TypeScript 编译器、Node.js 类型声明和 tsx 开发运行器。tsx 可以直接执行 TypeScript,并在文件变化后自动重启进程。

bash
mkdir react18-api
cd react18-api
npm init -y
npm install -D typescript tsx @types/node
mkdir src

预期结果

text
react18-api/
├── node_modules/
├── package-lock.json
├── package.json
└── src/

安装日志中的包数量和审计信息可能不同;验收重点是命令无报错,并生成 package-lock.json。

配置编译与运行脚本

在项目根目录创建 tsconfig.json。这里使用 Node.js 的 ESM 解析规则,把 src 编译到 dist,并开启严格类型检查。

json
{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "rootDir": "src",
    "outDir": "dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "sourceMap": true
  },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules", "dist"]
}

该配置生效后,src 之外的文件不会进入本次构建,类型错误会阻止生成可交付产物。

使用 npm 命令写入模块类型和三个脚本,避免手工修改时破坏 package.json 的 JSON 结构。

bash
npm pkg set type=module
npm pkg set "scripts.dev=tsx watch src/index.ts"
npm pkg set "scripts.build=tsc -p tsconfig.json"
npm pkg set "scripts.start=node dist/index.js"

预期结果

text
package.json 中出现 type、dev、build、start 配置,命令执行过程无报错。

编写最小入口

创建 src/index.ts。这个入口只输出一条消息,用于验证开发执行、TypeScript 编译和生产运行三条链路是否都可用。

ts
const startedAt = new Date().toISOString();

// 动态时间用于确认当前进程确实重新启动过
console.log(`backend-ts-ready ${startedAt}`);

先启动开发模式。

bash
npm run dev

预期输出

text
backend-ts-ready <TIME>

修改并保存 src/index.ts 后,终端应再次出现新的 <TIME>,说明监听重启已经生效。按 Ctrl+C 可停止开发进程。

构建并运行产物

执行 TypeScript 编译,成功后会生成 dist/index.js 和源码映射文件。

bash
npm run build

预期结果

text
dist/
├── index.js
└── index.js.map

最后运行编译后的 JavaScript,确认生产脚本不依赖 tsx。

bash
npm start

预期输出

text
backend-ts-ready <TIME>

若 npm run build 报找不到输入文件,检查 src/index.ts 是否存在;若 npm start 报找不到 dist/index.js,说明尚未成功构建或 outDir 配置不一致。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

创建 TypeScript 后端项目

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通