用于生产和开发的 Express 错误处理中间件

Question

我正在尝试将生产错误日志设为默认值，并仅在 environment variable 为 development 时向用户显示其他内容。我正在尝试通过以下方式执行此操作，但我收到一条消息说Cannot set headers after they are sent to the client。

    const ErrorClass = require('../routes/utils/ErrorClass');

const prodDBCastError = err => {
    const message = `Invalid ${err.path}: ${err.value}`;
    return new ErrorClass(message, 400);
};

const prodDBDuplicateFieldsError = err => {
    const value = err.errmsg.match(/(["'])(\\?.)*?\1/)[0];

    const message = `Duplicate field value: ${value}.`;
    return new ErrorClass(message, 400);
};

const prodDBDValidationError = err => {
    const errors = Object.values(err.errors).map(el => el.message);

    const message = `Invalid input data. ${errors.join('. ')}`;
    return new ErrorClass(message, 400);
};

const handleBadRequestDB = err => {
    const errors = err.message;
    const message = `Fixes: ${errors}`;
    return new ErrorClass(message, 400);
};

const sendProdError = (err, res) => {
    if (err.isOperationalError){
        res.status(err.status).json({
            status: err.status,
            message: err.message,
        });
    } else {
        res.status(500).json({
            status: 'error',
            message: 'Server Issue.',
        });
    }
};

const sendVerboseDevError = (err, res) => {

    logger.error(err);
    err.status = err.status || 500;
    res.status(err.status).json({
        status: err.status,
        name: err.name,
        path: err.path,
        errors: err.errors,
        message: err.message,
        stack: err.stack,
    });
};

module.exports = (err, req, res, next) => {

    if (process.env.APP_ENV === 'development'){
        sendVerboseDevError(err, res);
    }
    if (err.name === 'CastError') {err = prodDBCastError(err);}
    if (err.name === 'MongoError') {err = prodDBDuplicateFieldsError(err);}
    if (err.name === 'ValidationError') {err = prodDBDValidationError(err);}
    if (err.name === 'Bad Request') {err = handleBadRequestDB(err);}

    sendProdError(err, res);
};

这就是我的 ErrorClass 的样子：

class ErrorClass extends Error {
    constructor(message, status) {
        super(message);

        this.status = status;
        this.isOperationalError = true;

        Error.captureStackTrace(this, this.constructor);
    }
}
module.exports = ErrorClass;

Answer 1

我建议您像这样更改您的代码。

首先，您避免多次调用res.json，并且您只检查应用程序是否在开发模式下运行一次。无需对每个请求进行检查。

var devHandler = (err, req, res, next) => {
    logger.error(err);
    err.status = err.status || 500;
    res.status(err.status).json({
        status: err.status,
        name: err.name,
        path: err.path,
        errors: err.errors,
        message: err.message,
        stack: err.stack,
    });
};

var prodHandler = (err, req, res, next) => {
    
    if (err.name === 'CastError') {err = prodDBCastError(err);}
    if (err.name === 'MongoError') {err = prodDBDuplicateFieldsError(err);}
    if (err.name === 'ValidationError') {err = prodDBDValidationError(err);}
    if (err.name === 'Bad Request') {err = handleBadRequestDB(err);}

    if (err.isOperationalError){
        res.status(err.status).json({
            status: err.status,
            message: err.message,
        });
    } else {
        res.status(500).json({
            status: 'error',
            message: 'Server Issue.',
        });
    }
};

module.exports = process.env.APP_ENV === 'development' ? devHandler : prodHandler;

Answer 2

这是因为您在从 sendVerboseDevError 发送数据后尝试从 sendProdError 发送数据。 res.json 正在向客户端发送 json。

这里解释了这背后的原因https://stackoverflow.com/a/7086621/2232902

Express 中的 res 对象是 Node.js 的子类 http.ServerResponse（阅读 http.js 源代码）。你可以打电话 res.setHeader(name, value) 任意次数，直到您调用 res.writeHead（状态码）。在 writeHead 之后，headers 被烘焙进去 而且只能调用res.write(data)，最后调用res.end(data)

我建议您将sendProdError 和sendVerboseDevError 修改为constructProdError 和constructVerboseDevError，然后从代码中的同一点发送。

参考：https://stackoverflow.com/a/733858/2232902

Answer 3

我认为这里的问题在于多个 if 条件。 如果第一个条件为真，则将执行“sendVerboseDevError”函数。 其中有以下代码

res.status(err.status).json({
    status: err.status,
    name: err.name,
    path: err.path,
    errors: err.errors,
    message: err.message,
    stack: err.stack,
});

在这个函数之后，响应头将被设置。 然后，如果条件为真，则流程进入其余的 if 条件，然后再次调用某个其他函数，该函数试图再次设置响应。 这就是为什么您收到错误“在将标头发送到客户端后无法设置标头”的原因 设置响应后，您需要调用“next()”方法。 所以你应该在每个 if 条件的底部添加“next()”方法。

类似

    module.exports = (err, req, res, next) => {

    if (process.env.APP_ENV === 'development'){
        sendVerboseDevError(err, res);
        next();
    }
    if (err.name === 'CastError') {
        err = prodDBCastError(err);
        next();
    }
    if (err.name === 'MongoError') {
        err = prodDBDuplicateFieldsError(err);
        next();
    }
    if (err.name === 'ValidationError') {
        err = prodDBDValidationError(err);
        next();
    }
    if (err.name === 'Bad Request') {
        err = handleBadRequestDB(err);
        next();
    }

    sendProdError(err, res);
    next();
};

下一个函数将终止 API 调用并返回响应，并防止它在响应由当前执行的任何函数设置后再次设置响应。

P.S: 你也可以调用“res.end()”而不是“next()”函数。