用PMD自动执行Java代码静态分析

作者：仙人掌工作室

　　一、基础知识

　　PMD是一种分析Java代码错误的工具。与其他分析工具不同的是，PMD通过静态分析获知代码错误。也就是说，在不运行Java程序的情况下报告错误。PMD附带了许多可以直接使用的规则，利用这些规则可以找出Java源程序的许多问题，例如没有用到的变量、多余的变量创建操作、空的catch块，等等。此外，用户还可以自己定义规则，检查Java代码是否符合某些特定的编码规范。例如，你可以编写一个规则，要求PMD找出所有创建Thread和Socket对象的操作。

　　最初，PMD是为了支持Cougaar项目而开发的。Cougaar是美国国防高级研究计划局（Defense Advanced Research Projects Agency，DARPA）的一个项目。DARPA开放了PMD的源代码，所以PMD被发布到了SourceForge网站上。不久前，PMD的下载次数就超过了14000次，页面浏览次数超过了130000次。更重要的是，在源代码开放作者的努力下，越来越多的PMD规则和IDE插件被开发出来，然后加入到了PMD的核心项目之中。

　　你可以从PMD的网站下载PMD的二进制版本，或下载带源代码的版本，下载得到的都是ZIP文件。假设你下载了二进制版本，先把它解压缩到任意一个目录。接下来怎么做，就要看你准备怎么用它——最简单的，如果要在一个Java源代码目录中运行PMD，只需直接在命令行上运行下面的命令：

C:\data\pmd\pmd>java -jar lib\pmd-1.02.jar c:\j2sdk1.4.1_01\src\java\util
   text rulesets/unusedcode.xml



　　输出结果类如：

c:\j2sdk1.4.1_01\src\java\util\AbstractMap.java 650
    Avoid unused local variables such as ''v''    
c:\j2sdk1.4.1_01\src\java\util\Date.java        438  
    Avoid unused local variables such as ''millis''



　　除了直接在命令行上运行PMD之外，还可以通过Ant、Maven或者各种集成开发环境（IDE）运行PMD，例如jEdit、Netbeans、Eclipse、Emacs、IDEAJ和JBuilder等。

　　二、内建规则

　　PMD本身就附带了许多规则。下面是几个例子。

没有用到的代码显然是应该被清除的。
public class Foo {
   // 下面这个实例变量没有用到
   private List bar = new ArrayList(500);
}
如果用一个接口也能达到同样的目标，为什么要返回一个具体的类？例如，下例可以改用List接口。
public ArrayList getList() {
   return new ArrayList();
}
当if的条件为真时，if代码块其实不做任何事情。下面这段代码其实可以写得更加简洁一些。
public void doSomething(int y) {
   if (y >= 2) {
   } else {
      System.out.println("Less than two");
   }
}
为什么要创建一个新的String对象？只要改用String x="x"就可以了。
String x = new String("x");



　　PMD还包含其他许多内建规则，但从上面几个例子已经可以看出PMD的基本工作方式。只要定义适当的静态规则，PMD就可以象一个富有经验的程序员那样，帮你指出代码存在的问题。

　　三、工作原理

　　PMD的核心是JavaCC解析器生成器。PMD结合运用JavaCC和EBNF（扩展巴科斯-诺尔范式，Extended Backus-Naur Formal）语法，再加上JJTree，把Java源代码解析成抽象语法树（AST，Abstract Syntax Tree）。显然，这句话不那么好懂，且看下文具体说明。

　　从根本上看，Java源代码只是一些普通的文本。不过，为了让解析器承认这些普通的文本是合法的Java代码，它们必须符合某