在开发 RESTful API 时，我们往往需要对请求的错误进行处理并返回相应的错误信息及状态码。默认情况下，Node.js Express 框架会自动处理一些常见的错误，如 404 页面找不到、500 服务器错误等，但是这些错误信息往往不够具体，无法提供给开发人员或使用者详细的错误信息以便排查问题。因此，本文将介绍如何自定义 RESTful API 返回的错误信息及状态码。
错误处理中间件
错误处理中间件是一种在请求处理已经结束后，但是出现错误时被调用的方法。当 Express 应用程序中的代码抛出错误时，Express 会将错误信息传递给在堆栈中的第一个错误处理中间件。通过自定义错误处理中间件，我们可以指定自己的错误处理方式，例如定义自己的错误信息以及错误状态码。
以下是一个简单的错误处理中间件的示例代码：
app.use(function(err, req, res, next) {
console.error(err.stack);
res.status(500).send('错误 500: 服务器发生错误！');
});这个错误处理中间件会在发生错误时打印错误堆栈信息并返回状态码为 500 的错误信息。
自定义错误信息及状态码
我们可以通过自定义错误处理中间件来定义自己的错误信息及状态码，并根据请求类型、错误类型来返回不同的错误信息。
以下是一个根据不同请求类型返回不同状态码及错误信息的示例代码：
-- -------------------- ---- -------
--------------------- ---- ---- ----- -
-- --------- -
---------------------- ------- --------- ---
- ---- -
----------
-
---
------------ ------------- ---- -
-- ---------------- -
------------------------ ---- -----------
- ---- -
------------------------------
-
---对于 XMLHTTP 请求类型的请求，我们返回一个 JSON 格式的错误信息及状态码；对于其他类型的请求，我们调用 next() 方法将错误交由 Express 自带的错误处理中间件进行处理。
根据错误类型来返回不同的错误信息也是很重要的，以下是一个示例代码：
-- -------------------- ---- -------
--------------------- ---- ---- ----- -
------ ---------- -
---- ------------
------------------------ ---- -----------
------
---- ------------------
------------------------ ---- ----------
------
--------
------------------------ ---- -----------
-
---
--------------- ------------- ---- -
-- ---------------------- -
----- --- -------------------
- ---- -- ---------------- -
----- --- -------------------------
- ---- -
------------------------------
-
---在上面的示例代码中，我们根据错误类型来返回相应的错误信息及状态码。如果请求参数中的 ID 不为数字，则抛出 CastError 错误；如果请求参数验证失败，例如缺少必填参数，则抛出 ValidationError 错误。
结论
自定义 RESTful API 返回的错误信息及状态码可以帮助我们更好地分析代码中的错误，并提供详细的错误信息给开发人员或使用者。使用错误处理中间件可以轻松地自定义错误信息及状态码，同时我们还可以根据请求类型、错误类型来返回不同的错误信息。希望这篇文章能够帮助你更好地理解如何进行自定义 RESTful API 错误处理。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67524cd78bd460d3ad929fec