Express 项目环境搭建 -- 13. 目录结构与入口

第 1 篇用 express-generator 生成了项目骨架,但生成器给的是「按技术类型分」的最小结构。项目变大之后,需要一套「按业务模块分」的目录约定。目录清晰不仅方便人,也方便 AI 编码助手快速定位代码——这正是本系列「让 AI 更好参与开发」思路的延续。

生成器给出的结构

1
2
3
4
5
6
7
.
├── app.js # 应用组装
├── bin/www # 启动入口
├── public/ # 静态资源
├── routes/ # 路由
├── views/ # 模板
└── package.json

这个结构能跑起来,但所有路由都堆在 routes/,所有逻辑都写在 app.js,规模一大就难维护。

推荐的目录

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
project
├── bin/www # 启动入口:创建 HTTP server、监听端口
├── src/
│ ├── app.js # 应用组装:中间件、路由、错误处理
│ ├── routes/ # 路由(按版本/资源拆分)
│ ├── middleware/ # 自定义中间件
│ ├── controllers/ # 请求处理
│ ├── services/ # 业务逻辑
│ ├── db/ # 数据库连接(单例)
│ ├── utils/ # 工具函数
│ └── config/ # 配置读取
├── prisma/ # 数据库 schema
├── uploads/ # 上传文件
├── public/ # 静态资源
├── .env # 环境变量(不进 git)
└── package.json

核心思路是「入口、组装、路由、逻辑、数据」分层:每一层只依赖下一层,避免互相引用。

把 app.js 与 bin/www 分开

app.js 只负责组装并导出 app,不负责监听端口;bin/www 负责创建 server 和 listen:

1
2
3
4
5
// src/app.js
const express = require("express");
const app = express();
// ... 中间件与路由
module.exports = app;
1
2
3
// bin/www
const app = require("../src/app");
const server = app.listen(3000);

这样拆分的好处是:测试时可以直接 require("../src/app") 拿到应用实例(见第 17 篇),不需要真正占用一个端口。

让目录约定可执行

目录约定如果不写下来,AI 助手只能靠猜。建议在仓库根目录的 README 或 AGENTS.md 里写清楚:哪类代码放哪个目录、新增一个接口要动哪几个文件。约定越明确,AI 生成的代码越贴合项目。

参考链接

系列导航


Express 项目环境搭建 -- 13. 目录结构与入口
https://bubao.github.io/posts/1a2b3c4d.html
作者
一念
发布于
2026年11月21日
许可协议