一、基础知识
$0k7W?tu PMD是一种分析Java代码错误的工具。与其他分析工具不同的是，PMD通过静态分析获知代码错误。也就是说，在不运行Java程序的情况下报告错误。PMD附带了许多可以直接使用的规则，利用这些规则可以找出Java源程序的许多问题，例如没有用到的变量、多余的变量创建操作、空的catch块，等等。此外，用户还可以自己定义规则，检查Java代码是否符合某些特定的编码规范。例如，你可以编写一个规则，要求PMD找出所有创建Thread和Socket对象的操作。
\/64Xv3L0 最初，PMD是为了支持Cougaar项目而开发的。Cougaar是美国国防高级研究计划局（Defense Advanced Research Projects Agency，DARPA）的一个项目。DARPA开放了PMD的源代码，所以PMD被发布到了SourceForge网站上。不久前，PMD的下载次数就超过了14000次，页面浏览次数超过了130000次。更重要的是，在源代码开放作者的努力下，越来越多的PMD规则和IDE插件被开发出来，然后加入到了PMD的核心项目之中。
td7Of(k' 你可以从PMD的网站下载PMD的二进制版本，或下载带源代码的版本，下载得到的都是ZIP文件。假设你下载了二进制版本，先把它解压缩到任意一个目录。接下来怎么做，就要看你准备怎么用它――最简单的，如果要在一个Java源代码目录中运行PMD，只需直接在命令行上运行下面的命令：
+)LCYDRV7 C:\data\pmd\pmd>java -jar lib\pmd-1.02.jar c:\j2sdk1.4.1_01\src\java\util
C_Z/7x*>d text rulesets/unusedcode.xml
}b SDhMV; BA[ uO3\4 输出结果类如：
N\|BaZ%>| c:\j2sdk1.4.1_01\src\java\util\AbstractMap.java 650
q@g#DP+C Avoid unused local variables such as 'v'
Z~F*$jn c:\j2sdk1.4.1_01\src\java\util\Date.java 438
) "Z6Q5k^ Avoid unused local variables such as 'millis'
(D:-p:q. 8@Bm2?$}g 除了直接在命令行上运行PMD之外，还可以通过Ant、Maven或者各种集成开发环境（IDE）运行PMD，例如jEdit、Netbeans、Eclipse、Emacs、IDEAJ和JBuilder等。
}Ogb| 8 二、内建规则
1'N<I Tb PMD本身就附带了许多规则。下面是几个例子。
v *OV\h. 没有用到的代码显然是应该被清除的。
6_:I~TTX public class Foo {
D|*yeS4> // 下面这个实例变量没有用到
9kh MG$ private List bar = new ArrayList(500);
b p<,Xfl }
O >'tag 如果用一个接口也能达到同样的目标，为什么要返回一个具体的类？例如，下例可以改用List接口。
NcB z(" public ArrayList getList() {
k* v ${1& return new ArrayList();
--EDr>'D5P }
<<b]v I 当if的条件为真时，if代码块其实不做任何事情。下面这段代码其实可以写得更加简洁一些。
aIDv~#l public void doSomething(int y) {
N<ux4t z if (y >= 2) {
mx#%oJnsi } else {
a?yU;IKJ System.out.println("Less than two");
{1qr6P," }
N\];
{pe> }
\E[6wB>uN% 为什么要创建一个新的String对象？只要改用String x="x"就可以了。
Ot)S\s> String x = new String("x");
*nYg-) +u&[ j/ PMD还包含其他许多内建规则，但从上面几个例子已经可以看出PMD的基本工作方式。只要定义适当的静态规则，PMD就可以象一个富有经验的程序员那样，帮你指出代码存在的问题。
uq ;yR[w" 三、工作原理
\KzH5 ? PMD的核心是JavaCC解析器生成器。PMD结合运用JavaCC和EBNF（扩展巴科斯-诺尔范式，Extended Backus-Naur Formal）语法，再加上JJTree，把Java源代码解析成抽象语法树（AST，Abstract Syntax Tree）。显然，这句话不那么好懂，且看下文具体说明。
TW|- 0
从根本上看，Java源代码只是一些普通的文本。不过，为了让解析器承认这些普通的文本是合法的Java代码，它们必须符合某种特定的结构要求。这种结构可以用一种称为EBNF的句法元语言表示，通常称为“语法”（Grammar）。JavaCC根据语法要求生成解析器，这个解析器就可以用于解析用Java编程语言编写的程序。
Z~<=I }@ 不过实际运行中的PMD还要经过JJTree的一次转换。JJTree是一个JavaCC的插件，通过AST扩充JavaCC生成的解析器。AST是一个Java符号流之上的语义层。有了JJTree，语法分析的结果不再是“System, ., out, ., . println”之类的符号序列，而是一个由对象构成的树型层次结构。例如，下面是一段简单的Java代码以及与之对应的AST。
&> B" /z Java源代码：
@+l=R| public class Foo {
z(>QGzyc public void bar() {
mz+UkA' System.out.println("hello world");
^Ua6.RH8 }
N:+)
6a }
\Z,{ De% 对应的抽象语法树
:Nv7W t! CompilationUnit
H>W8F2VT TypeDeclaration
C BoCT3@~ ClassDeclaration
.rITzwgB UnmodifiedClassDeclaration
<_ENC>NP ClassBody
iP kCuLQ} ClassBodyDeclaration
{z\K!=X/ MethodDeclaration
oR,6esA+6n ResultType
)$1>6C \ MethodDeclarator
d^J)Mhju FormalParameters
vS
)>g4 Block
Rk[a |T & BlockStatement
J8i,[,KcE Statement
cdh0b7tj n StatementExpression
1. +6x4%rV PrimaryExpression
d$ n31F PrimaryPrefix
/`7+Gy< Name
/aMOZ=,q} PrimarySuffix
hxK;f Arguments
A= 5Ebu!z ArgumentList
} c k <R Expression
2 ,F9P+ PrimaryExpression
&b`W<PAc?4 PrimaryPrefix
PCHspe9!y Literal
Pk I+z_ S,nELV~! 四、编写规则
q[C?1Kc .z 前面我们看到了Java源代码以及与之对应的对象层次结构。下面我们就要利用这些对象编写PMD规则检查代码存在的问题。
|oke)w=gn 一般地，一个PMD规则可以看成一个Visitor，它遍历AST，寻找多个对象之间的一种特定模式，这种模式表示代码存在的问题。问题模式可能简单也可能复杂，简单的如查找代码中是否包含new Thread关键词，复杂的如确定一个类是否正确覆盖了equals和hashcode。
g_`
a_ 0v 下面是一个寻找空if语句的简单PMD规则。
AB`.K{h //扩展AbstractRule，以启用Visitor模式
w3ni@'X8 public class EmptyIfStmtRule extends AbstractRule implements Rule {
>Rd~ -w)!| //当源代码中出现一个Block，下面的方法被调用
,aLw OmO public Object visit(ASTBlock node, Object data){
BkGEx z //如果父节点是一个if语句且代码块里面没有任何内容
XC)9aC@s if ((node.jjtGetParent().jjtGetParent() instanceof ASTIfStatement)
*; ]}`r && node.jjtGetNumChildren()==0) {
ON){d!]uJ //肯定代码存在问题。把一个RuleViolation加入到Report。
@qan &?-Y RuleContext ctx = (RuleContext)data;
Hj|&P/jY]* ctx.getReport().addRuleViolation(createRuleViolation(ctx,
XW nP(C 9? node.getBeginLine()));
| Ia9bg'1U }
C DRbYO //继续检查树的下一个节点
nAEyL+6U return super.visit(node, data);
No} U[u.O }
, d
,2Q }
_OTVQo Ap Mh4MaLw
也许你不能一下子掌握这段代码，其实它的思路还是比较简单的：
(=Cb)/s 0 #扩展AbstractRule基类。
- ~|Gwr" #声明一个“钩子”，一旦我们感兴趣的节点出现，它就会被调用（称为“回调”）。在上面的例子中，我们要求在每一个ASTBlock出现时得到通知，所以声明visit(ASTBlock node, Object data)。
3g;,
#在回调函数中，判断是否出现了我们正在检查的问题。本例我们检查是否存在空的if块，所以先判断当前是否在ASTIfStatement之内，然后判断它是否有子节点。
j t on \9 当然，我们还可以按照另一种方法进行检查：声明一个要求检查ASTIfStatement的回调函数，然后在回调函数中检查是否存在子节点。
%z-*C'j5H 五、配置规则
L;%w{,Ji 写好自定义规则之后，接下来要把它加入到某个PMD规则集。所谓PMD规则集，就是由一组PMD规则构成的集合。每个PMD规则集由一个XML文件定义，下面是一个PMD规则的配置信息的例子：
5C9b*]-# <rule name="EmptyIfStmt"
6<<"9mxK message="避免使用空的if语句"
'2*OrY class="net.sourceforge.pmd.rules.EmptyIfStmtRule">
kuy?n-1g <description>
LCH\;07V# 找到空的if语句：if检查了条件，但if块里面没有任何内容。
w CB*v<* </description>
NBY|U{.g <priority>3</priority>
1wKXOy=v0 <example>
dY S(}U <![CDATA[
]|.ked if (absValue < 1) {
YE{ [f@i0 // not good
hj9TiH/+ }
TXmS$q
</XMLCDATA>
W&*&O,c </example>
$TXxhd 6 </rule>
B5;%R0 1A d"9tP&
Q 可以看出，规则配置文件包含了许多有用的信息。要运行新添加的规则，只需把规则集XML文件和Java源代码文件放入CLASSPATH,淘宝网韩版女装批发，然后运行PMD。
