异常处理

优质

小牛编辑

148浏览

2023-12-01

和PHP默认的异常处理不同，ThinkPHP抛出的不是单纯的错误信息，而是一个人性化的错误页面。

[TOC=2,2]

异常显示

在调试模式下，系统默认展示的异常页面：

只有在调试模式下面才能显示具体的错误信息，如果在部署模式下面，你可能看到的是一个简单的提示文字，例如：

你可以通过设置exception_tmpl配置参数来自定义你的异常页面模板，默认的异常模板位于：

thinkphp/tpl/think_exception.tpl

你可以在应用配置文件app.php中更改异常模板

// 自定义异常页面的模板文件
'exception_tmpl'         => Env::get('app_path') . 'template/exception.tpl',

默认的异常页面会返回500状态码，如果是一个HttpException异常则会返回HTTP的错误状态码。

异常忽略

本着严谨的原则，5.0版本开始默认情况下会对任何错误（包括警告错误）抛出异常，如果不希望如此严谨的抛出异常，可以使用下面方法设置。

默认框架会捕获所有的错误，包括PHP警告级别的错误，你可以在应用配置文件或者公共文件中设置要报告的错误级别，例如：

// 除了 E_NOTICE，报告其他所有错误
error_reporting(E_ALL ^ E_NOTICE);

由于错误机制的注册顺序问题，在入口文件中设置错误级别无效。
系统产生的异常和错误都是程序的隐患，要尽早排除和解决，而不是掩盖。对于应用自己抛出的异常则做出相应的捕获处理。

异常处理接管

框架支持异常处理由开发者自定义类进行接管，需要在应用配置文件app.php中配置参数exception_handle。

最简单的方式是使用闭包定义异常处理，例如：

'exception_handle'       => function($e) {
  // 参数验证错误
  if ($e instanceof \think\exception\ValidateException) {
    return json($e->getError(), 422);
  }

  // 请求异常
  if ($e instanceof \think\exception\HttpException && request()->isAjax()) {
    return response($e->getMessage(), $e->getStatusCode());
  }    
},

如果需要更复杂的异常处理，可以把exception_handle配置定义为异常处理类的名称，例如：

    // 异常处理handle类 留空使用 \think\exception\Handle
    'exception_handle'       => '\\app\\common\\exception\\Http',

自定义类需要继承think\exception\Handle并且实现render方法，可以参考如下代码：

<?php
namespace app\common\exception;

use Exception;
use think\exception\Handle;
use think\exception\HttpException;
use think\exception\ValidateException;

class Http extends Handle
{
    public function render(Exception $e)
    {
        // 参数验证错误
        if ($e instanceof ValidateException) {
            return json($e->getError(), 422);
        }

        // 请求异常
        if ($e instanceof HttpException && request()->isAjax()) {
            return response($e->getMessage(), $e->getStatusCode());
        }

        // 其他错误交给系统处理
        return parent::render($e);
    }

}

自定义异常处理的主要作用是根据不同的异常类型发送不同的状态码和响应输出格式。

需要注意的是，如果自定义异常处理类没有再次调用系统render方法的话，配置http_exception_template就不再生效，具体可以参考Handle类内实现的功能。

手动抛出和捕获异常

ThinkPHP大部分情况异常都是自动抛出和捕获的，你也可以手动使用throw来抛出一个异常，例如：

// 使用think自带异常类抛出异常
throw new \think\Exception('异常消息', 10006);

系统提供了一个助手函数简化异常的代码，用法如下：

exception('异常信息','异常代码','异常类')

异常代码默认为0，可以根据应用的异常设计来定义，异常类如果不传表示抛出默认的think\Exception异常，下面是示例：

// 使用助手函数抛出异常
exception('异常消息', 10006);

如果需要抛出自定义异常，可以使用：

// 抛出自定义异常
exception('异常消息', 10006,'\app\common\exception\NotFoundException');

手动捕获异常方式是使用try-catch，例如：

try {
    // 这里是主体代码
} catch (ValidateException $e) {
    // 这是进行验证异常捕获
    return json($e->getError());
} catch (\Exception $e) {
    // 这是进行异常捕获
    return json($e->getMessage());
}

支持使用try-catch-finally结构捕获异常。

可以使用PHP的异常捕获进行必要的处理，但需要注意一点，在异常捕获中不要使用think\Controller类的error、success和redirect方法，因为上述三个方法会抛出HttpResponseException异常，从而影响正常的异常捕获，例如：

try{
    Db::name('user')->find();
    $this->success('执行成功!');
}catch(\Exception $e){
    $this->error('执行错误');
}

应该改成

try{
    Db::name('user')->find();
}catch(\Exception $e){
    $this->error('执行错误');
}
$this->success('执行成功!');

HTTP 异常

可以使用\think\exception\HttpException类来抛出异常框架提供了一个abort助手函数快速抛出一个HTTP异常：

<?php
namespace app\index\controller;

use think\Controller;

class Index extends Controller
{
    public function index()
    {
      // 抛出 HTTP 异常
      throw new \think\exception\HttpException(404, '异常消息');
    }
}

系统提供了助手函数abort简化HTTP异常的处理，例如：框架提供了一个abort助手函数快速抛出一个HTTP异常：

<?php
namespace app\index\controller;

use think\Controller;

class Index extends Controller
{
    public function index()
    {
        // 抛出404异常
        abort(404, '页面异常');
    }
}

如果你的应用是API接口，那么请注意在客户端首先判断HTTP状态码是否正常，然后再进行数据处理，当遇到错误的状态码的话，应该根据状态码自行给出错误提示，或者采用下面的方法进行自定义异常处理。

部署模式下一旦抛出了HttpException异常，可以定义单独的异常页面模板，只需要在应用配置文件中增加：

'http_exception_template'    =>  [
    // 定义404错误的模板文件地址
    404 =>  Env::get('app_path') . '404.html',
    // 还可以定义其它的HTTP status
    401 =>  Env::get('app_path') . '401.html',
]

模板文件支持模板引擎中的标签。

http_exception_template配置仅在部署模式下面生效。