避免使用静态访问异常

Question

我刚刚第一次启动了 PHPMD，可以预见的是，我遇到了一个我无法弄清楚的错误。错误是

避免使用静态访问类“InvalidArgumentException” 方法“setLang”。

代码是

public function setLang($val0) {
    switch ($val0) {
    case ENG:
    case FRE:
    case SPA;
        $this->lang = $val0;
        break;
    default:
        throw new InvalidArgumentException("Invalid language choice.");
    }
}

我尝试了各种不同的方法，但我认为归根结底Exception 是一个静态工厂 (???)，因此它必须具有静态访问权限。但是，PHPMD 的家伙肯定比我聪明，所以这不会让他们烦恼。

为什么会出现这个警告，如何解决？

Answer 1

如果您使用 XML 规则集，则可以从该规则中排除某些类（完整命名空间）：

    <rule ref="rulesets/cleancode.xml">
        <exclude name="StaticAccess"/>
    </rule>
    <rule ref="rulesets/cleancode.xml/StaticAccess">
        <properties>
            <property name="exceptions" value="\Drupal\views\Views,\Drupal\Core\Access\AccessResult" />
        </properties>
    </rule>

Answer 2

此警告背后的想法是，如果您使用 new 关键字在代码中嵌入类名，则很难在测试和模拟或存根方法中交换这些类，而被测代码可能会调用它们. See the explanation 在 PHPMD 规则中。

我认为在您的情况下这是误报，因为异常通常本身并没有太多行为，但是它们的类名（及其背后的类层次结构）几乎是它们唯一重要的事情。

如果你想摆脱这里的警告，你可以在这里使用@SupressWarnings注解。

Answer 3

因为我用了很多self::作为常量，把phpmd代码改成接受self::和parent::。

在程序 PHP/PMD/Rule/CleanCode/StaticAccess.php 的第 36 行，更改为：

if ($this->isReferenceInParameter($reference)
    || $reference->getImage() === 'self' 
    || $reference->getImage() === 'parent' 
    ) {
    continue;
}

也许你可以用它来改进代码。

Answer 4

啊，经过一番挖掘，我直接从马的嘴里找到了答案。

在位于yourphpdir\data\PHP_PMD\resources\rulesets 的配置文件中，cleancode.xml 具有解释设置的 CDATA cmets。

这句话说：

静态访问会导致对其他类的不可交换依赖，并且 导致难以测试代码。不惜一切代价避免使用静态访问 而是通过构造函数注入依赖项。唯一的案例 什么时候可以接受静态访问是用于工厂方法。

解决的方法就是把异常作为参数传递，所以在类外声明。

$foo->setLang("Oh noes!", new InvalidArgumentException("No lang for you."));