一、基础知识
yAoe51h? PMD是一种分析Java代码错误的工具。与其他分析工具不同的是，PMD通过静态分析获知代码错误。也就是说，在不运行Java程序的情况下报告错误。PMD附带了许多可以直接使用的规则，利用这些规则可以找出Java源程序的许多问题，例如没有用到的变量、多余的变量创建操作、空的catch块，等等。此外，用户还可以自己定义规则，检查Java代码是否符合某些特定的编码规范。例如，你可以编写一个规则，要求PMD找出所有创建Thread和Socket对象的操作。
gy&[?m6M= 最初，PMD是为了支持Cougaar项目而开发的。Cougaar是美国国防高级研究计划局（Defense Advanced Research Projects Agency，DARPA）的一个项目。DARPA开放了PMD的源代码，所以PMD被发布到了SourceForge网站上。不久前，PMD的下载次数就超过了14000次，页面浏览次数超过了130000次。更重要的是，在源代码开放作者的努力下，越来越多的PMD规则和IDE插件被开发出来，然后加入到了PMD的核心项目之中。
&f&z_WU 你可以从PMD的网站下载PMD的二进制版本，或下载带源代码的版本，下载得到的都是ZIP文件。假设你下载了二进制版本，先把它解压缩到任意一个目录。接下来怎么做，就要看你准备怎么用它――最简单的，如果要在一个Java源代码目录中运行PMD，只需直接在命令行上运行下面的命令：
. 'Y]R3\M+ C:\data\pmd\pmd>java -jar lib\pmd-1.02.jar c:\j2sdk1.4.1_01\src\java\util
\ Y"W
u text rulesets/unusedcode.xml
|SyMngIY R: l&2k@ 输出结果类如：
fk_o@
G!0 c:\j2sdk1.4.1_01\src\java\util\AbstractMap.java 650
zN
[2YJ$ Avoid unused local variables such as 'v'
<=f}8a.R3 c:\j2sdk1.4.1_01\src\java\util\Date.java 438
`Od5Gh Avoid unused local variables such as 'millis'
NH+(?TN lo[.&GD 除了直接在命令行上运行PMD之外，还可以通过Ant、Maven或者各种集成开发环境（IDE）运行PMD，例如jEdit、Netbeans、Eclipse、Emacs、IDEAJ和JBuilder等。
liXdNk8 二、内建规则
(\SA *.) PMD本身就附带了许多规则。下面是几个例子。
!Q#{o^{Y~ 没有用到的代码显然是应该被清除的。
i&
VsW7 public class Foo {
s8}@=]aA // 下面这个实例变量没有用到
hiQha5 private List bar = new ArrayList(500);
jYe'V#5S# }
U w
47LP 如果用一个接口也能达到同样的目标，为什么要返回一个具体的类？例如，下例可以改用List接口。
0} b
tXh public ArrayList getList() {
TYy.jFT- return new ArrayList();
YCP
) %} }
V,$0p1?J 当if的条件为真时，if代码块其实不做任何事情。下面这段代码其实可以写得更加简洁一些。
xD6@Qk public void doSomething(int y) {
WL'P)lI5 if (y >= 2) {
3+XOZ
h8 } else {
>uSy System.out.println("Less than two");
5=f|7y l }
mya_4I
m }
t25,0<iW 为什么要创建一个新的String对象？只要改用String x="x"就可以了。
?]*^xL;x? String x = new String("x");
,G2TVjz bFW =ylF9 PMD还包含其他许多内建规则，但从上面几个例子已经可以看出PMD的基本工作方式。只要定义适当的静态规则，PMD就可以象一个富有经验的程序员那样，帮你指出代码存在的问题。
l(02W 三、工作原理
/
oriW;OF PMD的核心是JavaCC解析器生成器。PMD结合运用JavaCC和EBNF（扩展巴科斯-诺尔范式，Extended Backus-Naur Formal）语法，再加上JJTree，把Java源代码解析成抽象语法树（AST，Abstract Syntax Tree）。显然，这句话不那么好懂，且看下文具体说明。
t2l S
~l) 从根本上看，Java源代码只是一些普通的文本。不过，为了让解析器承认这些普通的文本是合法的Java代码，它们必须符合某种特定的结构要求。这种结构可以用一种称为EBNF的句法元语言表示，通常称为“语法”（Grammar）。JavaCC根据语法要求生成解析器，这个解析器就可以用于解析用Java编程语言编写的程序。
!_"fP:T> 不过实际运行中的PMD还要经过JJTree的一次转换。JJTree是一个JavaCC的插件，通过AST扩充JavaCC生成的解析器。AST是一个Java符号流之上的语义层。有了JJTree，语法分析的结果不再是“System, ., out, ., . println”之类的符号序列，而是一个由对象构成的树型层次结构。例如，下面是一段简单的Java代码以及与之对应的AST。
62Z#Y Q}x Java源代码：
!T
UrQ public class Foo {
,gS;m
&!'J public void bar() {
;1a~pF S System.out.println("hello world");
;UfCj5`Q)4 }
ypy
68_xyW }
{HCz p,Y 对应的抽象语法树
Rp5#clsy CompilationUnit
hC\6-
0u TypeDeclaration
BG<q IQd ClassDeclaration
'#&os`mQ UnmodifiedClassDeclaration
1~PV[2a ClassBody
~/P&Tub^ ClassBodyDeclaration
LbkF
MethodDeclaration
|6$ p;Aar ResultType
(_"*NY0 MethodDeclarator
/C6k+0ApMT FormalParameters
@w?P7P<O` Block
sIxTG y. BlockStatement
RS^lKJ1 U Statement
R.yC(r StatementExpression
'JRvP!] PrimaryExpression
HbxL:~:}J PrimaryPrefix
6E^.7%3 Name
3h *!V6%q PrimarySuffix
oIduxbA p Arguments
xj VS ArgumentList
@ g&ct >@y Expression
-&-Ma,M? PrimaryExpression
1
=M ?GDc PrimaryPrefix
r_-_a(1R: Literal
&8vCZN^ /|D*w^ > 四、编写规则
CL+}| 7O( 前面我们看到了Java源代码以及与之对应的对象层次结构。下面我们就要利用这些对象编写PMD规则检查代码存在的问题。
`nZ )> 一般地，一个PMD规则可以看成一个Visitor，它遍历AST，寻找多个对象之间的一种特定模式，这种模式表示代码存在的问题。问题模式可能简单也可能复杂，简单的如查找代码中是否包含new Thread关键词，复杂的如确定一个类是否正确覆盖了equals和hashcode。
d%o &+l# 下面是一个寻找空if语句的简单PMD规则。
IyWI5Q"t //扩展AbstractRule，以启用Visitor模式
HxIIO[h public class EmptyIfStmtRule extends AbstractRule implements Rule {
JW3B'_0 //当源代码中出现一个Block，下面的方法被调用
TL}++e
7+ public Object visit(ASTBlock node, Object data){
;
J ayoJ //如果父节点是一个if语句且代码块里面没有任何内容
K5xX)oV if ((node.jjtGetParent().jjtGetParent() instanceof ASTIfStatement)
D"a~ #^ && node.jjtGetNumChildren()==0) {
j 'HZ\_ //肯定代码存在问题。把一个RuleViolation加入到Report。
njWL U! RuleContext ctx = (RuleContext)data;
n\^Tq<] a ctx.getReport().addRuleViolation(createRuleViolation(ctx,
N19({0+i2 node.getBeginLine()));
.p e( lP }
a+%6B_|\ //继续检查树的下一个节点
/J WGifH return super.visit(node, data);
yge,8i)c }
/K . !sQ$ }
"-+\R}q$ 5) pj]S!]- 也许你不能一下子掌握这段代码，其实它的思路还是比较简单的：
A}3=561F?5 #扩展AbstractRule基类。
m>MB7,C;N #声明一个“钩子”，一旦我们感兴趣的节点出现，它就会被调用（称为“回调”）。在上面的例子中，我们要求在每一个ASTBlock出现时得到通知，所以声明visit(ASTBlock node, Object data)。
i}B2R$Z3 #在回调函数中，判断是否出现了我们正在检查的问题。本例我们检查是否存在空的if块，所以先判断当前是否在ASTIfStatement之内，然后判断它是否有子节点。
a_'2V; 当然，我们还可以按照另一种方法进行检查：声明一个要求检查ASTIfStatement的回调函数，然后在回调函数中检查是否存在子节点。
# ?/
<
五、配置规则
UOx kO 写好自定义规则之后，接下来要把它加入到某个PMD规则集。所谓PMD规则集，就是由一组PMD规则构成的集合。每个PMD规则集由一个XML文件定义，下面是一个PMD规则的配置信息的例子：
}<9cL' <rule name="EmptyIfStmt"
TzNn^ir=HX message="避免使用空的if语句"
p
_${Nj class="net.sourceforge.pmd.rules.EmptyIfStmtRule">
Nn T1X;0W <description>
<gQI q{
B? 找到空的if语句：if检查了条件，但if块里面没有任何内容。
V 7Ek-2M </description>
pUV/ Ul] <priority>3</priority>
^ h"`}[+ <example>
=AEBeiz <![CDATA[
i;_t I#:A if (absValue < 1) {
XYZ4TeW\1 // not good
@ CZ
T }
qa0 yg8,< </XMLCDATA>
$Z\.-QE\ </example>
Y]B)'[=h </rule>
]]oI#*c VCD:3U
8
可以看出，规则配置文件包含了许多有用的信息。要运行新添加的规则，只需把规则集XML文件和Java源代码文件放入CLASSPATH,淘宝网韩版女装批发，然后运行PMD。
