用于强制圈复杂度和 LCOM 约束的注释

Question

在工作中，我们使用多种工具来捕获多种指标（主要是圈复杂度和 LCOM）。我们使用它们来获取警告标志并指导先发制人的重构工作。这对于提高代码质量非常有益。

但是，该过程与构建过程无关。它是单独进行的。此外，我正在寻找可以成为源代码固有的东西（而不是在其上运行的外部进程。）

是否有人知道可以从编译器，如果代码不符合阈值圈/LCOM 指标，这将使构建失败？

我想我可以从 maven/ant 运行 ckjm、checkstyle 和 pmd，但是一些工作在源代码上，其他工作在字节码上。如果有一个可以在编译开始之前处理源代码的综合工具，那就太好了。

另一件事是，如果有一组注释可以驱动它（以允许在极端情况下不可避免地需要的自定义），那就太好了。

@LCOM3(Threshold=1.5)
public class SomeDumbPojo {... buch of gets/sets...}

// by default would be measured against a strict LCOM3
public class ActualBizClass
{
   @CYCLOMATIC_COMPLEXITY(Threshold=15)
   public void someFatIrreducibleMethod(){...}
}

然后，当我们运行该工具时，默认情况下应用严格（并且可配置） ）度量阈值，除了那些用（希望有记录且合法的）更宽松的阈值注释的工件。对于一些不能/不应该减少的方法，放宽圈复杂度是有意义的。对于没有行为的普通 POJO，LCOM 需要放松......等等。

尽管我可能进行查找和谷歌搜索，但我找不到任何东西（希望是开源的）。但我不妨在这里问一下，以防万一有人知道此类事情。

谢谢。

Answer 1

如果有一个可以在编译开始之前处理源代码的综合工具，那就太好了。

我不太确定这意味着什么，因为必须将代码编译成某种东西才能使静态分析发挥作用。所有这些工具都需要能够将代码编译为字节码或某种语法树。

我建议保持简单：配置 PMD，如果环复杂度或其他指标的任何警告超过给定阈值，则构建失败。不要用允许的复杂性来注释该方法（您如何得出可接受的值？如何防止有人意外地将复杂性从 12 增加到 15 以增加注释），而是对其进行注释以完全抑制警告，

@SuppressWarnings("PMD.CyclomaticComplexity")
public void someFatIrreducibleMethod() { ... }

然后定期您可以在代码库中搜索包含您可能想要删除和重构的抑制警告的方法。

或者，如果您想提供某种可追溯性，PMD 支持以某种语法在代码中留下注释，以标记谁审核了警告以及何时审核。

Answer 2

SD Java Metrics 工具计算最基本的指标（不是 LCOM，而是肯定的圈复杂度） ），并从命令行运行。

它生成一个 XML 输出文件，其中包含有关方法的详细度量以及上面的层次结构（类、包、子系统）的汇总摘要。使用 XLST（或 awk 或 perl 或...）可以很容易地提取完整摘要或单个方法所需的指标，并根据您的阈值进行检查。