RESTful API 的错误处理 ——throw、catch、finally-JavaScript中文网-JavaScript教程资源分享门户

RESTful API 是现代开发中常用的一种 API 架构风格，但是，与其他 API 相比， RESTful API 在处理错误时存在一些独特的问题。本篇文章将探讨如何处理 RESTful API 中的错误，以及如何使用 throw、catch、finally 等关键字来处理这些错误。

错误类型

在 RESTful API 中，错误可以分为两类：客户端错误和服务器错误。

客户端错误指由客户端引起的错误。比如，请求中包含了错误的参数，或者客户端试图访问不存在的资源等。

服务器错误指由服务器引起的错误。比如，服务器无法正常处理请求，或者发生了内部错误等。

错误处理方式

在 RESTful API 中，错误可以采用多种方式进行处理：

错误码返回

该方式将错误信息表示为数值，客户端需要根据错误码进行解析，比较常见的方案是 HTTP 状态码。

HTTP/1.1 400 Bad Request
Content-Type: application/json
{
  "errorCode": 400,
  "message": "Bad Request",
  "description": "Invalid request format"
}

异常抛出

使用 throw 抛出异常，相较于错误码返回方式，不仅可以得到简洁明了的错误描述信息，此方式在处理错误时更加方便灵活。

if (!params) {
  throw new Error('Invalid parameter');
}

成功响应 + 错误描述

使用 HTTP 状态码表示请求处理结果，同时在成功响应体中附带错误描述信息:

HTTP/1.1 200 OK
Content-Type: application/json
{
  "code": 0,
  "message": "OK",
  "data": {...}
}

使用以上三种方式都能够正确的处理 API 请求的错误信息，但是在某些场合会出现千奇百怪的异常状况，导致错误无法捕获。此时，finally 关键字则可以解决这个问题。

重要的 finally

finally 关键字在 JavaScript 中的作用很简单，在执行 try 和 catch 中的语句之后必然会执行 finally 中的语句，无论是否发生了异常，finally 中的代码都能保证执行。

try {
  // some code...
} catch (e) {
  // some code...
} finally {
  // always do things...
}

正因如此，finally 关键字往往被用于清理代码，防止出现意外的填充与异常。

下面，我提供一个使用 throw、catch、finally 关键字的完整的错误处理范例。

// javascriptcn.com 代码示例
try {
  // request to backend, throw an exception if fail
  requestToBackend(params)
    .then((response) => {
      if (response && response.code === 0) {
        // success, handle response
        console.log(response.message);
        handleResponse(response.data);
      } else {
        // error, throw new exception
        throw new Error(response.message);
      }
    })
    .catch((e) => {
      console.log(e.message);
      // error handling, show error message
      showError(e.message);
    });
} finally {
  // always hide loading when finish request
  hideLoading();
}

在处理 RESTful API 的错误时，throw、catch、finally 关键字的使用非常重要。除了能够更好地捕获异常，还可以增加异常处理流程的灵活性和可读性。

总结

RESTful API 的错误处理需要针对不同的错误类型选择不同的错误处理方式。只有使用 throw、catch、finally 关键字，才能更好地捕获异常，并增加程序的健壮性和可维护性。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/654734a57d4982a6eb19328e