tp5 API 自定义全局异常处理(中)
我们先来梳理一下异常的分类:
异常分类
tp5 有一个全局异常处理类,如果我们想自己实现上面的分类,需要覆盖和重写默认的全局异常处理类。
我们现在在 api 模块的同级下新建一个 lib 文件夹,再新建一个 exception 文件夹。
(我们想让这个 exception 里的类是一个通用的,可以供很多模块使用的一个类库。)
新建 ExceptionHandler 的 php class,并继承 Handle 类。
<?php
namespace app\lib\exception;
use think\exception\Handle;
class ExceptionHandler extends Handle {
public function render(Exception $e){ // 重写render方法
return json('~~~~~~~~~');
}
}
我们现在来验证一下是否会通过我们重写的 ExceptionHandler 的 render 方法中的格式呈现异常。
在此之前,我们先去掉(上)篇中的控制器自己处理的过程,将控制器还原为:
public function getBanner($id){
(new IDMustBePositiveInt())->goCheck();
$banner = BannerModel::getBannerByID($id);
return $banner;
}
并且重新指定 tp5 的全局异常处理类:
在 config.php 文件中的 'exception_handle'
字段输入我们自定义的处理器的命名空间:
app\lib\exception\ExceptionHandler
用 postman 运行后就可以看到 render 返回的值了。
现在我们继续来写 render 方法来区分前面提到的两种异常:
其中有一种异常需要向客户端返回具体信息,我们需要新建一个 BaseException 类:
<?php
namespace app\lib\exception;
class BaseException {
public $code = 400; // HTTP 状态码 404,200...
public $msg = '参数错误'; // 错误信息具体
public $errorCode = 10000; // 自定义错误码
}
这里的我们可以随便写,因为子类错误会将其覆盖。
我们新建一个 BannerMissException 的 php 类,继承 BaseException。
比如说:
<?php
namespace app\lib\exception;
class BannerMissException extends BaseException
{
public $code = 404;
public $msg = '请求Banner不存在';
public $errorCode = 40000;
}
所以只要是继承于 BaseException 的异常类都是我们自定义的类,且需要返回给客户端信息。
我们这样修改 render 方法:
private $code;
private $msg;
private $errorCode;
// 还需要返回客户端当前请求的URL地址
public function render(Exception $e){
if($e instanceof BaseException){
$this->code = $e->code;
$this->msg = $e->msg;
$this->errorCode = $e->errorCode;
} else {
$this->code = 500;
$this->msg = '服务器内部异常';
$this->errorCode = 999;
}
$request = Request::instance();
$result=[
'msg' => $this->msg,
'error_code' => $this->errorCode,
'request_url' => $request->url()
];
return json($result,$this->code);
}
我们现在运行后就会发现:
不会报出 Division by 0 错误
我们下面来测试一下 BannerMissException,
将 model\Banner 中的 1/0 注释掉,改为:
class Banner
{
public static function getBannerByID($id)
{
return null;
}
}
然后控制器里检测一下拿到的 $banner
是否为空,因为 RESTFull 规则中规定获取的值为空也是一种获取不到资源的异常,所以我们如下编辑控制器的代码:
class Banner
{
public function getBanner($id)
{
(new IDMustBePositiveInt())->goCheck();
$banner = BannerModule::getBannerByID($id);
if (!$banner) {
throw new BannerMissException();
}
return $banner;
}
}
查看返回结果:
返回结果
现在,我们记录日志的要求还没有实现,请看下一篇。
tp5 API 自定义全局异常处理(下)