cool-admin(midway版)后端异常分类：业务异常与系统异常处理

cool-admin(midway版)后端异常分类：业务异常与系统异常处理

【免费下载链接】cool-admin-midway🔥 cool-admin(midway版)一个很酷的后台权限管理框架，模块化、插件化、CRUD极速开发，永久开源免费，基于midway.js 3.x、typescript、typeorm、mysql、jwt、vue3、vite、element-ui等构建项目地址: https://gitcode.com/gh_mirrors/co/cool-admin-midway

在开发基于midway.js的cool-admin框架应用时，异常处理是保证系统稳定性和用户体验的关键环节。本文将深入解析cool-admin(midway版)中的后端异常分类，重点介绍业务异常与系统异常的处理策略，帮助开发者构建更健壮的应用系统。

异常分类基础：业务异常 vs 系统异常

cool-admin(midway版)将后端异常清晰地分为两大类：业务异常和系统异常，它们在处理方式和使用场景上有着本质区别。

业务异常：可预见的业务逻辑错误

业务异常是在应用运行过程中可预见的业务逻辑错误，通常由用户操作不当或业务规则限制引起。在cool-admin中，业务异常通过CoolCommException类来表示，这是框架提供的专用业务异常处理机制。

业务异常的主要特点：

• 与具体业务规则紧密相关
• 通常需要向用户展示明确的错误信息
• 框架会自动将异常信息转换为友好的API响应
• 不会导致应用崩溃

系统异常：不可预见的运行时错误

系统异常则是指应用运行过程中出现的不可预见错误，如数据库连接失败、第三方服务调用超时等。这类异常通常使用JavaScript原生的Error类或其子类来表示。

系统异常的主要特点：

• 与业务逻辑无关，属于底层技术问题
• 通常需要记录详细日志以便排查问题
• 可能导致部分功能不可用或应用崩溃
• 需要全局捕获和统一处理

业务异常处理实践

cool-admin(midway版)提供了CoolCommException类来统一处理业务异常，在项目中有广泛应用。

业务异常的抛出方式

在业务逻辑中，当检测到不符合业务规则的情况时，可以直接抛出CoolCommException异常。例如在用户登录功能中：

// src/modules/base/service/sys/login.ts throw new CoolCommException('账户或密码不正确~');

在用户管理模块中，检测到用户名已存在时：

// src/modules/base/service/sys/user.ts throw new CoolCommException('用户名已经存在~');

业务异常的应用场景

业务异常适用于各种业务规则验证场景，如：

• 用户认证与授权：throw new CoolCommException('登录失效~', 401);
• 数据校验：throw new CoolCommException('验证码不正确');
• 业务规则限制：throw new CoolCommException('发送过于频繁，请稍后再试');
• 资源访问控制：throw new CoolCommException('登录失效或无权限访问~', 401);

业务异常的捕获与处理

cool-admin框架会自动捕获CoolCommException异常，并将其转换为标准的API响应格式。在中间件中可以对业务异常进行统一处理：

// src/modules/base/middleware/translate.ts if (error.name == 'CoolCommException') { // 处理业务异常 }

系统异常处理实践

系统异常通常使用原生Error类抛出，需要通过try-catch语句显式捕获和处理。

系统异常的常见场景

系统异常主要出现在以下场景：

• 数据库操作失败
• 文件读写错误
• 第三方服务调用异常
• 代码逻辑错误

系统异常的捕获方式

在cool-admin中，系统异常通常通过try-catch语句捕获，例如在任务队列处理中：

// src/modules/task/service/bull.ts try { // 可能抛出系统异常的代码 } catch (e) { // 异常处理逻辑 }

文件上传功能中的异常处理：

// src/modules/plugin/hooks/upload/index.ts try { // 文件上传逻辑 } catch (err) { if (err instanceof CoolCommException) { // 业务异常处理 } else { // 系统异常处理 throw new CoolCommException('上传失败: ' + err.message); } }

系统异常的处理策略

处理系统异常时，通常需要：

1. 记录详细的错误日志
2. 尝试恢复或降级处理
3. 返回友好的错误提示
4. 避免敏感信息泄露

异常处理最佳实践

在cool-admin(midway版)开发中，遵循以下异常处理最佳实践可以提高系统的健壮性和可维护性：

精准选择异常类型

根据错误性质选择合适的异常类型：业务规则相关的错误使用CoolCommException，系统级错误使用原生Error或其子类。

异常信息要具体明确

无论是业务异常还是系统异常，错误信息都应该具体明确，便于问题定位。例如：

// 推荐 throw new CoolCommException('验证码错误'); // 不推荐 throw new CoolCommException('操作失败');

统一异常响应格式

cool-admin框架会自动将CoolCommException转换为统一的API响应格式，确保前端能够一致地处理错误信息。

合理使用try-catch

只在可能抛出异常的代码块使用try-catch，避免过度使用try-catch影响代码性能和可读性。

记录异常日志

对于系统异常，务必记录详细的日志信息，包括错误堆栈，以便问题排查。

总结

cool-admin(midway版)通过CoolCommException和原生Error类实现了业务异常与系统异常的清晰分离，为开发者提供了完善的异常处理机制。合理使用这两种异常类型，遵循异常处理最佳实践，能够有效提高应用的稳定性和用户体验。

在实际开发中，应根据具体场景选择合适的异常类型，确保异常信息准确、处理逻辑完善，从而构建出更加健壮、可靠的cool-admin应用系统。

【免费下载链接】cool-admin-midway🔥 cool-admin(midway版)一个很酷的后台权限管理框架，模块化、插件化、CRUD极速开发，永久开源免费，基于midway.js 3.x、typescript、typeorm、mysql、jwt、vue3、vite、element-ui等构建项目地址: https://gitcode.com/gh_mirrors/co/cool-admin-midway