一、基础知识
?Tl@e PMD是一种分析Java代码错误的工具。与其他分析工具不同的是，PMD通过静态分析获知代码错误。也就是说，在不运行Java程序的情况下报告错误。PMD附带了许多可以直接使用的规则，利用这些规则可以找出Java源程序的许多问题，例如没有用到的变量、多余的变量创建操作、空的catch块，等等。此外，用户还可以自己定义规则，检查Java代码是否符合某些特定的编码规范。例如，你可以编写一个规则，要求PMD找出所有创建Thread和Socket对象的操作。
ZH}NlEn 最初，PMD是为了支持Cougaar项目而开发的。Cougaar是美国国防高级研究计划局（Defense Advanced Research Projects Agency，DARPA）的一个项目。DARPA开放了PMD的源代码，所以PMD被发布到了SourceForge网站上。不久前，PMD的下载次数就超过了14000次，页面浏览次数超过了130000次。更重要的是，在源代码开放作者的努力下，越来越多的PMD规则和IDE插件被开发出来，然后加入到了PMD的核心项目之中。
A;|DQR() 你可以从PMD的网站下载PMD的二进制版本，或下载带源代码的版本，下载得到的都是ZIP文件。假设你下载了二进制版本，先把它解压缩到任意一个目录。接下来怎么做，就要看你准备怎么用它――最简单的，如果要在一个Java源代码目录中运行PMD，只需直接在命令行上运行下面的命令：
L_.}z)S[\ C:\data\pmd\pmd>java -jar lib\pmd-1.02.jar c:\j2sdk1.4.1_01\src\java\util
K%gFD?{^q text rulesets/unusedcode.xml
=
]@xXVf/ xsTxc&0^ 输出结果类如：
s{,e ^T c:\j2sdk1.4.1_01\src\java\util\AbstractMap.java 650
# _7c>gn Avoid unused local variables such as 'v'
q@sH@-z4] c:\j2sdk1.4.1_01\src\java\util\Date.java 438
} O>Zu[8a Avoid unused local variables such as 'millis'
r{TNPa6! 9@1W= sl 除了直接在命令行上运行PMD之外，还可以通过Ant、Maven或者各种集成开发环境（IDE）运行PMD，例如jEdit、Netbeans、Eclipse、Emacs、IDEAJ和JBuilder等。
i4p
JIb 二、内建规则
\1MDCP9: PMD本身就附带了许多规则。下面是几个例子。
eLTNnz 没有用到的代码显然是应该被清除的。
5&kR1Bp#- public class Foo {
#NE^f2 // 下面这个实例变量没有用到
lET)<V(Y private List bar = new ArrayList(500);
Kje+Niz7 }
=B:poh[u 如果用一个接口也能达到同样的目标，为什么要返回一个具体的类？例如，下例可以改用List接口。
&7 W6I M public ArrayList getList() {
>ahj|pm return new ArrayList();
j41:]6 }
*nc4X9 当if的条件为真时，if代码块其实不做任何事情。下面这段代码其实可以写得更加简洁一些。
w7D:0SGD public void doSomething(int y) {
KC(Ug4 if (y >= 2) {
bn`zI~WS } else {
L)+ eM& W System.out.println("Less than two");
KC T8Q!\ }
&\H5*A.HkA }
]03ZrZ!
PM 为什么要创建一个新的String对象？只要改用String x="x"就可以了。
3a qmK.`H String x = new String("x");
h+W^k+~( Vj]kJ,j\
y PMD还包含其他许多内建规则，但从上面几个例子已经可以看出PMD的基本工作方式。只要定义适当的静态规则，PMD就可以象一个富有经验的程序员那样，帮你指出代码存在的问题。
%aKkk)s 三、工作原理
.'a |St PMD的核心是JavaCC解析器生成器。PMD结合运用JavaCC和EBNF（扩展巴科斯-诺尔范式，Extended Backus-Naur Formal）语法，再加上JJTree，把Java源代码解析成抽象语法树（AST，Abstract Syntax Tree）。显然，这句话不那么好懂，且看下文具体说明。
VM,ZEt3Vy 从根本上看，Java源代码只是一些普通的文本。不过，为了让解析器承认这些普通的文本是合法的Java代码，它们必须符合某种特定的结构要求。这种结构可以用一种称为EBNF的句法元语言表示，通常称为“语法”（Grammar）。JavaCC根据语法要求生成解析器，这个解析器就可以用于解析用Java编程语言编写的程序。
0/
6&2 不过实际运行中的PMD还要经过JJTree的一次转换。JJTree是一个JavaCC的插件，通过AST扩充JavaCC生成的解析器。AST是一个Java符号流之上的语义层。有了JJTree，语法分析的结果不再是“System, ., out, ., . println”之类的符号序列，而是一个由对象构成的树型层次结构。例如，下面是一段简单的Java代码以及与之对应的AST。
(lnQ ! 4LK Java源代码：
d<Os TA public class Foo {
(FaT{W{ public void bar() {
_UB
I,Dg] System.out.println("hello world");
qL P +@wbJ }
16>uD;G }
?>y-5B[K/( 对应的抽象语法树
p~.@8r( CompilationUnit
)
G{v>Z , TypeDeclaration
zoJ;5a.3B ClassDeclaration
k:TfE6JZ UnmodifiedClassDeclaration
gAj)3T@
ClassBody
SIl
g ClassBodyDeclaration
6a?y $+pr MethodDeclaration
}j?S?= ;m= ResultType
*o[%?$8T
MethodDeclarator
:#/bA& FormalParameters
vxeT[/6i Block
J qUVGEg BlockStatement
KVR}Tp/R Statement
;SW-df o2i StatementExpression
nsT|, O PrimaryExpression
tTt3D]h(
PrimaryPrefix
=5ih,>>g Name
5u46Vl{ PrimarySuffix
j '' Iai_ Arguments
+29\'w, ArgumentList
`0i3"06l
r Expression
$vBU}~l7 PrimaryExpression
2eU[*x PrimaryPrefix
-W_s]oBg Literal
BFO Fes`>~ m GhJn 四、编写规则
,}tdfkZFYl 前面我们看到了Java源代码以及与之对应的对象层次结构。下面我们就要利用这些对象编写PMD规则检查代码存在的问题。
B`scuLl3 一般地，一个PMD规则可以看成一个Visitor，它遍历AST，寻找多个对象之间的一种特定模式，这种模式表示代码存在的问题。问题模式可能简单也可能复杂，简单的如查找代码中是否包含new Thread关键词，复杂的如确定一个类是否正确覆盖了equals和hashcode。
S=}~I 下面是一个寻找空if语句的简单PMD规则。
{^W,e ^: //扩展AbstractRule，以启用Visitor模式
7LwS =yP public class EmptyIfStmtRule extends AbstractRule implements Rule {
sAoM=n}! //当源代码中出现一个Block，下面的方法被调用
D-GU"^-9 public Object visit(ASTBlock node, Object data){
U !/nD~A //如果父节点是一个if语句且代码块里面没有任何内容
(U_Q7hj a? if ((node.jjtGetParent().jjtGetParent() instanceof ASTIfStatement)
y!gM)9vq && node.jjtGetNumChildren()==0) {
!C#RW=h9 //肯定代码存在问题。把一个RuleViolation加入到Report。
+q/h:q.TV RuleContext ctx = (RuleContext)data;
Qs9 U&*L ctx.getReport().addRuleViolation(createRuleViolation(ctx,
358/t/4 {p node.getBeginLine()));
pq3 A%| }
,)$KS*f"*z //继续检查树的下一个节点
;a&:r7]= return super.visit(node, data);
Pp_3 n yQ }
Wi?%)hur }
Sx)Il~ x s[q4K 也许你不能一下子掌握这段代码，其实它的思路还是比较简单的：
c@-
K #扩展AbstractRule基类。
Z d U{`>v #声明一个“钩子”，一旦我们感兴趣的节点出现，它就会被调用（称为“回调”）。在上面的例子中，我们要求在每一个ASTBlock出现时得到通知，所以声明visit(ASTBlock node, Object data)。
DBBBpb~~ #在回调函数中，判断是否出现了我们正在检查的问题。本例我们检查是否存在空的if块，所以先判断当前是否在ASTIfStatement之内，然后判断它是否有子节点。
5%+}rSn7 当然，我们还可以按照另一种方法进行检查：声明一个要求检查ASTIfStatement的回调函数，然后在回调函数中检查是否存在子节点。
r ` &|)
Hx 五、配置规则
<aaDW 写好自定义规则之后，接下来要把它加入到某个PMD规则集。所谓PMD规则集，就是由一组PMD规则构成的集合。每个PMD规则集由一个XML文件定义，下面是一个PMD规则的配置信息的例子：
[
5W#1 & <rule name="EmptyIfStmt"
WcwW@cY7\ message="避免使用空的if语句"
%^=!s class="net.sourceforge.pmd.rules.EmptyIfStmtRule">
5TneuG[OD <description>
^<\} Y 找到空的if语句：if检查了条件，但if块里面没有任何内容。
q#&#*6 )B </description>
`Kw"XGT <priority>3</priority>
En9]x"_ <example>
e=l5j"gq <
