nodejs + express 接口统一返回错误信息

多年以后_2024-05-13 17:54

API对接平台一键对接ChatGPT3.5/4.0，Claude3，文心一言等AI模型，无需翻墙，国外信用卡👉AI模型聚合API-海鲸AI

在Node.js和Express框架中，你可以通过中间件（middleware）来统一处理错误。通常，你会在所有路由处理器之后添加一个错误处理中间件，这样任何从路由中抛出的错误都会被这个中间件捕获并处理。

以下是一个简单的示例，展示了如何在Express应用中统一处理错误：

定义一个错误处理中间件：

javascript 复制代码

// 错误处理中间件应该有四个参数：错误对象、请求对象、响应对象和next函数
app.use((err, req, res, next) => {
  console.error(err.stack); // 打印错误堆栈信息（仅用于开发环境）

  // 设置响应状态码
  res.status(err.status || 500);

  // 发送错误响应
  res.json({
    error: {
      message: err.message || '发生了一个错误。'
    }
  });
});

在路由中抛出错误：

在你的路由处理器中，如果遇到错误情况，你可以抛出错误：

javascript 复制代码

app.get('/some-route', (req, res, next) => {
  try {
    // ... 你的逻辑代码 ...
    if (someErrorCondition) {
      throw new Error('这里有一个错误');
    }
    res.send('正常响应');
  } catch (error) {
    // 传递错误到下一个中间件（即错误处理中间件）
    next(error);
  }
});

或者，如果你的路由处理器是异步的，你可以使用async/await并将错误传递给next()：

javascript 复制代码

app.get('/some-route', async (req, res, next) => {
  try {
    // ... 你的逻辑代码 ...
  } catch (error) {
    // 传递错误到下一个中间件（即错误处理中间件）
    next(error);
  }
});

如果你使用的是异步中间件（比如数据库操作），你可能需要一个额外的包如express-async-handler来自动传递异步代码中的错误到错误处理中间件。

确保错误处理中间件是最后添加的中间件：

错误处理中间件应该在所有其他app.use()和路由调用之后添加，这样它才能捕获整个应用中发生的任何错误。

javascript 复制代码

// 其他路由和中间件
// ...

// 最后添加错误处理中间件
app.use((err, req, res, next) => {
  // 错误处理逻辑
});

通过这种方式，你可以确保应用中的任何错误都会以一致的格式返回给客户端。记得在生产环境中不要泄露敏感的错误堆栈信息。