19

我正在编写一个 PHP 库，我有一个问题。我的界面中有类似于以下内容的内容：

<?php
/**
 * My interface
 *
 * ...
 */
interface MyInterface
{
    /**
     * This method does foo.
     *
     * @throws \RuntimeException If foo can't be done.
     */
    public function fooAndBar();
}
?>

现在，该@throws条目并不完全正确，因为接口实际上并没有做任何事情，并且纯粹用于抽象实现细节。但是，我一直使用它，因为当出现问题时，我的所有接口实现都会抛出异常。

但是另一个开发人员可能会编写一个不会失败的实现（因此它不会抛出异常），或者他/她可能想要使用另一个异常类。

在这种情况下，我应该如何@throws在接口声明中记录？甚至应该记录在案吗？

4

2 回答 2

13

接口定义合约。实现类是否抛出异常是 PHP 中的一个实现细节，因为throws方法签名中没有关键字（就像在 Java 中一样）。添加@throws注释不能在技术上强制执行合同，但它可以指示约定（顺便说一句，返回值相同）。这是否足够好由您决定。

在旁注中，如果开发人员提出了一个不会抛出的实现，那么您没有问题，因为无论如何您都必须为那些抛出的实现添加一个 try/catch 块（按照惯例）。如果实现开始抛出与 DocBlock 中指示的不同的异常，那将是一个问题，因为那样它就不会被捕获。

于 2012-05-27T20:38:30.443 回答
12

考虑使用接口的代码：

public function doSomething(MyInterface $my) { ... }

如果甚至其中一个实现可以引发异常，您将需要确保处理异常的可能性。

所以，是的，它应该被记录在案。

即使只有一个实现抛出异常，异常处理仍然需要到位。当然，这并不意味着每个方法都应该有一个@throws。它仍应仅在适当的情况下使用（您期望实现合法地需要抛出异常）。

作为更具体的示例，请考虑以下内容：

interface LogWriter
{

    /**
     * @throws LogWriterException
     */
    public function write($entry);

}


class DbLogWriter
{

    public function __construct(PDO $db)
    {
        //store $db somewhere
    }

    public function write($entry)
    {
        try {
            //store $entry in the database
        } catch (PDOException $e) {
            throw new LogWriterException(...);
        }
    }

}

class NullLogWriter
{
    public function write($entry) { }
}

可以做一些事情来尝试降低写入数据库时​​发生异常的可能性，但归根结底，这不是异常安全操作。因此，DbLogWriter::write应该预期会抛出异常。

现在考虑 null writer，它只是丢弃条目。那里绝对没有任何可能出错的地方，因此，不需要例外。

但是，如果您有一些$log并且您所知道的只是它是LogWriter. 您是否认为它不会抛出异常并可能不小心让一个冒泡，或者您是否认为它可以抛出一个LogWriterException？我会保持安全，并假设它可以抛出 LogWriterException。

如果用户只知道这$log是一个 LogWriter 但只有 DbLogWriter 被记录为抛出异常，用户可能没有意识到$log->write(...) 可以抛出异常。此外，当稍后创建 FileLogWriter 时，这意味着已经设置了实现可以并且可能会抛出哪些异常的期望（没有人会期望FileLogWriter抛出 a RandomNewException）。

于 2012-05-27T20:25:37.923 回答