美文网首页异常处理PHP经验分享程序员
php异常处理 之 BooBoo库介绍

php异常处理 之 BooBoo库介绍

作者: 小聪明李良才 | 来源:发表于2016-11-10 14:09 被阅读188次

    本文介绍php开源库BooBoo,是一个处理php异常和错误的开源库,通过简单的分析代码,我们知道了实际项目中怎么正确的设置错误和异常。

    这是php异常系列的第二篇,第一篇地址是:

    如何组织PHP中的异常

    基本概念

    php中的异常和错误是不一样的,错误英文单词是error,异常英文单词是exception。异常一般指出现正常逻辑之外的情况,而错误是指运行时发生了不可恢复的故障,比如使用了未定义的变量,或者语法错误等。异常我们通过throw抛出,catch进行捕获,而错误一般发生程序就会终止,我们可以通过trigger_error触发用户级错误,然后通过set_error_handler设置处理函数,下面看段代码:

    set_error_handler('errorHandler');
    trigger_error("这里描述错误",E_USER_ERROR);
    //E_USER_ERROR:该error 所特定的错误类型,默认是E_USER_NOTICE
    function errorHandler($errno,$errstr){
        //用户的函数需要接受两个参数:错误码和描述错误的 string
        if($errno==E_USER_ERROR){
            echo "错误为:",$errstr.'<br>';
        }
    }
    

    运行后就会通过我们设定的errorHandler输出错误。

    如果我们没有设定errorHandler,而且我们是在控制台中运行的脚本,那就会出现错误信息,

    PHP Fatal error: 这里描述错误 in /Users/zhuanxu/workspace/php-exceptions/error.php on line 4

    那我们怎么能够在生产环境中去除这些信息呢?

    php.ini中有两个参数与错误有关,一个是display_errors,另一个是error_reporting,其中display_errors控制着是否将错误信息输出到控制台,而error_reporting则控制着错误报告级别。

    讲完这些,我们下面将开始分析BooBoo,来看看实际项目中怎么处理错误和异常。

    BooBoo介绍

    此处我们通过库BooBoo来进行学习。

    BooBoo的设计原则是:如果Errors是fatal的,那就按fatal处理,如果Errors不是Fatal的,则让程序继续执行。

    在错误的处理上,我们希望能够在实际生产中处理错误,但是只在开发环境中才展示出这些错误信息,因此BooBoo在设计上有两个重要的概念:Handler,Formatter。

    • Handler做的事情就是针对错误执行一个操作,可能是记录日志,可能是发送错误给报警器。
    • Formatter则是将错误变为可阅读的错误信息。

    另外当设置display_errors关闭的时候,不会执行Formatter操作,当然BooBoo也支持你自己针对错误自己制定Formatter。

    代码结构:

    ├── Exception
    │   └── NoFormattersRegisteredException.php
    ├── Formatter
    │   ├── AbstractFormatter.php
    │   ├── CommandLineFormatter.php
    │   ├── FormatterInterface.php
    │   ├── HtmlFormatter.php
    │   ├── HtmlTableFormatter.php
    │   ├── JsonFormatter.php
    │   └── NullFormatter.php
    ├── Handler
    │   ├── HandlerInterface.php
    │   ├── LogHandler.php
    │   └── RavenHandler.php
    ├── Runner.php
    └── Util
        ├── Frame.php
        ├── FrameCollection.php
        └── Inspector.php
    

    顶层是Runner.php,下面是重要的两个目录:Formatter和Handler,还有辅助函数Util,以及异常Exception。

    我们先看使用方式

    安装

    $ composer require league/booboo
    

    新建booboo.php

    use League\BooBoo\Formatter\CommandLineFormatter;
    use League\BooBoo\Runner;
    
    require_once __DIR__ . "/vendor/autoload.php";
    
    
    $runner = new Runner();
    $runner->pushFormatter(new CommandLineFormatter());
    $runner->register(); // Registers the handlers
    
    echo $cc;
    

    执行后输出:

    +--------+
    | NOTICE |
    +--------+
    Undefined variable: cc in /Users/zhuanxu/workspace/php-exceptions/booboo.php on line 12
    

    有了使用的感性认识后,我们看看究竟发生了什么。

    League\BooBoo\Runner的构造函数中:

    public function __construct(array $formatters = [], array $handlers = []);
    

    可以设置formatters和handlers,然后在register函数中,

    //==> 关闭错误展示,设置3个处理函数
    // We want the formaters we register to handle the errors.
    ini_set('display_errors', false);
    
    set_error_handler(array($this, self::ERROR_HANDLER));
    set_exception_handler(array($this, self::EXCEPTION_HANDLER));
    register_shutdown_function(array($this, self::SHUTDOWN_HANDLER));
    

    通过3个注册函数注册了处理的函数。当异常发生的时候,调用exceptionHandler函数

    里面会挨个调用用户注册的handlers,如果用户没有关闭错误显示,会通过formatters处理后直接打印出来,但是如果关闭了错误显示,则会返回给浏览器。

    此处看下register_shutdown_function函数,其注册的函数调用条件是:

    1、当页面被用户强制停止时

    2、当程序代码运行超时时

    3、当PHP代码执行完成时,代码执行存在异常和错误、警告

    在函数shutdownHandler中:我们关闭了抛出异常,然后判断是否有错误发生,有则进行错误处理。

    public function shutdownHandler()
        {
            // We can't throw exceptions in the shutdown handler.
            $this->treatErrorsAsExceptions(false);
    
            $error = error_get_last();
            if ($error && $error['type'] & $this->fatalErrors) {
                $this->errorHandler(
                    $error['type'],
                    $error['message'],
                    $error['file'],
                    $error['line']
                );
            }
        }
    

    最后我们看下错误处理函数,在里面我们会判断错误是否是致命错误,如果是则进行处理,否则按照异常处理。

    BooBoo库的介绍就到这了,通过BooBoo我们能很方便的对异常和错误进行统一处理,非常方便我们平常的开发,下一篇我们将再看看Whoops库,也是一个错误处理的函数,再平时开发中用到的很多。

    这是 php异常系列 的第二篇,你的鼓励是我继续写下去的动力,期待我们共同进步。

    参考

    PHP异常、错误处理机制笔记

    Introducing a new error handler for PHP projects

    register_shutdown_function 函数详解

    相关文章

      网友评论

        本文标题:php异常处理 之 BooBoo库介绍

        本文链接:https://www.haomeiwen.com/subject/nuhxpttx.html