refactor: 规范Expection处理

2026-04-27 22:40:38 +08:00 · 2023-12-04 20:40:49 +08:00
parent aa0fe64afe
commit 0ab7dee52d
65 changed files with 625 additions and 362 deletions
@@ -0,0 +1,104 @@
+<?php
+
+namespace App\Helpers;
+
+use App\Helpers\ResponseEnum;
+use App\Exceptions\BusinessException;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Collection;
+
+trait ApiResponse
+{
+    /**
+     * 成功
+     * @param mixed $data
+     * @param array $codeResponse
+     * @return JsonResponse
+     */
+    public function success($data = null, $codeResponse=ResponseEnum::HTTP_OK): JsonResponse
+    {
+        return $this->jsonResponse('success', $codeResponse, $data, null);
+    }
+
+    /**
+     * 失败
+     * @param array $codeResponse
+     * @param mixed $data
+     * @param mixed $error
+     * @return JsonResponse
+     */
+    public function fail($codeResponse=ResponseEnum::HTTP_ERROR, $data = null, $error=null): JsonResponse
+    {
+        return $this->jsonResponse('fail', $codeResponse, $data, $error);
+    }
+
+    /**
+     * json响应
+     * @param $status
+     * @param $codeResponse
+     * @param $data
+     * @param $error
+     * @return JsonResponse
+     */
+    private function jsonResponse($status, $codeResponse, $data, $error): JsonResponse
+    {
+        list($code, $message) = $codeResponse;
+        return response()
+            ->json([
+            'status'  => $status,
+            'code'    => $code,
+            'message' => $message,
+            'data'    => $data ?? null,
+            'error'  => $error,
+            ],(int)substr(((string) $code),0,3));
+    }
+
+    /**
+     * 成功分页返回
+     * @param $page
+     * @return JsonResponse
+     */
+    protected function successPaginate($page): JsonResponse
+    {
+        return $this->success($this->paginate($page));
+    }
+
+    private function paginate($page)
+    {
+        if ($page instanceof LengthAwarePaginator){
+            return [
+                'total'  => $page->total(),
+                'page'   => $page->currentPage(),
+                'limit'  => $page->perPage(),
+                'pages'  => $page->lastPage(),
+                'list'   => $page->items()
+            ];
+        }
+        if ($page instanceof Collection){
+            $page = $page->toArray();
+        }
+        if (!is_array($page) && !is_object($page)){
+            return $page;
+        }
+        $total = count($page);
+        return [
+            'total'  => $total, //数据总数
+            'page'   => 1, // 当前页码
+            'limit'  => $total, // 每页的数据条数
+            'pages'  => 1, // 最后一页的页码
+            'list'   => $page // 数据
+        ];
+    }
+
+    /**
+     * 业务异常返回
+     * @param array $codeResponse
+     * @param string $info
+     * @throws BusinessException
+     */
+    public function throwBusinessException(array $codeResponse=ResponseEnum::HTTP_ERROR, string $info = '')
+    {
+        throw new BusinessException($codeResponse, $info);
+    }
+}
@@ -0,0 +1,81 @@
+<?php
+
+namespace App\Helpers;
+
+class ResponseEnum
+{
+    // 001 ~ 099 表示系统状态；100 ~ 199 表示授权业务；200 ~ 299 表示用户业务
+
+    /*-------------------------------------------------------------------------------------------*/
+    // 100开头的表示 信息提示，这类状态表示临时的响应
+    // 100 - 继续
+    // 101 - 切换协议
+
+    /*-------------------------------------------------------------------------------------------*/
+    // 200表示服务器成功地接受了客户端请求
+    const HTTP_OK = [200001, '操作成功'];
+    const HTTP_ERROR = [200002, '操作失败'];
+    const HTTP_ACTION_COUNT_ERROR = [200302, '操作频繁'];
+    const USER_SERVICE_LOGIN_SUCCESS = [200200, '登录成功'];
+    const USER_SERVICE_LOGIN_ERROR = [200201, '登录失败'];
+    const USER_SERVICE_LOGOUT_SUCCESS = [200202, '退出登录成功'];
+    const USER_SERVICE_LOGOUT_ERROR = [200203, '退出登录失败'];
+    const USER_SERVICE_REGISTER_SUCCESS = [200104, '注册成功'];
+    const USER_SERVICE_REGISTER_ERROR = [200105, '注册失败'];
+    const USER_ACCOUNT_REGISTERED = [23001, '账号已注册'];
+
+    /*-------------------------------------------------------------------------------------------*/
+    // 300开头的表示服务器重定向,指向的别的地方，客户端浏览器必须采取更多操作来实现请求
+    // 302 - 对象已移动。
+    // 304 - 未修改。
+    // 307 - 临时重定向。
+
+    /*-------------------------------------------------------------------------------------------*/
+    // 400开头的表示客户端错误请求错误，请求不到数据，或者找不到等等
+    // 400 - 错误的请求
+    const CLIENT_NOT_FOUND_HTTP_ERROR = [400001, '请求失败'];
+    const CLIENT_PARAMETER_ERROR = [400200, '参数错误'];
+    const CLIENT_CREATED_ERROR = [400201, '数据已存在'];
+    const CLIENT_DELETED_ERROR = [400202, '数据不存在'];
+    // 401 - 访问被拒绝
+    const CLIENT_HTTP_UNAUTHORIZED = [401001, '授权失败，请先登录'];
+    const CLIENT_HTTP_UNAUTHORIZED_EXPIRED = [401200, '账号信息已过期，请重新登录'];
+    const CLIENT_HTTP_UNAUTHORIZED_BLACKLISTED = [401201, '账号在其他设备登录，请重新登录'];
+    // 403 - 禁止访问
+    // 404 - 没有找到文件或目录
+    const CLIENT_NOT_FOUND_ERROR = [404001, '没有找到该页面'];
+    // 405 - 用来访问本页面的 HTTP 谓词不被允许（方法不被允许）
+    const CLIENT_METHOD_HTTP_TYPE_ERROR = [405001, 'HTTP请求类型错误'];
+    // 406 - 客户端浏览器不接受所请求页面的 MIME 类型
+    // 407 - 要求进行代理身份验证
+    // 412 - 前提条件失败
+    // 413 – 请求实体太大
+    // 414 - 请求 URI 太长
+    // 415 – 不支持的媒体类型
+    // 416 – 所请求的范围无法满足
+    // 417 – 执行失败
+    // 423 – 锁定的错误
+
+    /*-------------------------------------------------------------------------------------------*/
+    // 500开头的表示服务器错误，服务器因为代码，或者什么原因终止运行
+    // 服务端操作错误码：500 ~ 599 开头，后拼接 3 位
+    // 500 - 内部服务器错误
+    const SYSTEM_ERROR = [500001, '服务器错误'];
+    const SYSTEM_UNAVAILABLE = [500002, '服务器正在维护，暂不可用'];
+    const SYSTEM_CACHE_CONFIG_ERROR = [500003, '缓存配置错误'];
+    const SYSTEM_CACHE_MISSED_ERROR = [500004, '缓存未命中'];
+    const SYSTEM_CONFIG_ERROR = [500005, '系统配置错误'];
+
+    // 业务操作错误码（外部服务或内部服务调用）
+    const SERVICE_REGISTER_ERROR = [500101, '注册失败'];
+    const SERVICE_LOGIN_ERROR = [500102, '登录失败'];
+    const SERVICE_LOGIN_ACCOUNT_ERROR = [500103, '账号或密码错误'];
+    const SERVICE_USER_INTEGRAL_ERROR = [500200, '积分不足'];
+
+    //501 - 页眉值指定了未实现的配置
+    //502 - Web 服务器用作网关或代理服务器时收到了无效响应
+    //503 - 服务不可用。这个错误代码为 IIS 6.0 所专用
+    //504 - 网关超时
+    //505 - HTTP 版本不受支持
+    /*-------------------------------------------------------------------------------------------*/
+}