当前位置：首页 > news >正文

Egg.js知识框架

news 来源：原创 2025/5/13 8:41:47

一、Egg.js 核心概念

1. Egg.js 简介

基于 Koa 的企业级 Node.js 框架（阿里开源）
约定优于配置（Convention over Configuration）
插件化架构，内置多进程管理、日志、安全等能力
适合中大型企业应用，提供完整 MVC 解决方案

二、核心架构

1. 目录结构（约定式）

egg-project
├── app
│   ├── controller       # 控制器
│   ├── service          # 业务逻辑
│   ├── model            # 数据模型（可选）
│   ├── middleware       # 中间件
│   ├── router.js        # 路由配置
│   └── extend           # 扩展（helper、filter等）
├── config
│   ├── config.default.js  # 默认配置
│   ├── config.prod.js     # 生产环境配置
│   └── plugin.js        # 插件配置
└── test                # 单元测试

2. 核心对象

对象	说明
`Application`	全局应用对象（单例）
`Context`	请求上下文（封装 `request/response`）
`Controller`	处理用户输入，返回响应
`Service`	业务逻辑封装
`Helper`	工具函数
`Logger`	日志对象

三、核心功能

1. 路由系统

(1) 基本路由（`app/router.js`）

module.exports = app => {const { router, controller } = app;router.get('/user/:id', controller.user.info); // RESTful 风格router.post('/api/login', controller.auth.login);
};

(2) RESTful 路由

router.resources('posts', '/api/posts', controller.posts); // 自动生成 CRUD 路由

(3) 路由中间件

router.get('/admin', app.middleware.auth(), controller.admin.index);

2. 控制器（Controller）

(1) 基本结构

// app/controller/user.js
const Controller = require('egg').Controller;class UserController extends Controller {async info() {const { ctx } = this;const userId = ctx.params.id;const user = await ctx.service.user.find(userId);ctx.body = user;}
}

(2) 常用 `ctx` 方法

方法	说明
`ctx.query`	获取查询参数
`ctx.params`	获取路由参数
`ctx.request.body`	获取请求体（需 `bodyParser`）
`ctx.redirect(url)`	重定向
`ctx.render(view, data)`	渲染模板
`ctx.status = 200`	设置状态码

3. 服务（Service）

业务逻辑封装（避免 Controller 臃肿）
可复用（多个 Controller 调用同一个 Service）
支持 async/await

示例

// app/service/user.js
const Service = require('egg').Service;class UserService extends Service {async find(id) {return await this.app.mysql.get('user', { id });}
}

调用方式

const user = await ctx.service.user.find(1);

4. 中间件（Middleware）

(1) 编写中间件

// app/middleware/auth.js
module.exports = (options, app) => {return async (ctx, next) => {if (!ctx.session.user) {ctx.throw(401, 'Unauthorized');}await next();};
};

(2) 注册中间件

// config/config.default.js
exports.middleware = ['auth']; // 全局中间件// 或局部使用
router.get('/admin', app.middleware.auth(), controller.admin.index);

5. 插件系统

(1) 官方插件

插件	用途
`egg-mysql`	MySQL 数据库
`egg-sequelize`	Sequelize ORM
`egg-redis`	Redis 客户端
`egg-validate`	参数校验
`egg-jwt`	JWT 认证

(2) 配置插件

// config/plugin.js
exports.mysql = {enable: true,package: 'egg-mysql',
};// config/config.default.js
exports.mysql = {client: {host: '127.0.0.1',port: '3306',user: 'root',password: '123456',database: 'test',},
};

四、数据操作

1. 数据库（MySQL/Sequelize）

(1) 使用 `egg-mysql`

// 查询
const user = await this.app.mysql.get('user', { id: 1 });// 插入
await this.app.mysql.insert('user', { name: 'Tom' });// 更新
await this.app.mysql.update('user', { name: 'Jerry' }, { where: { id: 1 } });

(2) 使用 `egg-sequelize`

// app/model/user.js
module.exports = app => {const { STRING, INTEGER } = app.Sequelize;return app.model.define('user', {name: STRING,age: INTEGER,});
};// 查询
const user = await ctx.model.User.findOne({ where: { id: 1 } });

2. Redis

// 存储
await app.redis.set('key', 'value');// 读取
const value = await app.redis.get('key');

五、安全与优化

1. 安全机制

功能	说明
CSRF 防护	默认开启（需 `ctx.csrf` 获取 token）
XSS 过滤	内置 `egg-security` 中间件
SQL 注入防护	ORM 自动转义
HTTPS 支持	配置 `config.prod.js`

2. 性能优化

优化点	方法
多进程	基于 `cluster` 自动管理
缓存	Redis + 内存缓存
日志切割	`egg-logrotator`
静态资源 CDN	配置 `config.static`

六、测试与部署

1. 单元测试

// test/controller/user.test.js
const { app, mock } = require('egg-mock');describe('GET /user/:id', () => {it('should return user info', () => {return app.httpRequest().get('/user/1').expect(200);});
});

2. 部署方式

方式	说明
PM2	`pm2 start npm -- start`
Docker	官方提供 `egg-docker`
Serverless	阿里云 FC / AWS Lambda

七、总结对比（Express vs Koa vs Egg vs NestJS）

特性	Express	Koa	Egg	NestJS
定位	轻量级	更现代的 Koa	企业级	全栈框架
中间件模型	线性	洋葱圈	增强版 Koa	模块化 + DI
适合场景	小型 API	轻量级应用	中大型应用	复杂后端