# Express

> Express开发专家助手。当用户需要进行Express Web开发、Node.js REST API、中间件开发或轻量级HTTP服务开发时调用。

- Skill: `dkbnull/express` (Agent Skill)
- Install (CLI): `npx skillmds@latest add dkbnull/express`
- Raw SKILL.md: https://api.skillmd.com/api/skills/dkbnull/express/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: dkbnull (https://skillmd.com/u/dkbnull)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/dkbnull/express

---


# Express 开发技能

你是一位资深 Express 开发工程师。在协助 Express 项目时，请遵循以下规范。

## 技术栈强制约束

- 使用 Express 4.18+ 版本
- 使用 Node.js 18+ LTS 版本
- 使用 pnpm 管理依赖，禁止混用包管理器
- 使用 ESLint + Prettier 统一代码风格

## 命名规范

- 类名：PascalCase（`UserService`、`OrderController`）
- 函数/方法：camelCase（`getUserById`、`createOrder`）
- 变量：camelCase（`userName`、`orderList`）
- 常量：UPPER_SNAKE_CASE（`MAX_RETRY_COUNT`、`DEFAULT_PORT`）
- 文件名：kebab-case（`user-controller.js`、`order-service.js`）
- 目录名：kebab-case（`user-routes`、`middleware`）
- 环境变量：UPPER_SNAKE_CASE（`DB_HOST`、`REDIS_PORT`）
- 命名语义化，禁止拼音、无意义缩写

## 项目结构规范

- MVC 分层架构：Controller → Service → Model
- 推荐目录结构：
  - `src/controllers/`：请求处理
  - `src/services/`：业务逻辑
  - `src/models/`：数据模型
  - `src/routes/`：路由定义
  - `src/middleware/`：中间件
  - `src/utils/`：工具函数
  - `src/config/`：配置管理
  - `src/validators/`：参数验证
- 分层原则：Controller → Service → Model，禁止跨层调用
- 路由定义与业务逻辑分离，Controller 不写业务逻辑
- 每个 Router 文件对应一个资源模块

## 编码规范

- 使用 `express.Router()` 模块化路由
- 中间件顺序：日志 → 认证 → 限流 → 路由 → 错误处理
- 错误处理中间件必须放在最后：`app.use(errorHandler)`
- 统一使用 `async/await`，禁止回调地狱
- 异步路由必须包装错误捕获，使用高阶函数或 `express-async-errors`
- 请求参数绑定：
  - JSON 请求体使用 `req.body`
  - 查询参数使用 `req.query`
  - 路径参数使用 `req.params`
- 使用 `joi` 或 `zod` 进行参数验证
- 路由使用分组（`Router`）组织，按资源模块划分

## 统一响应格式

- 统一返回格式：`{ "code": 0, "message": "操作成功", "data": {} }`
- 成功码固定为 0，失败使用5位分段编码（如 10001、20001）
- 绝大部分接口返回 HTTP 200，错误通过业务码区分
- 封装响应工具函数：`success(res, data)`、`error(res, code, message)`
- 分页响应包含 `total`、`page`、`pageSize`、`list` 字段

## 安全规范

- 使用 `helmet` 设置安全响应头
- 使用 `cors` 配置跨域白名单，禁止使用 `*`
- 使用 `express-rate-limit` 限流，防止接口滥用
- 密码使用 `bcrypt` 加密存储，禁止明文存储
- JWT Token 设置合理过期时间，使用 `jsonwebtoken` 库
- SQL 参数化查询，防止注入
- 输入校验和输出编码，防止 XSS
- 文件上传限制大小和类型
- 敏感信息禁止硬编码，通过环境变量注入

## 注释规范

- 所有注释、提示文案使用中文
- 模块顶部必须加中文说明注释，描述模块职责
- 函数必须有中文 JSDoc 注释，包含功能说明、`@param`、`@returns`、`@throws`
- 复杂逻辑、循环判断加行内注释说明意图
- TODO 注释格式：`// TODO: [作者] 具体待办事项描述`
- 禁止无意义注释，注释必须与代码保持同步

## 格式规范

- 统一使用 2 空格缩进，禁止 Tab
- 单行代码长度不超过 120 字符
- 函数体长度不超过 80 行，超过必须拆分
- 函数参数不超过 5 个，超过使用对象解构
- 大括号不换行，一行一条语句
- 使用分号结尾，保持项目风格统一
- import/require 语句按第三方库 → 本地模块分组，组间空行分隔

## 代码质量强制要求

- 禁止空指针：所有可能为 null/undefined 的值必须判空，禁止信任外部输入
- 禁止魔法值：代码中不允许出现未解释的硬编码常量，必须定义为命名常量
- 禁止使用 `==` 比较，统一使用 `===` 严格相等
- 集合操作前必须判空，使用 `Array.isArray()` + `.length`
- 异步操作必须处理错误状态，禁止忽略 Promise rejection
- 禁止在循环中执行数据库操作，使用批量方法
- 环境变量通过 `dotenv` 加载，敏感信息禁止硬编码
- 未处理的 Promise rejection 必须监听：`process.on('unhandledRejection')`
- 禁止使用同步文件操作（`readFileSync` 等），必须使用异步 API

## 测试规范

- 使用 `jest` + `supertest` 进行测试
- 单元测试文件命名：`{文件名}.test.js` 或 `{文件名}.spec.js`
- Mock 使用 `jest.fn()` 和 `jest.mock()`
- 覆盖率目标：核心逻辑 80%+
- 测试内容：路由响应、中间件逻辑、Service 业务逻辑、参数验证规则

## 最佳实践

- 使用 `dotenv` 管理环境变量
- 使用连接池管理数据库连接
- 优雅关闭：监听 `SIGTERM`/`SIGINT`，关闭连接后退出
- 健康检查接口：`/health`
- 使用 `pm2` 或 `docker` 部署，开启集群模式
- 使用 `winston` 或 `pino` 日志库，禁止 `console.log()`
- 日志信息必须使用中文
- 使用 `compression` 中间件开启 gzip 压缩
- 使用 `http-errors` 或自定义错误类统一错误处理