处理 php 页面上错误的最佳方法


Best way to handle errors on a php page?

现在我的页面看起来像这样:

if($_GET['something'] == 'somevalue')
{
    $output .= 'somecode';
    // make a DB query, fetch a row
    //...
    $row = $stmt->Fetch(PDO::ASSOC);
    if($row != null)
    {
        $output .= 'morecode';
        if(somethingIsOK())
        {
            $output .= 'yet more page output';
        }
        else
        {
            $error = 'something is most definitely not OK.';
        }
    }
    else
    {
        $error = 'the row does not exist.';
    }
}
else
{
    $error = 'something is not a valid value';
}
if($error == '') // no error
{
    //display $output on page
}
else // an error
{
    // display whatever error occurred on the page
}

我做事的方式是有效的,但对于可能显而易见的事情来说,它非常繁琐和乏味:假设我在代码中间的某个地方调用一个函数,或者想要检查变量的值,或者验证数据库查询返回了有效的结果,如果失败,我想输出错误?我将不得不制作另一个 if/else 块并将所有代码移动到新的 if 块中。这似乎不是一种聪明的做事方式。

我一直在阅读有关 try/catch 的信息,并一直在考虑将我的所有代码放在 try 语句中,然后让代码在没有任何 if/else 块的情况下按顺序运行,如果某些内容失败,只需抛出异常。从我所读到的内容来看,这将停止执行并使其直接跳转到 catch 块(就像失败的 if 语句将转到 else 块一样),然后我可以在其中输出错误消息。但这是一种可以接受或标准的做法吗?

在构建和输出 HTML 页面的 php 应用程序中处理错误(无论是否致命)的最佳方法是什么?我不想只是死在空白屏幕上,因为这会非常不友好,而是想在页面正文中输出一条消息,仍然允许页眉和页脚显示。

感谢您的建议!

有很多

方法可以解决这个问题,坦率地说,没有一种本质上是"正确的"。

您必须自己决定哪种方法对您来说更"舒适" - 这始终是偏好的结合(尽管您应该避免某些技术并且有充分的理由)。

这将在很大程度上取决于您如何拆分逻辑,但是我倾向于将所有可以返回非致命错误的代码包含在函数中,并使用所述函数的返回值来指示存在错误。

对于致命错误,我倾向于使用异常(带有try-catch块)。

现在要明确一点:

  • 非致命错误是您可以从中恢复的错误 - 这意味着即使出现问题,仍然可以执行一些代码并生成一些有价值的输出。例如,如果您想使用NTP协议获取当前时间,但服务器没有响应,您可以决定使用本地time函数,并且仍然向用户显示一些有价值的数据。
  • 致命错误是您无法从中恢复的错误 - 这意味着发生了非常糟糕的事情,您唯一能做的就是告诉您的用户页面无法执行要求的操作。例如,如果您正在从数据库中获取一些数据并得到SQL Exception - 没有有价值的数据要显示,您只能通知用户。

非致命错误(使用函数返回)

使用函数返回作为处理非致命问题的一种方式的一个很好的例子是,当这不是页面的主要目标时,它试图在页面上显示某个文件的内容(例如,您将有一个函数,在每个页面上显示从文本文件中获取的徽章 - 我知道这很牵强,但请耐心等待)。

function getBadge($file){
    $f = fopen($file,'r');
    if(!$f){
        return null;
    }
    .. do some processing ..
    return $badges;
}
$badges = getBadges('badges.txt');
if(!$badges){
    echo "Cannot display badges.";
} else {
    echo $badges;
}
.. carry on doing whatever page should be doing ..

事实上,函数fopen本身就是一个例子 - 它会返回。

成功时返回文件指针资源,出错时返回 FALSE。


致命错误(使用异常 - 尝试捕获)

当你有一段代码需要执行时,因为它正是用户想要的(例如,从数据库中读取所有新闻并显示给用户),你可以使用异常。让我们举一个简单的例子 - 一个用户访问了他的个人资料,并希望看到他收到的所有消息(现在让我们假设它们以纯文本形式存储)。您可能有一个类似这样的函数:

function getMessages($user){
    $messages = array();
    $f = fopen("messages_$user.txt","r");
    if(!$f){
        throw new Exception("Could not read messages!");
    }
    ... do some processing ...
    return $messages;
}

并像这样使用它:

try{
    ..do some stuff..
    $messages = getMessages($_SESSION['user'])); //assuming you store username in $_SESSION
    foreach($messages as $msg){
        echo $msg."<br/>";
    }
} catch(Exception $e){
    echo "Sorry, there was an error: ".$e->getMessage();
}

现在,如果您有一个可以执行所有其他代码的"顶级"脚本,这可能会派上用场。这意味着,例如,在您的index.php中,您只会拥有:

try{
    .. execute some code, perform some functions ..
} catch(Exception $e){
    echo "Sorry, there was an error: ".$e->getMessage();
}

不要过度使用例外!

无论您做什么,都不要使用异常来检查您可以从中恢复的内容。阅读另一个问题(完全归功于安东·戈戈列夫对此的很好的解释,以及其他答案者)为什么会这样。

延伸阅读

现在,没有比尝试几件事并看看什么对你有好处更好的方法来学习如何处理错误了。您可能会发现以下内容很有用:

  • W3School on PHP 异常处理
  • 关于错误处理的简短教程(类似于我的函数返回方法)
  • 关于PHP错误处理的广泛教程 - 包括使用trigger_error()函数,我没有提到,因为我不使用它,也不太了解它,但显然它非常有用。这是一本特别好的读物。

希望这对:)有所帮助

PHP

有一个内置的类 ErrorException,用于将 PHP 错误转换为异常,如果不处理异常,自然会停止执行。

异常改进了错误处理机制(try catch)和更好的调试信息(堆栈跟踪)。

将其包含在执行路径的最顶部(配置,或所有代码中首先包含的内容):

 set_error_handler(function($nNumber, $strMessage, $strFilePath, $nLineNumber){
      throw new 'ErrorException($strMessage, 0, $nNumber, $strFilePath, $nLineNumber);
 }, /*E_ALL*/ -1);

尽管PDO支持抛出异常,但默认情况下它是关闭的,您必须启用它:

 $pdo->setAttribute('PDO::ATTR_ERRMODE, 'PDO::ERRMODE_EXCEPTION);

如果使用MySQL,您还需要一个错误,因为没有设置必填字段和许多其他错误/警告被默认原谅:

 $pdo->exec("SET sql_mode = 'STRICT_ALL_TABLES'");

异常可以像在许多其他编程语言中使用 try catch 一样处理:

try
{
    echo $iAmAnUndefinedVariable;
}
catch('Throwable $exception)
{
    /*[...]*/
}

验证内容时,只需抛出异常:throw new Exception("Missing URL variable userId!");

如果 PHP 有一天从遗留错误报告中彻底决裂并默认抛出异常(弃用 error_reporting() 并更改默认值),那就太好了。

这更加优雅和可读。

try
{
    if($_GET['something'] != 'somevalue') 
    {
        throw new Exception ('something is not a valid value');
    }

    $output .= 'somecode';
    // make a DB query, fetch a row
    //...
    $row = $stmt->Fetch(PDO::ASSOC);
    if($row == null)
    {
        throw new Exception ('the row does not exist.');
    }

    $output .= 'morecode';

    if(somethingIsOK())
    {
        $output .= 'yet more page output';
    }
    else
    {
        throw new Exception ('something is most definitely not OK.');
    }

    echo $output;
}
catch (Exception $e)
{
    echo $e->getMessage();
}

使用 try-catch 是您可以使用的最干净的解决方案之一。

我做了一个示例,当发生错误时,它仍然显示页眉和页脚,使用转换为try-catch格式的代码:

.PHP:

<?php
try {
    $output = array();
    if($_GET['something'] != 'somevalue') throw new Exception('something does not have a valid value.');
    $output[] = 'Some Code';
    $row = mt_rand(0, 10) < 5 ? null : mt_rand(0, 100);
    if($row === null) throw new Exception('The row does not exist.');
    $output[] = $row;
    if(!somethingIsOK()) throw new Exception('Something is most definitely not OK.');
    $output[] = 'Yet more page output';
} catch(Exception $e) {
    $output[] = 'Error: ' . $e->getMessage(); // To show output and error
    $output = array('Error: ' . $e->getMessage()); // To only show error
}
function somethingIsOK() {
    return mt_rand(0, 10) < 5;
}
?>

.HTML:

<!DOCTYPE HTML>
<html lang="en-US">
<head>
    <meta charset="UTF-8" />
    <title>PHP Error test</title>
    <style type="text/css">
body {
    background: #eee;
    text-align: center
}
#content {
    padding: 60px
}
#header {
    padding: 30px;
    background: #fff
}
#footer {
    padding: 10px;
    background: #ddd
}
    </style>
</head>
<body>
    <div id="header">Header</div>
    <div id="content">
<?php echo implode('<br />', $output); ?>
    </div>
    <div id="footer">Footer</div>
</body>
</html>

引用:

  • PHP:异常 - 手动
  • PHP: 捕获 - 手动

查询的PDO错误异常处理,实际上所有代码都应该通过:

try{
}
catch{

}
finally{
}

这样做的原因是,当您可以大致查明冗长脚本中发生错误的位置时,它使调试变得更加容易

更多信息在这里: http://php.net/manual/en/language.exceptions.php

创建错误处理程序 (set_error_handler) 并在其中抛出异常。
它将对不支持异常的函数有所帮助。

使用错误处理函数正确处理 PHP 错误和警告。( 见此处的示例 )

在PHP中处理错误的最佳方法是,您可以通过在 php 文件顶部添加此行来停止所有错误报告 -

error_reporting(0);
//OR
error_reporting('E_ALL');
// Predefined Constant

PHP 中使用函数的错误处理:

  • debug_backtrace — 生成回溯
  • debug_print_backtrace — 打印回溯
  • error_clear_last — 清除最近的错误
  • error_get_last — 获取上次发生的错误
  • error_log — 向定义的错误处理发送错误消息例 程
  • error_reporting — 设置报告哪些 PHP 错误
  • restore_error_handler — 恢复以前的错误处理程序函数
  • restore_exception_handler — 恢复以前定义的异常处理程序函数
  • set_error_handler — 设置用户定义的错误处理程序函数
  • set_exception_handler — 设置用户定义的异常处理程序功能
  • trigger_error — 生成用户级错误/警告/通知消息
  • user_error — trigger_error的别名

上面列出的所有函数都用于PHP中的错误处理。

如果您正在寻找一种看起来漂亮且有效的代码结构 - 您可以使用我经常使用的whitelist方法。例如 - 验证$_GET变量:

$error = false;
if(!isset($_GET['var'])) 
{
    $error = 'Please enter var''s value';
}
elseif(empty($_GET['var'])) 
{
    $error = 'Var shouldn''t be empty';
}
elseif(!ctype_alnum($_GET['var'])) 
{
    $error = 'Var should be alphanumeric';
}
//if we have no errors -> proceed to db part
if(!$error) 
{
    //inserting var into database table
}

所以,就是这样,只有 2 个if/elseif块,没有嵌套