一、基础知识
D+?/MrP PMD是一种分析Java代码错误的工具。与其他分析工具不同的是，PMD通过静态分析获知代码错误。也就是说，在不运行Java程序的情况下报告错误。PMD附带了许多可以直接使用的规则，利用这些规则可以找出Java源程序的许多问题，例如没有用到的变量、多余的变量创建操作、空的catch块，等等。此外，用户还可以自己定义规则，检查Java代码是否符合某些特定的编码规范。例如，你可以编写一个规则，要求PMD找出所有创建Thread和Socket对象的操作。
tcyami6D4 最初，PMD是为了支持Cougaar项目而开发的。Cougaar是美国国防高级研究计划局（Defense Advanced Research Projects Agency，DARPA）的一个项目。DARPA开放了PMD的源代码，所以PMD被发布到了SourceForge网站上。不久前，PMD的下载次数就超过了14000次，页面浏览次数超过了130000次。更重要的是，在源代码开放作者的努力下，越来越多的PMD规则和IDE插件被开发出来，然后加入到了PMD的核心项目之中。
0A
\OZ^P8 你可以从PMD的网站下载PMD的二进制版本，或下载带源代码的版本，下载得到的都是ZIP文件。假设你下载了二进制版本，先把它解压缩到任意一个目录。接下来怎么做，就要看你准备怎么用它――最简单的，如果要在一个Java源代码目录中运行PMD，只需直接在命令行上运行下面的命令：
P F#+G;q; C:\data\pmd\pmd>java -jar lib\pmd-1.02.jar c:\j2sdk1.4.1_01\src\java\util
FWI<_KZ O text rulesets/unusedcode.xml
Cm g(# $ X x!GHUz*:uz 输出结果类如：
W 1S7%6y_1 c:\j2sdk1.4.1_01\src\java\util\AbstractMap.java 650
AE!DftI Avoid unused local variables such as 'v'
KM$L u2 c:\j2sdk1.4.1_01\src\java\util\Date.java 438
@NlE2s6a Avoid unused local variables such as 'millis'
mn;;wp (UWWULV 除了直接在命令行上运行PMD之外，还可以通过Ant、Maven或者各种集成开发环境（IDE）运行PMD，例如jEdit、Netbeans、Eclipse、Emacs、IDEAJ和JBuilder等。
v3!oY t:l 二、内建规则
umZy=KH
j PMD本身就附带了许多规则。下面是几个例子。
0o~? ]C 没有用到的代码显然是应该被清除的。
y}5V 3)P public class Foo {
a^_ \ #,} // 下面这个实例变量没有用到
6lw) L private List bar = new ArrayList(500);
l"^'uGB'
}
|?k3I/; 如果用一个接口也能达到同样的目标，为什么要返回一个具体的类？例如，下例可以改用List接口。
u;p.:{' public ArrayList getList() {
:VpRpj4f return new ArrayList();
y J*`OU# }
;sd[Q01 当if的条件为真时，if代码块其实不做任何事情。下面这段代码其实可以写得更加简洁一些。
("-Co,4ey public void doSomething(int y) {
(o s}s8cIh if (y >= 2) {
%+gYZ v- } else {
=Hplg>h) System.out.println("Less than two");
S} 6Ty2.\ }
tKOTQ8i4 }
vY Q0 e:P 为什么要创建一个新的String对象？只要改用String x="x"就可以了。
D^ZG- WR String x = new String("x");
l,j7I3&~% w SoIU,I PMD还包含其他许多内建规则，但从上面几个例子已经可以看出PMD的基本工作方式。只要定义适当的静态规则，PMD就可以象一个富有经验的程序员那样，帮你指出代码存在的问题。
<
[mT *
三、工作原理
Q ND{3Q PMD的核心是JavaCC解析器生成器。PMD结合运用JavaCC和EBNF（扩展巴科斯-诺尔范式，Extended Backus-Naur Formal）语法，再加上JJTree，把Java源代码解析成抽象语法树（AST，Abstract Syntax Tree）。显然，这句话不那么好懂，且看下文具体说明。
pw|f4c7AH 从根本上看，Java源代码只是一些普通的文本。不过，为了让解析器承认这些普通的文本是合法的Java代码，它们必须符合某种特定的结构要求。这种结构可以用一种称为EBNF的句法元语言表示，通常称为“语法”（Grammar）。JavaCC根据语法要求生成解析器，这个解析器就可以用于解析用Java编程语言编写的程序。
=@ (&xfTC 不过实际运行中的PMD还要经过JJTree的一次转换。JJTree是一个JavaCC的插件，通过AST扩充JavaCC生成的解析器。AST是一个Java符号流之上的语义层。有了JJTree，语法分析的结果不再是“System, ., out, ., . println”之类的符号序列，而是一个由对象构成的树型层次结构。例如，下面是一段简单的Java代码以及与之对应的AST。
xR;>n[
6 Java源代码：
" &2Kvsz public class Foo {
n{sF'n</ public void bar() {
Vb^ P{F System.out.println("hello world");
uYVlF@] }
"TW%-67
}
&Omo\Oq&W> 对应的抽象语法树
lz2B,# CompilationUnit
02B *cz_K TypeDeclaration
_8x:%$ ClassDeclaration
U
hKC:<% UnmodifiedClassDeclaration
T
DOOq;+ ClassBody
w#|uR ^~ ClassBodyDeclaration
ZL/iX~}a' MethodDeclaration
o
4G%m>$ ResultType
|a
9d]^ MethodDeclarator
QOXG:?v\ FormalParameters
{*utke]}* Block
$yxwB/ O( BlockStatement
n;&08M5an} Statement
r }351S5( StatementExpression
to9~l"n.s PrimaryExpression
:[![9JS/ PrimaryPrefix
'fpm] *ig Name
\Ps}1)w T PrimarySuffix
JSz;>
Arguments
1 ; _t u ArgumentList
<u "xHl8Io Expression
b(^/WCykH PrimaryExpression
*_feD
+rq PrimaryPrefix
[ Q"*I2 & Literal
)F _vWbg S,ZlS<Z# 四、编写规则
6ub-NtVu 前面我们看到了Java源代码以及与之对应的对象层次结构。下面我们就要利用这些对象编写PMD规则检查代码存在的问题。
L#U-d zy\ 一般地，一个PMD规则可以看成一个Visitor，它遍历AST，寻找多个对象之间的一种特定模式，这种模式表示代码存在的问题。问题模式可能简单也可能复杂，简单的如查找代码中是否包含new Thread关键词，复杂的如确定一个类是否正确覆盖了equals和hashcode。
wW2b?b{*Z 下面是一个寻找空if语句的简单PMD规则。
{A!1s; //扩展AbstractRule，以启用Visitor模式
h-r\ 1{Q1] public class EmptyIfStmtRule extends AbstractRule implements Rule {
|2RoDW //当源代码中出现一个Block，下面的方法被调用
r'bctFsD public Object visit(ASTBlock node, Object data){
Xwz9E!m //如果父节点是一个if语句且代码块里面没有任何内容
2J?ON|2M if ((node.jjtGetParent().jjtGetParent() instanceof ASTIfStatement)
>s0A.7,5 && node.jjtGetNumChildren()==0) {
BK>3rjXi>a //肯定代码存在问题。把一个RuleViolation加入到Report。
\S #Mc RuleContext ctx = (RuleContext)data;
bY`
b3 ctx.getReport().addRuleViolation(createRuleViolation(ctx,
E"i<fr
T node.getBeginLine()));
`)5,!QPQ7u }
."`mh&+` //继续检查树的下一个节点
Nr~9] S return super.visit(node, data);
Pw c)u& }
VpmwN`
}
o[=h=&@5p q!UN<+k\h 也许你不能一下子掌握这段代码，其实它的思路还是比较简单的：
R1't W= #扩展AbstractRule基类。
W5 l)mAv #声明一个“钩子”，一旦我们感兴趣的节点出现，它就会被调用（称为“回调”）。在上面的例子中，我们要求在每一个ASTBlock出现时得到通知，所以声明visit(ASTBlock node, Object data)。
*[XVkt`H #在回调函数中，判断是否出现了我们正在检查的问题。本例我们检查是否存在空的if块，所以先判断当前是否在ASTIfStatement之内，然后判断它是否有子节点。
87&BF )] 当然，我们还可以按照另一种方法进行检查：声明一个要求检查ASTIfStatement的回调函数，然后在回调函数中检查是否存在子节点。
2=R}u-@6p 五、配置规则
_6U=7<f 写好自定义规则之后，接下来要把它加入到某个PMD规则集。所谓PMD规则集，就是由一组PMD规则构成的集合。每个PMD规则集由一个XML文件定义，下面是一个PMD规则的配置信息的例子：
T2EQQFs <rule name="EmptyIfStmt"
= ;tDYuFc! message="避免使用空的if语句"
tj ONN(K` class="net.sourceforge.pmd.rules.EmptyIfStmtRule">
|76G#K~<X <description>
(29h{= P' 找到空的if语句：if检查了条件，但if块里面没有任何内容。
d}d1]@Y \ </description>
=yT3#A~<G <priority>3</priority>
F7o#KN *.] <example>
R0 yPmh,{ <
