20 自定义错误处理器

在上一章中，我们讨论了错误处理的基本概念，包括如何在 Express.js 中捕获和处理错误。本章将深入探讨如何构建自定义错误处理器，以便有效地管理应用程序中的错误。

什么是自定义错误处理器？

在 Express.js 应用程序中，默认的错误处理机制可以捕获错误并在一定程度上处理它们。然而，为了更细致地控制错误的响应，我们需要定义自己的错误处理器。自定义错误处理器可以让我们根据不同的错误类型和状态码返回不同的响应。

错误处理中间件的定义

自定义错误处理器其实是一个特殊的中间件，其函数签名为：

function errorHandler(err, req, res, next) {
  // 错误处理逻辑
}

在这个函数中，err参数代表发生的错误，req和res是请求和响应对象，next是指向下一个中间件函数的引用。要确保这个中间件是在所有其他中间件之后定义，也就是说通常放在路由定义的最后面。

创建一个简单的错误处理器

下面是一个简单的自定义错误处理器示例：

const express = require('express');
const app = express();

// 自定义错误处理器
function errorHandler(err, req, res, next) {
    console.error(err.stack); // 打印错误堆栈到控制台
    res.status(err.status || 500); // 设置响应状态码，默认500
    res.json({
        message: err.message || 'Internal Server Error', // 返回错误消息
    });
}

// 一个模拟的路由，可能会产生错误
app.get('/error', (req, res, next) => {
    const err = new Error('这是一个自定义错误!');
    err.status = 400; // 自定义状态码
    next(err); // 将错误传递到下一个中间件
});

// 使用自定义错误处理器
app.use(errorHandler);

// 启动服务器
app.listen(3000, () => {
    console.log('服务器在 http://localhost:3000 运行');
});

在这个例子中，我们首先定义了一个路由 /error，它会故意抛出一个错误。然后，我们创建了一个数字 400 的状态码，并将其传递给错误处理中间件。自定义错误处理器将捕获错误，并返回一个 JSON 对象，其中包含错误信息和状态码。

捕获不同类型的错误

自定义错误处理器的一个优势是可以根据错误的不同类型进行定制处理。例如，我们可能会希望对不同状态码的错误返回不同的响应格式。

假设我们有一个自定义的错误类：

class NotFoundError extends Error {
    constructor(message) {
        super(message);
        this.status = 404; // 设置状态码
    }
}

class ValidationError extends Error {
    constructor(message) {
        super(message);
        this.status = 400; // 设置状态码
    }
}

我们可以在我们的错误处理器中按照错误类型进行处理：

function errorHandler(err, req, res, next) {
    console.error(err.stack);

    if (err instanceof ValidationError) {
        return res.status(err.status).json({
            error: 'Validation Error',
            message: err.message,
        });
    }

    if (err instanceof NotFoundError) {
        return res.status(err.status).json({
            error: 'Not Found',
            message: err.message,
        });
    }

    // 默认处理
    res.status(err.status || 500);
    res.json({
        message: err.message || 'Internal Server Error',
    });
}

通过自定义错误类提升代码可读性

通过使用自定义错误类，我们可以更清楚地了解不同错误的来源，从而在 errorHandler 中灵活作出响应。这种设计有助于提升代码的可读性和维护性。

小结

本章中，我们探讨了如何创建自定义错误处理器，以便在 Express.js 应用程序中更好地管理和响应错误。通过定义具体的错误类，我们能够针对不同类型的错误采用不同的处理策略，使得代码更加清晰和易于维护。

在下一章中，我们将讨论如何捕获 404 错误并为用户提供适当的响应。这为我们提供了更多的机会来确保用户体验的完整性和一致性。