Egg.js重构Controller最佳实践：自定义核心组件与架构优化指南

Egg.js重构Controller最佳实践自定义核心组件与架构优化指南【免费下载链接】examplesStore all egg examples in one place项目地址: https://gitcode.com/gh_mirrors/examples109/examplesEgg.js作为企业级Node.js框架其Controller层是业务逻辑的核心入口。本文将为你揭秘如何通过重构Controller实现架构优化提升代码可维护性和开发效率。无论你是Egg.js新手还是经验丰富的开发者这些最佳实践都能帮助你构建更健壮的应用程序。 为什么需要重构Controller在Egg.js项目中Controller负责处理HTTP请求、参数验证、业务逻辑调度和响应返回。随着项目规模扩大原始的Controller代码往往会出现以下问题代码重复每个Controller都需要重复编写参数验证、错误处理等通用逻辑职责不清业务逻辑、数据验证、错误处理混杂在一起维护困难缺乏统一的错误处理机制和响应格式测试复杂耦合度过高导致单元测试难以编写️ 自定义核心Controller组件1. 创建基础Controller类通过继承Egg.js原生Controller我们可以创建自定义的基础Controller类统一处理通用逻辑。在redefine-controller/app/core/controller.js中我们可以看到优雅的实现class CustomController extends Controller { success(result) { this.ctx.body { success: true, result, }; } fail(message) { this.ctx.body { success: false, message, }; } }2. 统一的响应格式自定义Controller提供了标准化的响应方法确保整个应用使用一致的API响应格式success()成功响应自动包装数据fail()失败响应统一错误格式3. 参数验证集成在cnode-api/app/controller/topics.js中我们可以看到参数验证的最佳实践class TopicsController extends Controller { constructor(ctx) { super(ctx); this.createRule { accesstoken: string, title: string, tab: { type: enum, values: [ask, share, job], required: false }, content: string, }; } async create() { const { ctx } this; ctx.validate(this.createRule); // 统一的参数验证 // 业务逻辑... } } 架构优化的四大策略策略一服务层解耦Controller应该专注于HTTP层逻辑将业务逻辑委托给Service层。在hackernews-async-ts-di/app/controller/news.ts中我们可以看到清晰的职责分离export default class NewsController extends Controller { inject() private readonly hackerNews: HackerNews; public async list() { const { ctx, app } this; const pageSize app.config.news.pageSize; const page parseInt(ctx.query.page, 10) || 1; const idList await this.hackerNews.getTopStories(page); const newsList await Promise.all(idList.map((id) this.hackerNews.getItem(id) )); await ctx.render(news/list.tpl, { list: newsList, page, pageSize }); } }策略二中间件优化通过中间件处理通用逻辑如身份验证、日志记录、性能监控等// 在config/config.default.js中配置 config.middleware [errorHandler, auth]; // 自定义错误处理中间件 app.middleware.errorHandler require(./app/middleware/error_handler);策略三TypeScript支持TypeScript提供了更好的类型安全和开发体验。Egg.js完美支持TypeScript让你的Controller更加健壮import { Controller } from egg; import { inject } from egg-di; import { HackerNews } from ../service/HackerNews; export default class NewsController extends Controller { inject() private readonly hackerNews: HackerNews; // 类型安全的参数和返回值 public async detail(): Promisevoid { const { ctx } this; const id ctx.params.id; const newsInfo await this.hackerNews.getItem(id); // ... } }策略四依赖注入使用依赖注入管理Service依赖提高代码的可测试性和可维护性inject() private readonly hackerNews: HackerNews; Controller重构前后对比重构前重构后每个Controller重复验证逻辑统一的基础Controller处理通用逻辑响应格式不一致标准化的success/fail方法业务逻辑与HTTP层耦合清晰的Service层分离错误处理分散各处统一的错误处理机制难以进行单元测试依赖注入支持轻松测试️ 实践步骤5分钟完成Controller重构步骤1创建基础Controller在app/core/目录下创建base.controller.js或base.controller.ts// app/core/base.controller.js const { Controller } require(egg); class BaseController extends Controller { success(data, message 操作成功) { this.ctx.body { code: 200, success: true, message, data, timestamp: Date.now(), }; } fail(message 操作失败, code 500) { this.ctx.body { code, success: false, message, data: null, timestamp: Date.now(), }; this.ctx.status code; } validate(rules, data) { return this.ctx.validate(rules, data); } } module.exports BaseController;步骤2重构现有Controller将现有Controller继承自BaseController// app/controller/user.js const BaseController require(../core/base.controller); class UserController extends BaseController { async getUserInfo() { try { const user await this.service.user.getUserInfo(); this.success(user); } catch (error) { this.fail(error.message); } } }步骤3配置TypeScript类型可选如果你使用TypeScript添加类型定义// app/controller/index.d.ts import UserController from ./user; declare module egg { export interface IController { user: UserController; } } 可视化架构优化效果图重构后的Controller架构更加清晰职责分离明确 常见问题与解决方案Q1如何处理复杂的业务验证解决方案创建专门的Validator类或使用Egg.js内置的validate方法class UserController extends BaseController { async create() { const rules { username: { type: string, min: 3, max: 20 }, email: { type: email }, password: { type: string, format: /^[A-Za-z0-9]{6,20}$/ }, }; this.validate(rules, this.ctx.request.body); // 业务逻辑... } }Q2如何统一处理异常解决方案使用中间件或装饰器模式// 错误处理中间件 module.exports () { return async function errorHandler(ctx, next) { try { await next(); } catch (err) { ctx.logger.error(err); ctx.body { code: err.status || 500, message: err.message, }; } }; };Q3如何提高Controller的可测试性解决方案依赖注入和Mock测试// 测试示例 const mockContext { service: { user: { getUserInfo: () Promise.resolve({ id: 1, name: test }) } } }; const controller new UserController(mockContext); await controller.getUserInfo(); 性能优化建议缓存策略合理使用缓存减少数据库查询异步处理使用async/await避免回调地狱批量操作合并数据库操作减少IO次数内存管理及时释放不再使用的资源 总结通过自定义核心Controller组件和架构优化你可以显著提升Egg.js项目的可维护性、可测试性和开发效率。关键要点包括✅创建统一的基础Controller处理通用逻辑✅使用Service层分离业务逻辑✅采用TypeScript增强类型安全✅实现依赖注入提高可测试性✅统一错误处理和响应格式这些最佳实践已经在多个Egg.js示例项目中得到验证包括cnode-api、hackernews-async-ts-di和redefine-controller等。立即开始重构你的Controller享受更优雅的代码架构带来的开发体验提升吧【免费下载链接】examplesStore all egg examples in one place项目地址: https://gitcode.com/gh_mirrors/examples109/examples创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考