PHP 如何优雅的处理错误

| 选择喜欢的代码风格  

PHP 在处理错误的时候,可以简单的使用 exit()die() 来进行基本的处理,不过这样处理会让程序显得臃肿。

下面主要讲一下如何捕获 E_PARSE & E_ERROR 错误,这里我刻意的把 E_PARSE 错误放前位的,因为 E_PARSE 是面向用户脚本第一位的错误,即若有必然最先发生。而后才是 E_ERROR & E_WARNING & E_NOTICE ....一类的运行时错误。

PHP 错误级别


# 系统级用户代码的一些错误类型 可由 try ... catch ... 捕获
E_PARSE          解析时错误 语法解析错误 少个分号 多个逗号一类的 致命错误
E_ERROR          运行时错误 比如调用了未定义的函数或方法 致命错误

# 可由 set_error_handler 捕获处理
E_WARNING        运行时警告 调用了未定义的变量
E_NOTICE         运行时提醒                  
E_DEPRECATED     运行时已废弃的函数或方法

# Zend Engine 相关的一些错误 内存错误一类的 
# 应该也能通过 try ... catch ... 捕获 略难测试
E_CORE_ERROR
E_CORE_WARNING
E_COMPILE_ERROR
E_COMPILE_WARNING

# 用户级自定义错误 可由 trigger_error 触发 可由 set_error_handler 捕获处理
E_USER_ERROR 用户自定义错误 致命错误 未处理也会导致程序退出
E_USER_WARNING
E_USER_NOTICE
E_USER_DEPRECATED

#编码标准化警告(建议如何修改以向前兼容)
E_STRICT 部分 捕获的话 try ... catch ... 部分 set_error_handler
E_RECOVERABLE_ERROR

天真的想法


1、想关闭所有的错误报告

<?php
// 不报告任何级别的错误
error_reporting(0);
// 关闭错误回显
ini_set('display_errors', false);

echo 'i lost semicolon operator'

PHP Parse error: syntax error, unexpected $end, expecting ',' or ';' in ..

PHP 依然使用自身的错误机制报错,原因很简单:语法解析 -- 解释运行 -- 结束退出。当脚本最基本的语法存在问题时,Zend Engine 自身就会退出执行,并回显 Parse ERROR 错误信息。此时还未解释执行用户代码,即 error_reporting(0) 还没有在 Zend Engine 中对运行时做运行时环境的设定。

2、想使用 set_error_handler 捕捉错误

<?php
// 报告所有级别的错误
error_reporting(E_ALL);

// 自定义错误捕捉器
set_error_handler(function($error_no, $error_str, $error_file, $error_line) {
}, E_ALL | E_STRICT);

echo 'i lost semicolon operator'

依然得不到理想的结果。

首先,这段代码也是在解析阶段就报错了,Parse Error 直接退出了,还没有真的执行 set_error_handler()

官方原话讲解

如果错误发生在脚本执行之前(比如文件上传时),将不会调用自定义的错误处理程序因为它尚未在那时注册。

再说,退一步讲, set_error_handler 是用来自定义用户级错误 E_USER_ERROR & E_USER_WARNING & E_USER_NOTICE & E_USER_DEPRECATED 和 部分运行时系统错误 E_WARING & E_NOTICE & E_DEPRECATED 的捕获器,即语法解析错误 E_PARSE (Parse Error) 是无法用其捕获到的。

官方原话讲解

以下级别的错误不能由用户定义的函数来处理: E_ERROR、 E_PARSE、 E_CORE_ERROR、 E_CORE_WARNING、 E_COMPILE_ERROR、 E_COMPILE_WARNING,和在调用 set_error_handler() 函数所在文件中产生的大多数 E_STRICT。

如果定义的 set_error_handlerhandler 最后返回了 false,则此错误信息会继续被 PHP 的标准错误处理程序处理:通过 error_reporting 的级别设定,该回显的回显(display_errors),该写入错误日志的写入错误日志(log_errors & error_log)

官方原话讲解

重要的是要记住 error_types 里指定的错误类型都会绕过 PHP 标准错误处理程序, 除非回调函数返回了 FALSE。

注意,set_error_handler 是有自己的捕获级别的,默认 E_ALL | E_STRICT,不过要出去上文说的那几个级别,且不受 error_reporting() 设定的级别影响,即使你 error_reporting(0)set_error_handler 依然能捕捉到相应的错误

完善的错误采集


try ... catch 可以捕捉 E_PARSE & E_ERROR

set_error_handler 可以捕捉 E_WARNING & E_NOTICE & E_DEPRECATED & E_USER_*

二者联合起来即可捕捉大部分的用户代码层面的错误

<?php
// 设定错误监听的级别
// 但不会影响 set_error_handler 和 try ... catch 的捕获
// set_error_handler 和 try ... catch 是将错误处理交给用户
// 只有当用户没有对错误做处理时
// 错误才会根据 error_reporting / display_errors / log_errors / error_log 
//进行 php 标准的错误处理流程
error_reporting(E_ALL);

// 是否回显错误信息,默认 true
// 则会将所有监听到的错误信息回显到标准输出:浏览器或者命令行
// 线上环境强烈建议关闭 错误信息会暴露服务器相关信息
ini_set('display_errors', false);

// 开启错误日志
// 线上环境强烈建议开启 记录错误日志
ini_set('log_errors', true);
// 错误日志的位置 注意:如果 error_log 的路径有误的话 
//display_errors 会被强制打开 回显错误到标准输出
ini_set('error_log', __DIR__ . '/error.log');

// 以上为 php 标准错误处理 的设定

// E_WARNING E_NOTICE E_DEPRECATED E_USER_* E_STRICT 捕获
set_error_handler(function ($error_no, $error_str, $error_file, $error_line) {
    echo "erro_no: " . $error_no . " error_str: " . $error_str . PHP_EOL;
    //注意 程序并不会在这里退出执行
    //注意 如果返回了 false 错误会被 php 标准错误处理流程处理
}, E_ALL | E_STRICT);

// E_PARSE & E_ERROR 捕捉
try {
    // E_WARNING 被 set_error_handler 捕获
    echo $variable_not_exists;

    // E_ERROR 被 try ... catch 捕获
    func_not_exists("function not exists!");

    // E_PARSE 被 try ... catch 捕获 lib.php 中有语法错误 
    require_once __DIR__ . '/lib.php';
} catch (\Exception $exception) {
    echo var_export($exception, true) . PHP_EOL;
} catch (\Error $error) {
    echo var_export($error, true) . PHP_EOL;
}

echo "run finished" . PHP_EOL;

注意 set_error_handlertry ... catch 对错误捕获后程序会继续执行下去,并不会立即退出。

总结


E_ERROR & E_PARSE 使用 try ... catch 捕获

E_WARNING & E_NOTICE & E_DEPRECATED & E_USER_* 使用 set_error_handler 捕捉

若没有做相应的处理,则错误信息会提交至 PHP 标准错误处理流程,根据 error_reporting / display_errors / log_errors / error_log 的设定进行处理。



发表评论