什么是异常
从更加广泛的角度来看,异常包含两个方面,一方面是程序执行时由于语法、运行时错误等导致的异常,一方面时没有给予正确的反馈,如客户端要查询某个产品,没有查询到,我认为这也属于异常的一种。
第一种异常TP框架本身会在页面中输出错误信息,但是第二种异常则一般不会输出任何信息,所以非常不方便调试。
本文将详细介绍关于ThinkPHP异常处理的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧。
前提环境
现在 PHP 在很多时候是为前端提供接口,所以我们的异常处理也基于这一点进行处理。
在开发阶段,TP 原有的异常处理是在页面中输出异常信息,这一点能够满足需求,但在生产环境中,则需要以其他方式处理异常。
本文都是针对生产环境的异常处理
AOP 编程
现在在很多语言中,都非常流行 AOP 编程思想,即面向切面编程思想,通俗的说,就是用统一的方式处理问题,而不是用相同的方式分别处理多个问题,对于异常处理来说,就是定义统一的异常信息,用统一的方式处理
大致思路
自定义异常处理类,重写默认异常处理类的 render 方法,然后配置使用自定义异常处理类处理所有异常
代码实现
在根目录下创建目录 exception,在其下创建ExceptionHandle.php,此类要继承 handle 类
class ExceptionHandler extends Handle
创建几个属性,用于定义异常信息
// http 错误码 private $code; // 自定义异常信息 private $msg; // 自定义错误码 private $errorCode;
覆盖 Handle 类中的render 方法,当我们在代码中使用 throw new Exception() 方式抛出异常信息时,其实就是调用了 render 方法,所以我们要重写此方法,以返回我们自己的信息
public function render(Exception $ex) { return json(['msg'=>"自定义异常信息"]); nbsp; }
下面新建控制器 Product,添加方法,进行测试
public function getProduct($id) { try{ 3/0; } catch(Exception $ex){ throw $ex; } }
然后添加如下路由
Route::get("product/:id","api/v1.Product/getProduct");
输入如下url 测试
http://z.cn/product/2
页面输出结果如下
可见,其并没有执行自定义异常处理函数。
使用自定义的异常处理
在 config.php 中修改如下配置
// 异常处理handle类 留空使用 \think\exception\Handle 'exception_handle' => 'app\lib\exception\ExceptionHandler',
然后再运行
自定义异常处理类
一类异常是用户行为导致的异常,比如没有查询到符合条件的数据(从另一个角度来说,这其实不算异常),一类错误是运行时错误。而用户导致的异常可能分为很多种,所以需要自定义相关的类。
首先定义一个父类
class BaseException extends Exception { //http 状态码 public $code; //错误具体消息 public $msg; //自定义错误码 public $errorCode; //构造函数用于接收传入的异常信息,并初始化类中的属性 public function __construct($params) { if (!is_array($params)) { return; } if (array_key_exists('code', $params)) { $this->code = $params['code']; } if (array_key_exists('msg', $params)) { $this->msg = $params['msg']; } if (array_key_exists('errorCode', $params)) { $this->errorCode = $params['errorCode']; } } }
再定义一个处理找不到产品信息的异常处理类,用来重写父类中的各个属性,而且这个类中的属性信息也可能会被修改,如 msg
class ProductNotFoundException extends BaseException { //http 状态码 public $code = 404; //错误具体消息 public $msg = "请求的产品不存在"; //自定义错误码 public $errorCode = 40000; }
处理不同异常
在 render 方法中,根据异常的不同分别处理
//分别处理两种不容类型异常:1、用户错误 2.代码与运行时错误 if ($ex instanceof BaseException) { } else { }
说明:在 throw 异常时,会执行 render 函数,同时会将抛出的异常对象复制给参数 $ex,所以可以根据此参数判断异常类型
现在的关键是生产环境,所以希望返回的异常信息,前端人员能够看懂,而不是像上面那样在页面中输出错误信息,还包括堆栈信息等。
那么前前端贺后端人员都能够看懂的信息一定是 json(当然也可以是xml)了,修改 render 方法
if ($ex instanceof BaseException) { $this->code = $ex->code; $this->msg = $ex->msg; $this->errorCode = $ex->errorCode; } else { //这里是在运行时产生的各种异常,所以无法准确输出异常信息,所以只能统一输出是服务器错误信息 $this->code = 500; $this->msg = "服务器内部错误"; $this->errorCode = 999; }
然后以 json 格式返回错误信息
$result = [ 'msg' => $this->msg, 'error_code' => $this->errorCode, 'request_url' => request()->url() ]; return json($result,$this->code);
至此,全局的异常处理就编写好了,下面在 product.php 中编码进行测试
public function getProduct($id) { //处理程序运行时错误 /*try{ 3/0; } catch(Exception $ex){ throw $ex; }*/ //处理用户行为产生的错误 $error=[ 'msg'=>'没有找到合适的产品' ]; $ex=new ProductNotFoundException($error); throw $ex; }
提示:生产环境不要忘了将 app_debug 修改为 false
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对易盾网络的支持。