自定义异常消息：最佳做法

php exception

2022-08-30 08:33:30

想知道在创建异常消息时，我应该付出多少努力来强制提供有用的调试信息，还是应该只信任用户提供正确的信息，或者将信息收集推迟到异常处理程序？

我看到很多人做他们的例外，比如：

throw new RuntimeException('MyObject is not an array')

或者使用自定义异常扩展默认异常，这些异常不会执行太多操作，但会更改异常的名称：

throw new WrongTypeException('MyObject is not an array')

但这并不能提供太多的调试信息...并且不会强制执行带有错误消息的任何类型的格式设置。因此，您可能最终会遇到完全相同的错误，从而产生两个不同的错误消息...例如“数据库连接失败”与“无法连接到数据库”

当然，如果它冒泡到顶部，它会打印堆栈跟踪，这很有用，但它并不总是告诉我我需要知道的一切，通常我最终不得不开始拍摄var_dump（）语句以发现出了什么问题以及在哪里......尽管这可以通过一个体面的异常处理程序来抵消。

我开始考虑像下面的代码一样的东西，我要求异常的抛出者提供必要的参数来生成正确的错误消息。我想这可能是这样做的方式：

必须提供最低限度的有用信息
生成一些一致的错误消息
异常消息的模板全部位于一个位置（异常类），因此更新消息更容易...

但是我看到缺点是它们更难使用（需要你查找异常定义），因此可能会阻止其他程序员使用提供的异常......

我想对这个想法进行一些评论，以及一致，灵活的异常消息框架的最佳实践。

/**
* @package MyExceptions
* MyWrongTypeException occurs when an object or 
* datastructure is of the incorrect datatype.
* Program defensively!
* @param $objectName string name of object, eg "\$myObject"
* @param $object object object of the wrong type
* @param $expect string expected type of object eg 'integer'
* @param $message any additional human readable info.
* @param $code error code.
* @return Informative exception error message.
* @author secoif
*/
class MyWrongTypeException extends RuntimeException {
    public function __construct($objectName, $object, $expected, $message = '', $code = 0) {
        $receivedType = gettype($object) 
        $message = "Wrong Type: $objectName. Expected $expected, received $receivedType";
        debug_dump($message, $object);
        return parent::__construct($message, $code);
    }
}

....

/**
 * If we are in debug mode, append the var_dump of $object to $message
 */
function debug_dump(&$message, &$object) {
     if (App::get_mode() == 'debug') {
         ob_start();
         var_dump($object);
         $message = $message . "Debug Info: " . ob_get_clean();
    }
}

然后像这样使用：

// Hypothetical, supposed to return an array of user objects
$users = get_users(); // but instead returns the string 'bad'
// Ideally the $users model object would provide a validate() but for the sake
// of the example
if (is_array($users)) {
  throw new MyWrongTypeException('$users', $users, 'array')
  // returns 
  //"Wrong Type: $users. Expected array, received string
}

我们可以在自定义异常处理程序中做一些类似nl2br的事情，以使html输出变得好。

一直在阅读： http://msdn.microsoft.com/en-us/library/cc511859.aspx#

而且没有提到这样的事情，所以也许这是一个坏主意......

答案 1

我强烈建议Krzysztof的博客上的建议，并指出，在你的情况下，你似乎试图处理他所谓的使用错误。

在这种情况下，需要的不是指示它的新类型，而是关于导致它的更好的错误消息。作为一个帮助器函数，用于：

生成要放入异常中的文本字符串
生成整个异常和消息

是必需的。

方法1更清晰，但可能导致更冗长的用法，2则相反，用更简洁的语法换取不太清晰。

请注意，这些函数必须非常安全（它们本身就不应该导致不相关的异常），并且不要强制提供在某些合理用途中可选的数据。

通过使用这两种方法中的任何一种，您可以更轻松地在以后根据需要对错误消息进行国际化。

堆栈跟踪至少为您提供了功能，可能还有行号，因此您应该专注于提供不容易从中计算出的信息。

答案 2

我不会减损有关Krzysztof博客的建议，但这是创建自定义异常的非常简单的方法。

例：

<?php
   require_once "CustomException.php";
   class SqlProxyException extends CustomException {}

   throw new SqlProxyException($errorMsg, mysql_errno());     
?>

这背后的代码（我在某处借用的，向任何人道歉）

<?php

interface IException
{
    /* Protected methods inherited from Exception class */
    public function getMessage();                 // Exception message
    public function getCode();                    // User-defined Exception code
    public function getFile();                    // Source filename
    public function getLine();                    // Source line
    public function getTrace();                   // An array of the backtrace()
    public function getTraceAsString();           // Formated string of trace

    /* Overrideable methods inherited from Exception class */
    public function __toString();                 // formated string for display
    public function __construct($message = null, $code = 0);
}

abstract class CustomException extends Exception implements IException
{
    protected $message = 'Unknown exception';     // Exception message
    private   $string;                            // Unknown
    protected $code    = 0;                       // User-defined exception code
    protected $file;                              // Source filename of exception
    protected $line;                              // Source line of exception
    private   $trace;                             // Unknown

    public function __construct($message = null, $code = 0)
    {
        if (!$message) {
            throw new $this('Unknown '. get_class($this));
        }
        parent::__construct($message, $code);
    }

    public function __toString()
    {
        return get_class($this) . " '{$this->message}' in {$this->file}({$this->line})\n"
                                . "{$this->getTraceAsString()}";
    }
}