FoalTS 错误处理机制：构建健壮的后端应用

FoalTS 错误处理机制：构建健壮的后端应用

【免费下载链接】foalFull-featured Node.js framework 🚀项目地址: https://gitcode.com/gh_mirrors/fo/foal

FoalTS 是一个功能全面的 Node.js 框架，提供了强大的错误处理机制，帮助开发者构建健壮的后端应用。在开发过程中，有效的错误处理能够提升应用的可靠性和用户体验，本文将详细介绍 FoalTS 的错误处理机制及最佳实践。

默认错误处理配置

当使用 Foal 创建新项目时，错误处理机制已经预先配置完成。当控制器或钩子中抛出错误或拒绝 promise 时，应用会返回一个状态码为500的Internal Server ErrorHTML 页面。在开发或测试环境中，若配置参数settings.debug设置为true，错误页面会包含错误名称、消息、堆栈跟踪等详细信息，便于开发者快速定位问题。

自定义错误处理器

在某些场景下，我们可能需要覆盖默认的错误处理行为，例如将错误发送到外部服务、自定义错误页面或返回 JSON 格式的错误描述。通过在AppController类中添加handleError方法，可以实现自定义错误处理逻辑。

错误报告

以下示例展示了如何在错误处理过程中调用外部服务报告错误，并使用默认的renderError方法生成错误响应：

import { Context, Get, HttpResponse, IAppController, renderError } from '@foal/core'; export class AppController implements IAppController { @Get('/') index() { throw new Error('Hello world'); } handleError(error: Error, ctx: Context): HttpResponse|Promise<HttpResponse> { sendErrorToAnExternalService(error); return renderError(error, ctx); } }

如需禁用错误日志记录，可将配置值settings.logErrors设置为false。

返回 JSON 格式错误

对于 API 应用，通常需要返回 JSON 格式的错误信息。以下示例演示了如何自定义错误响应，返回包含错误详情的 JSON 对象：

import { Context, Get, HttpResponse, HttpResponseInternalServerError, IAppController } from '@foal/core'; export class AppController implements IAppController { @Get('/') index() { throw new Error('Hello world'); } handleError(error: Error, ctx: Context): HttpResponse|Promise<HttpResponse> { return new HttpResponseInternalServerError({ err: error.message, message: 'An error occured.', path: ctx.request.path, }); } }

将错误转换为 4xx 响应

通过判断错误类型，可以将特定错误转换为对应的 4xx 状态码响应。例如，将PermissionDenied错误转换为403 Forbidden响应：

import { Context, Get, HttpResponse, HttpResponseForbidden, IAppController, renderError } from '@foal/core'; class PermissionDenied extends Error {} export class AppController implements IAppController { @Get('/') index() { throw new PermissionDenied(); } handleError(error: Error, ctx: Context): HttpResponse|Promise<HttpResponse> { if (error instanceof PermissionDenied) { return new HttpResponseForbidden(); } return renderError(error, ctx); } }

钩子后置函数中的错误处理

当钩子或控制器方法中抛出错误时，框架会自动将其转换为HttpResponseInternalServerError或自定义的响应对象。在使用钩子后置函数时，可能需要检查是否发生错误后再执行后续逻辑：

@Hook(() => response => { if (isHttpResponseInternalServerError(response)) { return; } // 执行正常逻辑 })

使用默认错误处理器时，生成的HttpResponseInternalServerError包含error和ctx两个额外属性，可用于获取错误详情和请求上下文。

总结

FoalTS 提供了灵活且强大的错误处理机制，通过默认配置和自定义扩展，开发者可以轻松实现错误报告、自定义响应格式和错误类型转换等功能。合理利用这些特性，能够显著提升后端应用的健壮性和可维护性。

要开始使用 FoalTS 构建项目，可通过以下命令克隆仓库：

git clone https://gitcode.com/gh_mirrors/fo/foal

更多关于 FoalTS 错误处理的详细信息，请参考官方文档中的 架构/错误处理 部分。

【免费下载链接】foalFull-featured Node.js framework 🚀项目地址: https://gitcode.com/gh_mirrors/fo/foal