php异常处理

这篇文章主要对php中的错误处理进行简单的记录

php一开始被设计为一门面向过程的语言，所以异常处理没有使用像Java一样的 try / catch 机制，出错时直接显示到页面上，或者记录到web服务器的错误日志中，并且php的错误分成了很多的级别，例如E_ERROR、E_WARNING、E_PARSE、E_NOTICE等等，对于像E_ERROR、E_PARSE这样的严重错误，php会直接终止脚本的运行。线下开发时，我们一般会设置error_reporting(-1)和ini_set('display_errors', 'on')来报告并显示所有异常，但是线上运行的项目，出于安全的考虑，我们一般会隐藏错误日志的页面输出，如果php的配置文件中开启了log_error,那么相关的错误日志可以在PHP的错误日志中查询，但是如果我们是多项目呢，通过PHP错误日志来排错，显然不科学，那么我们如何像框架中一样来优雅的捕捉异常呢？相信有一定研发经验的同学，一定听说过或者用过大名鼎鼎的laravel框架，那么它是如何处理异常的呢？通过阅读源码，有兴趣可以在Illuminate\Foundation\Bootstrap\HandleExceptions.php查看具体实现。这里只对其中的核心部分进行分享，其中主要有三个PHP内置函数的调用：set_error_handler、set_exception_handler和register_shutdown_function

set_error_handler函数

set_error_handler来注册自己的错误处理方法来代替php的标准错误处理方式（输出到页面或者记录到日志），但是一些严重错误是无法通过这种方式来处理的，具体我们来看手册对该方法的介绍

mixed set_error_handler ( callable error_types = E_ALL | E_STRICT ] )
设置一个用户的函数(error_handler)来处理脚本中出现的错误。
本函数可以用你自己定义的方式来处理运行中的错误， 例如，在应用程序中严重错误发生时，或者在特定条件下触发了一个错误(使用 trigger_error())，你需要对数据/文件做清理回收。
重要的是要记住 error_types 里指定的错误类型都会绕过 PHP 标准错误处理程序， 除非回调函数返回了 FALSE。 error_reporting() 设置将不会起到作用而你的错误处理函数继续会被调用 —— 不过你仍然可以获取 error_reporting 的当前值，并做适当处理。 需要特别注意的是带 @ error-control operator 前缀的语句发生错误时，这个值会是 0。
同时注意，在需要时你有责任使用 die()。 如果错误处理程序返回了，脚本将会继续执行发生错误的后一行。
以下级别的错误不能由用户定义的函数来处理： E_ERROR、 E_PARSE、 E_CORE_ERROR、 E_CORE_WARNING、 E_COMPILE_ERROR、 E_COMPILE_WARNING，和在 调用 set_error_handler() 函数所在文件中产生的大多数 E_STRICT。

set_exception_handler函数

set_exception_handler注册异常处理函数，这样当有未被catch的异常产生时，系统会为我们自动调用注册的处理函数来处理。相关详细描述请查看官网文档set_exception_handler函数文档

register_shutdown_function函数

register_shutdown_function注册一个会在php中止时执行的函数注册一个 callback ，它会在脚本执行完成或者 exit()后被调用。关详细描述请查看官网文档register_shutdown_function函数文档

最后直接上干货

fileRootName = $fileName . date('Y-m-d') . '.log';
        if (!$bugType) {
            $this->checkDir();
            $this->errorHandle();
        }
    }

    private function checkDir(){
        $this->fileName = $this->fileRootName . date('Y-m-d') . '.log';
        if (!file_exists($this->fileName) && !is_dir($this->fileRootName)) {
            @mkdir($this->fileRootName, '0777', true);
        }
    }

    /**
     * 注册全局的错误处理函数
     */
    private function errorHandle()
    {
        // 注册自己的错误处理方法来代替php的标准错误处理方式（输出到页面或者记录到日志），但是一些严重错误是无法通过这种方式来处理的
        set_error_handler([$this, '_handleError']);

        // 注册异常处理函数，这样当有未被catch的异常产生时，系统会为我们自动调用注册的处理函数来处理。
        set_exception_handler([$this, '_handleException']);

        // 注册捕捉致命错误
        register_shutdown_function([$this, '_handleShutdown']);
    }

    /**
     * 错误处理
     * @param int $level
     * @param string $message
     * @param string $file
     * @param int $line
     * @param array $context
     */
    public function _handleError(int $level, string $message, string $file = '', int $line = 0, array $context = [])
    {
        if (error_reporting() & $level) {
            $this->_logHandle($message, $level, $file, $line);
        }
    }

    /**
     * 未捕捉的异常
     * @param \Throwable $e
     */
    public function _handleException(\Throwable $e)
    {
        if (!$e instanceof \Error) {
            $this->_logHandle($e->getMessage(), $e->getCode(), $e->getFile(), $e->getLine());
        } else {
            $this->_logHandle($e->getMessage(), $e->getCode(), $e->getFile(), $e->getLine());
        }
    }

    /**
     * 致命错误
     */
    public function _handleShutdown()
    {
        $error = error_get_last();
        if (!is_null($error)) {
            $this->_logHandle($error['message'], $error['type'], $error['file'], $error['line']);
        }
    }

    /**
     * 日志记录格式
     * @param $message
     * @param $level
     * @param $file
     * @param $line
     */
    private function _logHandle($message, $level, $file, $line)
    {
        $logData = [
            'message' => $message,
            'level' => $level,
            'file' => $file,
            'line' => $line
        ];
        $logStr = date('Y-m-d H:i:s') . " error => " . json_encode($logData);
        file_put_contents($this->fileRootName, json_encode($logStr));
        throw new \Error($message, 500);
    }
}

$logObj = new myErrorException();
new testBugA();

die('test');

此时上面的PHP代码网页中显示：

webLog.png

然后服务器日志中显示：

linuxLog.png

du -h / --max-depth=2 | sort -nr | head -5