PHP 异常参数

Question

我正在开发一个 PHP library，它可能会被不同的 PHP 项目用于各种环境，我正在努力做到尽可能简约。

在某些情况下我必须抛出异常，例如。

throw Exception('template has invalid tag');

如果没有标签的名称，这样的错误不是很有用：

throw Exception('template has invalid tag: '.$tag);

这将很难定位，并可能导致各种注入问题。

问题：在 PHP 中使用 Exception 传递额外变量的最佳方法是什么？

（注意：我的库执行 SQL 查询构建，我希望它专注于任务，而不是解决异常问题）

Answer 1

一个可能的解决方案是像这样使用 sprintf：

throw new Exception(sprintf(_('template has invalid tag %s'), $tag));

其中 _() 是您的本地化函数。

但这不是最好的解决方案，因为它仍然对 html 注入开放，并且当您要传递 5 个变量时会变得相当混乱。据我所知，Wordpress 使用这种本地化方法。

Answer 2

您可以定义自己的异常class，并在构造函数中添加变量。

例如：

class AnswerException extends \Exception
{
    protected $group;
    public function __construct($message = "",  $group = null, $code = 0, \Exception $previous = null){
        $this->group = $group;
        return parent::__construct($message, $code, $previous);
    }
    public function getGroup(){
        return $this->group;
    }
}

在这种情况下，您可以使用以下语法抛出异常：

throw new AnswerException('template has invalid tag',$tag);

然后，您可以捕获 AnswerException 并使用 $exception->getGroup() 函数。

Answer 3

国际化不是您图书馆的责任。为您的项目创建一个或多个 Exception 类（不建议使用 \Exception，因为它太笼统了）并让它们将参数存储在属性中。

让错误消息保持原样，但也将值作为参数传递给新异常的构造函数。为他们提供吸气剂。错误消息是针对开发人员的。使用您的库的代码必须捕获异常并显示适合它们的错误消息。无论如何，它们不应显示您提供的原始消息。

比如你在你的库中声明：

class InvalidTagException extends \Exception
{
    protected $tag;

    public function __construct($message, $tag, $code = 0, Throwable $previous = NULL)
    {
        // Let the parent class initialize its members
        parent::__construct($message, $code, $previous);
        // Initialize own members
        $this->tag = $tag;
    }

    public function getTag()
    {
        return $tag;
    }
}

// Declare other Exception classes in a similar fashion, for each kind of exception you throw
class InvalidValueException extends \Exception
{
    // ...
}

使用您的库的应用程序：

try {
    // call your library code here
} catch (InvalidTagException $e) {
    // Handle in application specific way

} catch (InvalidValueException $e) {
    // A different type of exception requires a different type of handling
}

PHP 异常参数

PHP Exception Arguments

php

dynamic-sql

atk4