PHP 超实用系列 · 自动捕获 Fatal Error

重要使命

通过十几天的忙碌，张小五手上的项目终于如期上线，虽然很累，但心里无比的充实与喜悦。喝了杯热咖啡，小五在椅子上慵懒地躺着，享受着这份静谧的时光。

"嗨，小五，这几天累坏了吧？"
"哈哈，是有点累，不过还好。"

"周末好好休息下吧，我先跟你讨论个事儿啊。"
"好的，Z哥。"

"我们线上运行的代码，出于各类各样的状况，可能会有好多Fatal Error、Exception。有没有办法，在出现Fatal Error、Exception的时候，我们能自动捕获，并写到Log文件里？"
"嗯...这个嘛，出现Fatal Error的时候，脚本就终止了，很差捕获啊。"

"对，是很差捕获。可是对于出现的Fatal Error、Exception咱们不知道的话，不能提早发现问题，就像身边有个隐形的刺客同样，让人心里特别虚啊..."
"这样啊，Z哥，那我这几天试一下吧！"

"好的，小五，这个挺重要的，相信你！"
"哈哈，Z哥你仍是不要抱太大但愿，我努力试一下就是了。"

从Google到SO

对于码农来讲，从Google到Stackoverflow是解决问题的通途，固然张小五也不例外。

哈！不搜不知道，一搜吓一跳，PHP还真有捕获Error和Exception的函数。

//设置一个用户的函数来处理脚本中出现的错误。
set_error_handler($callback)
//设置一个用户的函数来处理脚本中出现的异常。
set_exception_handler($callback)复制代码

张小五不自觉的笑了笑：“哈哈，不愧是世界上最好的语言！”

说干就干，看看这两个函数的威力怎样,不一会,小五就写出了测试代码。

<?php
//设置异常捕获函数
set_exception_handler("my_exception");
function my_exception($exception){
    echo 'Exception Catched:'.$exception->getMessage();
}
//抛出异常
throw new Exception("I am Exception");复制代码

执行结果

Yes，抛出的一个Exception真的被捕获了！

"接下来再测下set_error_handler()，你可不能让我失望啊！"小五心想。

<?php
set_error_handler("error_handler");
function error_handler($errno,$errstr,$errfile,$errline){
    $str=<<<EOF "errno":$errno "errstr":$errstr "errfile":$errfile "errline":$errline EOF;
//获取到错误能够本身处理，好比记Log、报警等等
    echo $str;
}
echo $test;//$test未定义，会报一个notice级别的错误复制代码

执行结果

不错，Notice级别的错误也捕获到了！
接下来再测一下Fatal Error，若是Fatal Error也能捕获到，这个需求就实现了!

抑制住激动的心情，小五很快写完了测试代码。

<?php
set_error_handler("error_handler");
function error_handler($errno,$errstr,$errfile,$errline){
    $str=<<<EOF "errno":$errno "errstr":$errstr "errfile":$errfile "errline":$errline EOF;
//获取到错误能够本身处理，好比记Log、报警等等
    echo $str;
}
//调用一个不存在的函数，会出现Fatal Error
test();复制代码

小五屏住呼吸，等待着奇迹的出现。"咣当"，手起指落，几行报错跃然屏上...

执行结果

神马？Fatal Error居然没捕获到？怎么可能？

正在小五陷入沉思的时候，不经意间，小五瞥见了函数的说明：

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

也就是：set_error_handler($callback)只能捕获系统产生的一些Warning、Notice级别的Error。

呜呼悲催，好不容易找到了解决办法，没想到这函数居然仍是个半吊子，不少级别的错误捕获不到...😭

众里寻他千百度

王小五从不是轻言放弃的人，他又继续搜索，寻找着解决办法...

"嗯？哈哈，SO上还真有人遇到这问题!"

小五专一地看着答案，边看边敲了起来：

要实现这个需求，须要用到两个函数:register_shutdown_function()和error_get_last()。

register_shutdown_function()

register_shutdown_function($callback)复制代码

register_shutdown_function()，就把你要注册进去的function放进【伪装是队列吧】，等到脚本正常退出或显式调用exit()时，再把注册进去的function拉出来执行.

register_shutdown_function()调用的3种状况：

• 脚本正常退出时；
• 在脚本运行(run-time not parse-time)出错退出时；
• 用户调用exit方法退出时。

error_get_last()

error_get_last();//函数获取最后发生的错误。复制代码

该函数以数组的形式返回最后发生的错误。

返回的数组包含 4 个键和值：

[type] - 错误类型
[message] - 错误消息
[file] - 发生错误所在的文件
[line] - 发生错误所在的行

强烈注意

在parse-time出错的时候，是不会调用register_shutdown_function()函数的。只有在run-time出错的时候，才会调用register_shutdown_function()。

为了更好的理解，下面咱们举例说明：

NO.1

error_handler.php

<?php
register_shutdown_function("error_handler");
function error_handler(){
    echo "Yeah,it's worked!";
}
function test(){}
function test(){}复制代码

执行结果以下：

执行结果

缘由分析

在执行error_handler.php的时候，因为重复定义了两个函数test(),在php的parse-time就出错了（不是run-time），因此不能回调register_shutdown_function()中注册的函数。

NO.2

error_handler.php

<?php
register_shutdown_function("error_handler");
function error_handler(){
    echo "Yeah,it's worked!";
}
if(true){
   function test(){}
}
function test(){}复制代码

执行结果以下：

执行结果

缘由分析

咱们看到，上面回调了register_shutdown_function()中注册的函数。
由于咱们加了一个if()判断，if()里面的test()方法，至关于一个闭包，与外面的test()名称不冲突。
也就是，上面的代码在parse-time没有出错，而是在run-time的时候出错了，因此咱们可以获取到fatal error。

NO.3

error_handler.php

<?php
register_shutdown_function("error_handler");
function error_handler(){
    echo "Yeah,it's worked!";
}复制代码

test.php

<?php
include './error_handler.php';
function test(){}
function test(){}复制代码

执行 test.php的结果以下

执行结果

缘由分析

当咱们在运行test.php的时候,由于redeclare了两个test()方法，因此php的语法解析器在parse-time的时候就出错了。 因此不能回调register_shutdown_function()中的方法，不能catch住这个fatal error。

NO.4

error_handler.php

<?php
register_shutdown_function("error_handler");
function error_handler(){
    echo "Yeah,it's worked!";
}复制代码

test.php

<?php
function test(){}
function test(){}复制代码

include_all.php

<?php
require './error_handler.php';
require './test.php';复制代码

执行 include_all.php的结果以下

执行结果

结果分析

上面咱们捕获了fatal_error。
由于在运行include_all.php的时候，include_all.php自己语法并无出错，也就是在parse-time的时候并无出错，而是include的文件出错了，也就是在run-time的时候出错了，这个时候是能回调register_shutdown_function()中的函数的。

强烈建议：若是咱们要使用register_shutdown_function进行错误捕捉，使用NO.4，最后一种方法，能够确保错误都能捕捉到。

蓦然回首解需求

"哇塞，原来能够这样啊!"
王小五按答案中举的例子认真的敲完代码，瞬间明白了解决的办法。

真可谓"众里寻他千百度，蓦然回首，那人却在灯火阑珊处。"小二不自觉的感叹道！

"好了，我本身就写一个error_handler脚本吧，确保每次都能获取到想要的Fatal Error。"

<?php
register_shutdown_function( "fatal_handler" );
set_error_handler("error_handler");

define('E_FATAL',  E_ERROR | E_USER_ERROR |  E_CORE_ERROR | 
        E_COMPILE_ERROR | E_RECOVERABLE_ERROR| E_PARSE );

//获取fatal error
function fatal_handler() {
    $error = error_get_last();
    if($error && ($error["type"]===($error["type"] & E_FATAL))) {
        $errno   = $error["type"];
        $errfile = $error["file"];
        $errline = $error["line"];
        $errstr  = $error["message"];
        error_handler($errno,$errstr,$errfile,$errline);
  }
}
//获取全部的error
function error_handler($errno,$errstr,$errfile,$errline){
    $str=<<<EOF
         "errno":$errno
         "errstr":$errstr
         "errfile":$errfile
         "errline":$errline
EOF;
//获取到错误能够本身处理，好比记Log、报警等等
    echo $str;
}复制代码

有了这个脚本，我再按SO上说的第四种方法去执行，那这个需求就实现了！

不负众望

王小五兴冲冲的找到Z哥，详细的说明了本身的研究成果。

次日，小五按照公司现有的框架规则，结合上面的解决办法，不一会就实现了需求。

"不错啊，小五，我就说你能够吧！" Z哥高兴的说到。
"哈哈，Z哥，这下全部的错误都在掌握之中了!"

---

转载声明：本文转载自「聊聊代码」，搜索「talkpoem」便可关注。

关注「聊聊代码」，让咱们一块儿聊聊“左手代码右手诗”的事儿。