如何解决以下 PMD 违规问题

Question

我正在使用 PMD 来分析代码，它会产生一些我不知道如何修复的高优先级警告。

1) 避免 if(x!=y)..; else...; 但是如果我需要这个逻辑该怎么办呢？也就是说，我确实需要检查是否 x!=y?我该如何重构它？

2) 使用显式作用域而不是默认的包私有级别。但是该类确实仅在包内使用。我应该使用什么访问修饰符？

3) 参数未分配，可以声明为final。我是否应该将final关键字添加到PMD通过此警告指出的所有位置？

Answer 1

避免否定：首先检查积极的情况，而不是if( x!=y ) doThis() else doThat()，因为人们倾向于喜欢积极的事物多于负面。阅读源代码时必须颠倒头脑中的逻辑，这真是绞尽脑汁。因此，请写：

 if ( x!=y ) doThis() else doThat()       // Bad - negation first
 if ( x==y ) doThat() else doThis()       // Good - positive first

明确范围：根据PMD 网站 ，这是一个有争议的规则。你可能讨厌它，但别人会喜欢它。您应该做的是将类中的所有字段设为私有。似乎有一个具有包可见性的字段或方法（而不是类），例如：

 class Foo {
   /* private missing */ Object bar;
 }

最终参数： 方法参数应该是最终的，以避免意外重新分配。这只是一个很好的做法。如果您使用的是 Eclipse，内容辅助甚至提供了一个名为“尽可能将修饰符更改为 Final”的快速修复。只需使用 Ctrl-a 选择编辑器中的所有代码，然后按 Ctrl-1。

Answer 2

您不需要启用所有规则。选择您同意的一些规则并重构您的代码，直到清除所有警告。

1 - 将其重构为 if (x == y) .​​.. else ... 逻辑。只要避免 if 语句中的负面条件，它们会使代码更难理解

2 - 我不会启用该规则。

3 - 很多人将很多字段和变量声明为final。特别是当他们想要确保或表达变量的值不应在方法中更改时。如果您不喜欢这样，请禁用该规则。

Answer 3

这些似乎都是可以关闭的小警告。

1) 它希望你翻转逻辑

if(x==y) {
    //old else clause
} else {
    //old if clause
}

2) 如果 package 确实是你想要的正确访问权限，则无需添加访问修饰符。我不够熟悉，不知道是否有办法抑制该特定警告。

3）风格问题。有些人希望一切都可以最终确定。其他人则认为它增加了太多的混乱，而信息却很少。如果您属于后一个阵营，请关闭该警告。

Answer 4

关于第一项（不等式）有两个问题：

1）双重否定的可读性。

假设：

if(x!=y) { false clause } else { true clause }

如果“not x is not equal to y”，则执行第二个子句。

这可以重写为：

if (x==y) {true clause } else {false clause}.

2）正确性：如果 x 和 y 不是基元，则使用 if(!x.equals(y)) 更安全。
这相当于使用 == 代替 .equals()，并且可能导致非常严重的错误。

Answer 5

您还可以在不希望检查 PMD 规则的任何行的末尾使用 // NOPMD。

例如，对于上面给出的代码，您可以通过给出来抑制 PMD 检查，

class Foo {
   /* private missing */ Object bar; // NOPMD
 }

请注意，上述注释可能会默默地抑制同一行中的其他警告。