HyperExpress项目中实现全局错误中间件的实践指南

在Web应用开发中，错误处理是一个至关重要的环节，良好的错误处理机制能够提升应用的健壮性和用户体验。本文将详细介绍如何在HyperExpress框架中实现自定义的全局错误中间件。

HyperExpress错误处理机制概述

HyperExpress提供了set_error_handler方法来设置全局错误处理器，这与Express框架的中间件模式有所不同。HyperExpress的错误处理器需要接收三个参数：Request对象、Response对象和Error对象。

实现自定义错误处理器

以下是一个完整的自定义错误处理器实现示例：

import { Request, Response } from "hyper-express";
import HttpException from "../models/http-exception.model";
import { ZodError } from "zod";
import logger from "../helpers/logger";

export function errorMiddleware(request: Request, response: Response, error: Error) {
    let status = 500;
    if (error instanceof HttpException) {
      status = error.status;
    }
    const message = error.message || "Something went wrong.";
  
    let data = undefined;
    if (error instanceof ZodError) {
      data = error.errors;
    }
  
    logger.error(`${status} - ${message} - ${request.originalUrl} - ${request.method} - ${data}: ${error.stack || error.message}`);
  
    response.status(status).json({ message, data });
}

关键实现细节解析

1. 错误类型识别：通过instanceof操作符识别不同类型的错误，如自定义的HttpException和Zod验证错误。

2. 状态码处理：默认使用500状态码，针对已知错误类型可以覆盖为特定状态码。

3. 错误日志记录：记录了完整的错误信息，包括状态码、错误消息、请求URL、请求方法等关键信息。

4. 响应格式化：返回结构化的错误响应，包含错误消息和可能的额外数据。

在HyperExpress中注册错误处理器

注册全局错误处理器非常简单：

const HyperExpress = require('hyper-express');
const server = new HyperExpress.Server();

// 注册全局错误处理器
server.set_error_handler(errorMiddleware);

最佳实践建议

1. 错误分类处理：根据业务需求对不同类型的错误进行分类处理，如验证错误、数据库错误、业务逻辑错误等。

2. 敏感信息过滤：在生产环境中，应过滤掉堆栈跟踪等敏感信息，避免泄露系统内部细节。

3. 性能监控集成：可以在错误处理器中集成性能监控工具，实时跟踪系统错误率。

4. 客户端适配：考虑为不同类型的客户端（Web、移动端等）返回适当格式的错误响应。

通过实现这样的全局错误处理器，开发者可以确保应用中的所有错误都能被统一捕获、记录和处理，大大提高了应用的可维护性和用户体验。