java - 如何在不使用 I/O 的情况下获取 PMD 报告及其详细信息？

Question

我正在尝试使用自定义规则集生成 PMD 报告。输入是一堆字符串格式的 Apex 类。在不输出到文件的情况下，我想直接解析报告内容(XML 格式)以创建违规摘要、开始/结束行、优先级、规则名称和附加消息。这是在 Apex 代码的多个主体上完成的，每次发生违规时都会添加到报告 bean。

我试图用 SourceCodeProcessor 来做到这一点，但无法弄清楚一些所需的对象/参数是什么样的，也不知道它们是如何构建的。我仍然不知道如何创建 RuleContext 对象属性。

非常感谢任何帮助。

Answer 1

根据您打算做什么，我会采取稍微不同的方法(我是 PMD 维护者)。

SourceCodeProcessor是非常低级的。这是编排整个分析过程的实际位置，但错过了到达那里的大部分有趣的设置。

还值得注意的是，SourceCodeProcessor处理单个文件。对于 Apex，这目前可能没有什么区别，但 PMD 越来越倾向于在分析之间交叉信息(即:我们计划将当前的数据流分析/控制流图代码扩展到进程间调用)，因此能够让 PMD 在一次运行中控制完整的项目分析将是最好的。

因此，我会看一下 PMD.doPmd 。您可能应该编写自己的此类方法版本，但涵盖大部分基础知识:

1. 创建 PMDConfiguration对象与您的设置(线程、要使用的规则集等)
2. 有RuleSetFacory根据您的配置创建规则集
3. 获得List<DataSource>以及要分析的来源
4. 创建 RuleContext
5. 设置a listener for the report 。这将允许您直接以 POJO 的形式获取违规行为(您可以避免实际生成报告文件并解析它)
6. 调用 PMD.processFiles 实际进行分析。

您应该与 PMD 目前所做的有所不同的一点是步骤 3。您应该创建一个 FileDataSource 列表，而不是指向文件 ( ReaderDataSource )。 ，使用 StringReader 围绕您从数据库检索的源代码字符串。

您的代码非常少，只需连接 PMD 中已有的不同部分即可。

附注这种方法的另一个优点是 PMD它是 PMD 的一个非常高级的类别，它是在未来版本中最不可能发生 API 更改的类别之一。 PMD 最近采用了语义版本控制，即将发布的版本 (6.0.0) 将引入多项 API 更改/删除已弃用的方法和类。

附注2:这可能不是提出这个问题的最佳地点...我主要是偶然遇到这个问题的，我认为任何不熟悉 PMD 内部结构的人都无法提供帮助。您可能希望更直接地联系 PMD 开发团队(开发邮件列表、Github 等)。