全面剖析PMD静态代码扫描工具

这是个人原创的一篇全面介绍PMD静态代码扫描工具的文档，最近部门需要调研静态代码扫描工具以提高代码的质量，经过对比几十款工具，剔除了商用和多年没有更新的，最终锁定的有PMD、SanorQube以及Facebook infer。

PMD是使用JavaCC生成解析器来解析源代码并生成AST(抽象语法树)的，这两天对PMD及自定义规则做了调研及实验，部分说明来自官方说明文档，做了大部分参数的详细描述及测试，少数几个参数不明白含义，有了解的朋友欢迎讨论。

1     调研对象

pmd-bin-6.4.0【PMD可执行版本】

·      bin

·      designer.bat【界面工具，能将java源代码转化为AST（抽象语法树），个人推荐使用】

·      bgastviewer.bat【界面工具，与designer.bat功能相似】

·      cpd.bat【用来查找重复代码的工具，命令行版】

·      cpdgui.bat【用来查找重复代码的工具，GUI版】

·      pmd.bat【Window平台下运行PMD需要使用的文件】

·      run.sh【Linux平台下运行PMD需要使用的文件】

·      lib【该目录存放PMD运行依赖的jar包，包括第三方jar包和各种语言的模块jar包】

 

2 基本使用

格式：pmd -d [filename|jar or zip file containing source code|directory]-f [report format] -R [ruleset file]

示例：E:\pmd-bin-6.4.0>bin\pmd.bat -d E:\name -f html -R java-basic,java-design

如果要将生成的结果保存出来可以使用命令行重定向保存到指定路径——

E:\pmd-bin-6.4.0>bin\pmd.bat -d E:\name -f html -R java-basic,java-design>report.html

Option	Description	Required	Applies for language
-rulesets / -R	Comma separated list of rulese