Koa 作为一个轻量级的 Node.js Web 框架，虽然没有严格规定分层方式，但通常在实际项目中会采用分层架构来提高代码的可维护性和可扩展性。以下是 Koa 应用中常见的分层方式：

一、核心分层结构

1、表现层 (Presentation Layer)

• 路由层：处理 HTTP 请求和响应
• 控制器：协调请求处理和响应返回
• 中间件：处理跨领域关注点

2、服务层 (Service Layer)

• 业务逻辑实现
• 数据聚合和处理
• 第三方服务集成

3、数据访问层 (Data Access Layer)

• 数据库操作
• 缓存处理
• 数据模型定义

4、基础设施层 (Infrastructure Layer)

• 配置管理
• 日志系统
• 工具函数

二、典型项目目录结构

project

app.js# 应用入口

config# 配置层

config.js# 应用配置

database.js# 数据库配置

controllers# 控制层

user.controller.js

product.controller.js

services# 服务层

user.service.js

product.service.js

models# 模型层

user.model.js

product.model.js

routes# 路由层

index.js

user.routes.js

product.routes.js

middlewares# 中间件层

auth.js

logger.js

utils# 工具层

response.js

error.js

三、各层详细说明

1、 路由层 (Routes)

// routes/user.routes.js
const Router = require("koa-router");
const { getUser } = require("../controllers/user.controller");

const router = new Router({ prefix: "/users" });

router.get("/:id", getUser);

module.exports = router;

2、控制层 (Controllers)

// controllers/user.controller.js
const userService = require("../services/user.service");

async function getUser(ctx) {
  const { id } = ctx.params;
  try {
    const user = await userService.getUserById(id);
    ctx.body = { data: user };
  } catch (error) {
    ctx.throw(500, error.message);
  }
}

module.exports = { getUser };

3、服务层 (Services)

// services/user.service.js
const userModel = require("../models/user.model");

async function getUserById(id) {
  return await userModel.findById(id);
}

module.exports = { getUserById };

4、模型层 (Models)

// models/user.model.js
const mongoose = require("mongoose");

const userSchema = new mongoose.Schema({
  name: String,
  email: { type: String, unique: true },
  password: String,
});

module.exports = mongoose.model("User", userSchema);

5、中间件层 (Middlewares)

// middlewares/auth.js
async function auth(ctx, next) {
  const token = ctx.headers.authorization;
  if (!token) ctx.throw(401, "Unauthorized");

  try {
    const user = verifyToken(token);
    ctx.state.user = user;
    await next();
  } catch (err) {
    ctx.throw(401, "Invalid token");
  }
}

module.exports = auth;

4. 分层请求流程

客户端请求 → 路由层 → 中间件层 → 控制层 → 服务层 → 模型层
                                 ↓
客户端响应 ← 控制层 ← 服务层 ← 数据层

5. 分层优势

1. 关注点分离：每层只处理特定职责
2. 易于维护：修改某层不影响其他层
3. 可测试性：可以单独测试每一层
4. 可扩展性：可以轻松添加新功能
5. 团队协作：不同开发者可以并行开发不同层

6. 实际应用建议

1. 保持层间单向依赖：上层可以依赖下层，下层不应依赖上层
2. 定义清晰的接口：层与层之间通过明确定义的接口通信
3. 避免跨层调用：控制器不应直接访问模型层
4. 共享上下文：通过 Koa 的 ctx.state 在层间传递数据
5. 错误处理：在控制层统一处理错误

Koa 的分层架构不是强制性的，但采用良好的分层实践可以显著提高大型应用的可维护性和可扩展性。根据项目规模，可以适当调整分层粒度。

更新日志

2025/8/24 08:17

查看所有更新日志

• e7112-1于 2025/8/24