尝试 PMD 进行代码规范检查 — Windows Live

 原文：http://sunjun041640.blog.163.com/blog/static/256268322009053323768/?suggestedreading&wumii

 

9月6日

尝试 PMD 进行代码规范检查

     Tom Copeland 的 PMD 是一个开源（BSD 许可）工具，它分析 Java 源代码，找出潜在的 bug。在一般意义上来说，它与 FindBugs 和 Lint4j 这类工具类似。但是，所有这些工具找出的 bug 各不相同，所以在给定代码基址上把这些工具都运行一遍很有好处。您也可以把 PMD 与 Ant 集成在一起，以便进行自动源代码检查，而且还可以将 PMD 与一些可用于大多数主要 IDE 和程序员编辑器的插件集成在一起，本文介绍Eclipse IDE 下PMD的插件。

一、安装基于Eclipse IDE的插件

1、启动Eclipse IDE，打开工程

2、选择"Help"->"Software Updates"->"Find and Install"

3、点击"Next", 点击"New remote site"创建一个远程站点连接

4、输入此站点的描述名称，例如：“PMD Plus” ，然后输入安装地址"http://pmd.sf.net/eclipse"，遵守协议，然后一路next，直至更新完毕重启Eclipse IDE

二、使用PMD

1、启动Eclipse IDE，打开工程，选择 "Windows"->"Preferences"下的PMD项，其中Rules Configuration 项目可以配置PMD的检查规则，自定义检查规则也可以在此通过Import的方式导入到PMD中

2、配置好后，鼠标右键点击工程中需要检查的JavaSource，选择"PMD"->"Check Code With PMD" ,之后PMD就会通过规则检查你的JavaSource了并且将信息显示在PMD自己的视图上

3、示例

import java.util.*;
public class Test {
        public static void main(String[] args) {
             try{ 
                if(true) {}
                System.out.println("Hello World!");
            } catch(Exception e) {
            } 
       }
}

以上代码PMD会检查出：catch块中没有内容、if判断块中没有内容、代码中出现System.out.println等警告描述

三、关于PMD规则

1、PMD 包含 16 个规则集，涵盖了 Java 的各种常见问题，其中一些规则要比其他规则更有争议：

基本（rulesets/basic.xml）—— 规则的一个基本合集，可能大多数开发人员都不认同它： catch 块不该为空，无论何时重写 equals()，都要重写 hashCode()，等等。

命名（rulesets/naming.xml）—— 对标准 Java 命令规范的测试：变量名称不应太短；方法名称不应过长；类名称应当以小写字母开头；方法和字段名应当以小写字母开头，等等。

设计（rulesets/design.xml）—— 检查各种设计良好的原则，例如： switch 语句应当有 default 块，应当避免深度嵌套的 if 块，不应当给参数重新赋值，不应该对 double 值进行相等比较。 导入语句（rulesets/imports.xml）—— 检查 import 语句的问题，比如同一个类被导入两次或者被导入 java.lang 的类中。 JUnit 测试（rulesets/junit.xml）—— 查找测试用例和测试方法的特定问题，例如方法名称的正确拼写，以及 suite() 方法是不是 static 和 public。 字符串（rulesets/string.xml）—— 找出处理字符串时遇到的常见问题，例如重复的字符串标量，调用 String 构造函数，对 String 变量调用 toString() 方法。 括号（rulesets/braces.xml）—— 检查 for、 if、 while 和 else 语句是否使用了括号。 终结函数（finalizer）—— 因为在 Java 语言中， finalize() 方法不是那么普遍（我上次编写这个代码也经是好多年前的事了），所以它们的使用规则虽然很详细，但是人们对它们相对不是很熟悉。这类检查查找 finalize() 方法的各种问题，例如空的终结函数，调用其他方法的 finalize() 方法，对 finalize() 的显式调用，等等。 克隆（rulesets/clone.xml）—— 用于 clone() 方法的新规则。凡是重写 clone() 方法的类都必须实现 Cloneable， clone() 方法应该调用 super.clone()，而 clone() 方法应该声明抛出 CloneNotSupportedException 异常，即使实际上没有抛出异常，也要如此。 耦合（rulesets/coupling.xml）—— 查找类之间过度耦合的迹象，比如导入内容太多；在超类型或接口就已经够用的时候使用子类的类型；类中的字段、变量和返回类型过多等。 严格的异常（rulesets/strictexception.xml）—— 针对异常的测试：不应该声明该方法而抛出 java.lang.Exception 异常，不应当将异常用于流控制，不应该捕获 Throwable，等等。 有争议的（rulesets/controversial.xml）—— PMD 的有些规则是有能力的 Java 程序员可以接受的。但还是有一些争议。这个规则集包含一些更有问题的检验，其中包括把 null 赋值给变量、方法中有多个返回点，以及从 sun 包导入等。 日志（rulesets/logging-java.xml）—— 查找 java.util.logging.Logger 的不当使用，包括非终状态（nonfinal）、非静态的记录器，以及在一个类中有多个记录器。

2、构建自己的规则集

2.1、导入规则集

<?xml version="1.0"?> <ruleset > <description> Sample ruleset for developerWorks article </description> <rule ref="rulesets/design.xml"/> <rule ref="rulesets/naming.xml"/> <rule ref="rulesets/basic.xml"/> </ruleset>文件保存成为*.xml，通过Rules Configuration 的Import 导入到PMD中2.2、导入特定规则的规则集

 <?xml version="1.0"?>
<ruleset rules">
  <description>
  Sample ruleset for developerWorks article
  </description>
  <rule ref="rulesets/design.xml/AvoidReassigningParametersRule"/>
  <rule ref=
    "rulesets/design.xml/ConstructorCallsOverridableMethod"/>
  <rule ref="rulesets/design.xml/FinalFieldCouldBeStatic"/>
  <rule ref="rulesets/design.xml/DefaultLabelNotLastInSwitchStmt"/>
  <rule ref="rulesets/naming.xml/LongVariable"/>
  <rule ref="rulesets/naming.xml/ShortMethodName"/>
  <rule ref="rulesets/naming.xml/VariableNamingConventions"/>
  <rule ref="rulesets/naming.xml/MethodNamingConventions"/>
  <rule ref="rulesets/naming.xml/ClassNamingConventions"/>
  <rule ref="rulesets/basic.xml/EmptyCatchBlock"/>
  <rule ref="rulesets/basic.xml/EmptyFinallyBlock"/>
</ruleset>

文件保存成为*.xml，通过Rules Configuration 的Import 导入到PMD中

2.3、排除了设计规则的规则集

    可以把大多数规则包含在一个集合，但是不包括少数您不同意的或者会造成大量误报的特定规则。例如，XOM 在进行表查找的时候经常使用没有 default 块的 switch 语句。我可以保留大多数设计规则，但是可以在导入设计规则的规则元素中添加 <exclude /> 子元素，避开对遗漏 default 块的检查

<?xml version="1.0"?>
<ruleset rules">
  <description>
  Sample ruleset for developerWorks article
  </description>
  <rule ref="rulesets/design.xml">
    <exclude />
  </rule>
</ruleset>

 

2.4、通过编写XPath表达式实现规则集

编写 XPath 表达式，它会针对每个 Java 类的抽象语法树进行处理，但是比较繁杂......

引文来源   尝试 PMD 进行代码规范检查 — Windows Live