Laravel定制异常处理，将错误以JSON格式返回

在 Laravel 开发中，统一错误处理并将其转换为 JSON 格式对于提高代码的可读性和可维护性至关重要。Laravel 的 `App\Exceptions\AppExceptionHandler` 类是默认的异常处理器，但它可能会导致大量 try...catch 语句，使代码冗余。本文将介绍如何创建自定义的异常类 `ApiException` 和处理程序，以便更有效地处理和返回 JSON 格式的错误信息。 首先，我们需要创建一个名为 `ApiException` 的异常类，继承自 `Illuminate\Foundation\Exceptions\ErrorException`。这个新类中包含以下几个关键部分： 1. 定义错误代码（ERROR_CODE）和默认错误消息（ERROR_MSG），如： ```php const ERROR_CODE = 1001; const ERROR_MSG = 'ApiException'; ``` 2. 构造函数接受错误消息、自定义代码以及可选的数据数组，用于附加额外的信息： ```php public function __construct(string $message = '', string $code = self::ERROR_CODE, array $data = []) { // ... } ``` 在构造函数中，设置默认值，并保存接收到的数据到 `$this->data` 属性。 3. 定义 `getData()` 方法，用于获取异常携带的数据： ```php public function getData() { return $this->data; } ``` 4. `render()` 方法处理异常的具体返回，这里将异常数据包装成 JSON 格式并返回： ```php public function render($request) { return response()->json([ 'data' => $this->getData(), 'code' => $this->getCode(), 'message' => $this->getMessage(), ], 200); } ``` 接下来，我们需要在 `App\Exceptions\Handler` 类中进行更改，以覆盖 Laravel 默认的错误处理流程。在 `report()` 方法或 `render()` 方法中，添加以下代码，告诉 Laravel 使用自定义的异常渲染方法： ```php public function render($request, Exception $exception) { if ($exception instanceof ApiException) { return $exception->render($request); } // 其他默认错误处理逻辑... } ``` 通过这种方式，当遇到 `ApiException` 类型的异常时，Laravel 将调用我们自定义的 `render()` 方法返回 JSON 响应。这样，不仅减少了 try...catch 代码的使用，提高了代码可读性，而且使得错误信息更加结构化，方便前端开发者进行处理和调试。 总结来说，本文介绍了如何在 Laravel 中通过创建自定义异常类 `ApiException` 和调整异常处理器，实现统一的 JSON 错误响应，提升了开发效率和代码质量。