php - 我应该如何在大型项目中返回错误(和消息)？

Question

我正在编写一个大型项目，这里有一个我会经常使用的类:

class Star
{
    /**
     * Add
     *
     * Add a star to something.
     *
     * @param int $ID   The ID of the thing.
     */

    function Add($ID)
    {
        if($this->Starred($ID))
            return 'You starred it already.';

        if(!$this->Existing($ID))
            return 'The one you tried to star does no longer exist.';

        $this->DB->Star($ID);

        return 'Starred successfully!';
    }
}

$Star = new Star();

但我会以不同的方式使用它，例如:单页 或在函数内，

这就是问题所在，有时，我想知道返回码而不是消息，

但是当我在单个页面中使用它时，我希望它返回消息，

所以如果我将 Add() 函数更改为:

function Add($ID)
{
    if($this->Starred($ID))
        return 0;

    if(!$this->Existing($ID))
        return 1;

    $this->DB->Star($ID);

    return 2;
}

我现在可以像这样在我的函数中使用它来处理错误:

/** Leaves a comment */
$Comment->Say('Hello.', $ID);

/** Auto star the post because we commented on it */
if($Star->Add($ID) == 2)
{
    /** Remove the comment because the post does no longer exist */
    $Comment->Remove('Hello.', $ID);

    return 'Sorry ; _ ;, the post does no longer exist.';
}

但是如果我需要在许多其他页面中返回消息怎么办？

我每次都需要写这段代码吗？

switch($Star->Add($ID))
{
    case 0:
        return 'You starred it already.';
        break;

    case 1:
        return 'The one you tried to star does no longer exist.';
        break;

    case 2:
        return 'Starred successfully!';
        break;
}

我只是对此感到困惑，我们将不胜感激。

Answer 1

要直接解决您的代码，请阅读 编辑 1 部分。

我目前正在从事一个相当大的项目，我正在使用我制作的 ErrorHandler 类。我发现使用通用错误处理程序类使它变得更容易。

class ErrorHandler
{
    /**
     * @var string an array containing all the errors set.
     */
    private static $errors = [];

    /**
     * Set an error.
     * 
     * @param string $error - The error message you'd like to set.
     * @return string - The error being set to $errors array.
     */
    public static function add($error)
    {
        return self::$errors[] = $error;
    }

    /**
     * Get all the errors.
     * 
     * @return boolean if the $errors array is empty it will return false, otherwise it will return the errors.
     */
    public static function get()
    {
        foreach (self::$errors as $error) {
            if (empty(trim($error)))
                return false;
        }
        return self::$errors;
    }
}

基本上我是这样使用它的，假设我需要验证一个表单输入，比如说登录，我会首先检查用户是否按下了提交按钮，然后我会使用三元运算符 运行一些验证，如果失败，我使用 ErrorHandler 类。

if(isset($_POST['login'])) {
    $emailAddress = someValidationsHere ? doSomethingWithValidInput : ErrorHandler::add("Email field is empty or format is invalid.");
    $password = someValidationsHere ? doSomethingWithValidInput : ErrorHandler::add("Password field can't be empty and can't use special characters.");

    if(!ErrorHandler::get()) {                    
        echo User::login($emailAddress, $password, $autoLogin);
    } else {
        $errors = ErrorHandler::get();

        foreach($errors as $error) {
            echo $error . "<br/>";
        }
    }
}  

所以底部 if 语句 所做的是检查 ErrorHandler::get 函数是否不返回false 在这种情况下不需要显示错误消息，您可以继续使用代码，否则 它将显示错误页面，这样您就可以显示多个错误并具有自定义格式。

我更喜欢这种方法，因为它更像是一种长期解决方案，因为您可能会更改 ID，然后您必须检查所有代码并手动更改代码。它还为您的代码提供某种结构，并使您的代码保持整洁。

编辑 1

这个类怎么样？您现在使用 const 值知道错误代码，并且可以使用 getMessage 函数将错误代码解析 为消息。此外，您的代码更易于理解和适应。

为什么更...

可以理解吗？

因为现在当您(或其他人)查看此代码时，他们会从 const 中看到干净的名称，因此 ALREADY_STARRED_ERROR 会让开发人员立即知道是什么错误的意思。

适应性强？

好吧，现在您可以更改您的硬编码错误，它无论如何都不会影响代码，所以如果将来您因为拼写错误或其他错误而希望更改它，您可以更改数组消息。

<?php
class Star
{
    const ALREADY_STARRED_ERROR = 1;
    const NOT_FOUND_ERROR= 2;
    const SUCCESSFUL_ENTRY = 3;
    
    function getMessage($code)
    {
        $messages = [
            1 => "You starred it already.",
            2 => "The one you tried to star does no longer exist.",
            3 => "Starred successfully!"
        ];
        
        return $message[$code];
    }
    
    /**
     * Add
     *
     * Add a star to something.
     *
     * @param int $ID   The ID of the thing.
     */

    function Add($ID)
    {
        if($this->Starred($ID))
            return self::ALREADY_STARRED_ERROR;

        if(!$this->Existing($ID))
            return self::NOT_FOUND_ERROR;

        $this->DB->Star($ID);

        return self::SUCCESSFUL_ENTRY;
    }
}
?>

我认为编辑 1 解决了您遇到的两个问题。

sometimes, I want to know the return code not the message,

but when I use it in the single page, I want it to return the messaage,