乐趣区

ThinkPHP5接口异常处理

想必不少小伙伴都遇到过在使用接口开发的时候有时候一个变量、方法或者控制器不存在访问的时候就会出现如下错误提示

对于接口开发来说这样是不友好的,有时还会使前端页面直接崩溃。我们可以单独写一个异常类来处理接口下关的异步处理
1、在 application/common/lib 下创建一个 exception 文件夹再在里面创建一个 API 接口异步处理文件 ApiHandleException.php(如果没有 common、lib 相关目录自行创建)

<?php
namespace app\common\lib\exception;

use think\Exception;
use think\config;
use think\exception\Handle;

/**
 * 自定义异常类
 */
class ApiHandleException extends Handle
{
    // http 状态码
    public $httpCode = 500;

    public function render(\Exception $e)
    {
        // 配置文件中设置 app_debug 如果为 true 则原样输出,false 以 json 格式输出
        $debug_status = config("app_debug");
        if ($debug_status) {return parent::render($e);
        } else {return show(2, $e->getMessage(), [], $this->httpCode);
        }
    }

}

引入系统异步处理相关文件 Handle 在 thinkphplibrarythinkexception 下

这里 show 是我在 applicationcommon.php 中创建的一个方法代码如下

/**
 * 通用 API 接口数据输出
 * @param int $status 1 成功 2 失败
 * @param string $message 信息提示
 * @param array $data 数据
 * @param int $httpCode http 状态码
 * @return \think\response\Json
 */
function show($status, $message ,$data = [] ,$httpCode = 200)
{
    $data =  [
        'status' => $status,
        'message' => $message,
        'data' => $data
    ];

    return json($data, $httpCode);

}

2、修改配置文件直接在相应的模块儿下创建相关的配置文件目录及文件,然后引入刚才我们自定义的文件异步处理类

<?php
return [
    'exception_handle' => '\app\common\lib\exception\ApiHandleException',
    'app_debug' => false,
];

3、单独创建一个 Demo 控制器测试

<?php

namespace app\index\controller;

use think\Controller;
use think\Response;
class Demo extends Controller
{public function index()
    {echo $abc;}
}

再次访问效果如下

退出移动版