代码格式检查

1、几种工具的对比工具目的检查项FindBugs检查.class基于Bug Patterns概念，查找javabytecode（.class文件）中的潜在bug主要检查bytecode中的bug patterns，如NullPoint空指针检查、没有合理关闭资源、字符串相同判断错（=，而不是equals）等PMD检查源文件检查Java源文件中的潜在问题主要包括：空try/catch/finally/switch语句块未使用的局部变量、参数和private方法空if/while语句过于复杂的表达式，如不必要的if语句等复杂类CheckStyle检查源文件主要关注格式检查Java源文件是否与代码规范相

2、符主要包括：Javadoc注释命名规范多余没用的ImportsSize度量，如过长的方法缺少必要的空格Whitespace重复代码FindBugsFindBugs 大多数提示有用,值得改1.  配置无查找功能，不过缩写能让我们很快找到某个规则2.  提供图形界面的独立程序，对jar进行检测，有报告生成，非常方便3.  很多功能插件没有实现，可独立使用FindBugs，但没法同时修改源码插件bug替代法: 使用独立的FindBugs设置规则，然后到C:Documents and SettingsXXX下找.Findbugs_prefs，

3、然后改名覆盖Eclipse Project下的.fbprefs (先关闭你的Project)PMD比较严格1.  独立的程序是命令行形式操作2.  插件可以配置规则，有独立显示问题的视图，也很方便3.  一般来说，需要自定义规则才通过检验过于严格1. 按照Sun的规范太严格了，需要自定义规则2.  插件自定义规则没有查找功能，查找规则麻烦3.  只能做检查，不能修改代码，可配合Jalopy使用修改代码 可参考以下文档进行学习使用：CheckStyle过于严格1. &

4、#160;按照Sun的规范太严格了，需要自定义规则2.  插件自定义规则没有查找功能，查找规则麻烦3.  只能做检查，不能修改代码，可配合Jalopy使用修改代码 参考： 工具的插件安装PMDPMD检查原理PMD的核心是JavaCC解析器生成器。PMD结合运用JavaCC和EBNF（扩展巴科斯-诺尔范式，Extended Backus-Naur Formal）语法，再加上JJTree，把Java源代码解析成抽象语法树（AST，Abstract Syntax Tree）。显然，这句话不那么好懂，且看下文具体说明。 从根本上看，Java源代码只是一

5、些普通的文本。不过，为了让解析器承认 这些普通的文本是合法的Java代码，它们必须符合某种特定的结构要求。这种结构可以用一种称为EBNF的句法元语言表示，通常称为“语法” （Grammar）。JavaCC根据语法要求生成解析器，这个解析器就可以用于解析用Java编程语言编写的程序。 不过实际运行 中的PMD还要经过JJTree的一次转换。JJTree是一个JavaCC的插件，通过AST扩充JavaCC生成的解析器。AST是一个Java符号 流之上的语义层。有了JJTree，语法分析的结果不再是“System, ., out, ., . println”之类的符号序列，而是一个由对象构成的树型层

6、次结构。PMD实现过程实现过程：l 首先传一个文件名或者Ruleset给pmdl Pmd把该文件流传给自己生成的javaCC分析器l 分析完毕后，pmd获得了分析生成的AST的一个引用l PMD把AST处理成一个符号表，你可以在符号表里面查询一些有用的信息l 每个pmd规则都会遍历整个AST并检验是否发生了错误l 接着pmd产生一个报表，上面说明了有哪些地方违反了pmd规则使用IDE插件1、settings > plugins, 搜索PMD，选择QAplugin，点击安装。上图中红线框出来的 都需要安装安装完成后，重启IDE插件生效2、Setting->Other Setting-

7、>QAPlugin->Coding Rules可以选择需要的代码检查规范。3、在要检查的工程或者代码上右键，选择 Analyze Code选择要使用的profile和scope窗口查看检查结果使用命令行下载PMD 软件，解压后在bin目录执行如下命令。D:workspacesoftjava-pluginpmdpmd-bin-5.3.2bin>pmd -d D:workspaceprojectmygps -f xml -R rulesets/java/unusedcode.xml自定义PMD规则编写pmd规则有两种方法：l 用java code，需要了解pmd的api，需要进行

8、深入研究，也常常用于一些比较复杂的pmd规则l 用xpath，对着产生的AST树，写就行了，上手比较快，写起来也比较简单CheckStyleCheckstyle的检查原理 sun_checks.xml是由多个module节点构成，因此可以发现：Checkstyle配置是通过指定modules来应用到java文件的。modules是树状结构，以一个名为Checker的module作为root节点，一般的checker都会包括TreeWalker子module。在xml配置文件中通过module的name属性来区分module，module的Properties可以控制如何去执行这个module，

9、每个property都有一个默认值，所有的check都有一个severity属性，用它来指定check的level。TreeWalker为每个java文件创建一个语法树，在节点之间调用submodules的Checks。IDE插件IDE插件安装1、settings > plugins, 搜索CheckStyle-IDEA，点击安装。安装完成后，重启IntelliJ IDEA使插件生效。配置checkstyleFile->Setting->Other Setting->checkStyle至下图界面选中新添加的检查规则，并Apply即可。使用checkStyle检查文件在File->Setting->Editor->CheckStyle中选择是否