准备工作
首先在PMD官网下载最新版本的文件，目前最新版本是5.4.1。
下载pmd-bin-5.4.1.zip和pmd-src-5.4.1.zip之后解压备用。
pmd-src-5.4.1是PMD源码包，是无法直接执行的。
pmd-bin-5.4.1是PMD的可执行包
目录简介
pmd-src-5.4.1中除了pmd-core是PMD的核心执行调度模块，其他文件夹都是各种语言检查规则的模块。
其中pmd-bin-5.4.1\lib目录中是执行所依赖的jar包。
pmd-bin-5.4.1\bin目录中文件介绍：
pmd.bat和run.sh分别是在window和linux平台下运行用文件。
使用示例：
C:\tmp\pmd-bin-5.4.1\pmd\bin>pmd -d c:\data\pmd\pmd\test-data\Unused1.java -f xml -R rulesets/java/unusedcode.xml
<?xml version="1.0"?><pmd>
<file name="c:\data\pmd\pmd\test-data\Unused1.java">
<violation line="5" rule="UnusedLocalVariable">
Avoid unused local variables such as ‘fr‘
</violation>
</file></pmd>bgastviewer.bat和designer.bat是能将源代码转化为AST（抽象语法树）的界面工具，其中designer.bat比较常用。
cpd.bat和cpdgui.bat是查找重复代码的工具（CPD：Copy/Paste Detector）。
自定义规则实现思路
- 明确想要自定义的规则。
- 列举会触犯这种规则的所有不同的写法。
- 使用designer.bat分析所有写法的抽象语法树的特点。
- 编写规则代码捕捉这种特点。
- 创建自己的xml规则文件，内容包括规则的相关信息。
- 运行PMD扫描错误代码，验证是否能触发自定义规则。
下面以一个比较简单的规则举例，详细的阐述一下实现这个规则的具体步骤。
Java 或 XPath?
这里有两种编写规则的方法：
1. 使用Java进行编写
2. 使用XPath表达式
想明白你想要寻找什么
让我们找出我们想定位的问题。下面以“While循环必须使用括号”这条规则为例，以下代码就是问题样例的代码。没有括号很容易困惑代码结构。
class Example {
void bar() {
while (baz)
buz.doSomething();
}
}弄清楚样例代码是什么样子的，就成功了一半。
写一个测试数据的例子,查看AST
PMD扫描时并不是直接使用源码；它使用JavaCC生成解析器来解析源代码并生成AST(抽象语法树)。以上代码解析成抽象语法树后如下：
CompilationUnit
TypeDeclaration
ClassDeclaration:(package private)
UnmodifiedClassDeclaration(Example)
ClassBody
ClassBodyDeclaration
MethodDeclaration:(package private)
ResultType
MethodDeclarator(bar)
FormalParameters
Block
BlockStatement
Statement
WhileStatement
Expression
PrimaryExpression
PrimaryPrefix
Name:baz
Statement
StatementExpression:null
PrimaryExpression
PrimaryPrefix
Name:buz.doSomething
PrimarySuffix
Arguments你可以使用PMD自带的designer工具进行解析代码。
该工具所在目录：pmd-bin-5.4.1/bin/designer.bat
双击designer.bat后出现一个界面，在Source code中填入源代码，点击Go按钮：
图片中Abstract Syntax Tree/XPath/Symbol Table的位置就是抽象后的树形结构，这个树形结构和源代码是有对应关系的。
其中我们需要重点关注的WhileStatement的抽象树结构如下：
WhileStatement
Expression
Statement
StatementExpression这个是错误的代码示例的抽象树结构，如果While循环加上了括号，抽象树的结构就会变成：
WhileStatement
Expression
Statement
Block
BlockStatement
Statement
StatementExpression哈哈！这下能明显的看到了比之前多处了Block和BlockStatement这两个节点。
这样我们只需要写一个规则检查WhileStatement下没有Block节点，只有Statement时，就可以报警告知这里是有问题的。
顺便提一句，所有的结构信息，比如一个Statement后面可能跟着一个Block，这些都是在EBNF grammar中定义的。比如在这个语法定义中，一个Statement的定义是这样的：
void Statement() :
{}
{
LOOKAHEAD( { isNextTokenAnAssert() } ) AssertStatement()
| LOOKAHEAD(2) LabeledStatement()
| Block()
| EmptyStatement()
| StatementExpression() ";"
| SwitchStatement()
| IfStatement()
| WhileStatement()
| DoStatement()
| ForStatement()
| BreakStatement()
| ContinueStatement()
| ReturnStatement()
| ThrowStatement()
| SynchronizedStatement()
| TryStatement()
}以上代码列出了一个Statement后面所有的可能。
写一个规则类
写一个新的Java类继承net.sourceforge.pmd.lang.java.rule.AbstractJavaRule：
import net.sourceforge.pmd.lang.java.rule.*;
public class WhileLoopsMustUseBracesRule extends AbstractJavaRule {
}PMD工作原理就是在生成的抽象语法树中递归的遍历，直到找出要找的目标，然后返回结果。
接下来我们的目标就是在抽象语法树中找出WhileStatement节点：
import net.sourceforge.pmd.lang.java.rule.*;
import net.sourceforge.pmd.lang.java.ast.*;
public class WhileLoopsMustUseBracesRule extends AbstractJavaRule {
public Object visit(ASTWhileStatement node, Object data) {
System.out.println("hello world");
return data;
}
}打印输出”hello world”的时候就是我们定义的规则执行了的时候。
把WhileLoopsMustUseBracesRule规则放在XML规则集文件中
现在规则已经写完了，我们需要告诉PMD运行时执行这条规则，就得将这个规则文件的相关信息放在XML规则集文件中。例如：pmd-java/src/main/resources/rulesets/java/basic.xml；这里面有很多规则的定义，复制粘贴一下，改成一个新的规则集文件：mycustomrules.xml，自己填充一下元素和属性。
name - WhileLoopsMustUseBracesRule
message - Use braces for while loops
class - 放哪都行. 注意，没有必要放在net.sourceforge.pmd目录下，可以放在com.yourcompany.util.pmd
description - Use braces for while loops
example - 通过代码片段展示违反的规则
<?xml version="1.0"?>
<ruleset name="My custom rules"
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
<rule name="WhileLoopsMustUseBracesRule"
message="Avoid using ‘while‘ statements without curly braces"
class="WhileLoopsMustUseBracesRule">
<description>
Avoid using ‘while‘ statements without using curly braces
</description>
<priority>3</priority>
<example>
<![CDATA[
public void doSomething() {
while (true)
x++;
}
]]>
</example>
</rule>
</ruleset>用PMD执行你的新规则
pmd.bat -d c:\path\to\my\src -f xml -R c:\path\to\mycustomrules.xml
你会看到之前的“hello world”在命令行中输出。
创建RuleViolation
想要你的检查结果在Report中展示，需要创建RuleViolation
import net.sourceforge.pmd.lang.ast.*;
import net.sourceforge.pmd.lang.java.ast.*;
import net.sourceforge.pmd.lang.java.rule.*;
public class WhileLoopsMustUseBracesRule extends AbstractJavaRule {
public Object visit(ASTWhileStatement node, Object data) {
Node firstStmt = node.jjtGetChild(1);
if (!hasBlockAsFirstChild(firstStmt)) {
addViolation(data, node);
}
return super.visit(node,data);
}
private boolean hasBlockAsFirstChild(Node node) {
return (node.jjtGetNumChildren() != 0 && (node.jjtGetChild(0) instanceof ASTBlock));
}
}使用这个文件再次执行
pmd.bat -d c:\path\to\my\src -f xml -R c:\path\to\mycustomrules.xml
可在命令行界面中查看结果。
参考文献
PMD site. How to write a PMD rule