CheckStyle_PMD_FindBugs使用总结解析.docx

PMD, FindBugs, CheckStyle三者的的比较工具目的检查项FindBugs检查.class基于Bug Patterns概念，查找java字节码（.class文件）中的潜在bug主要检查bytecode中的bug patterns，如NullPoint空指针检查、没有合理关闭资源、字符串相同判断错（==，而不是equals）等PMD检查源文件检查Java源文件中的潜在问题主要包括：空try/catch/finally/switch语句块未使用的局部变量、参数和private方法空if/while语句过于复杂的表达式，如不必要的if语句等复杂类CheckStyle检查源文件主要关注格式检查Java源文件是否与代码规范相符主要包括：Javadoc注释命名规范多余没用的ImportsSize度量，如过长的方法缺少必要的空格Whitespace重复代码1. PMD1.1 Ant配置以Ant方式运行PMD规则，以下是Ant配置文件build.xml:pathid=pmd.pathfilesetdir=${lib.dir}includename=pmd-4.2.5.jar/includename=pmdrule2.jar//fileset/pathtaskdefname=pmdclassname=net.sourceforge.pmd.ant.PMDTaskclasspathref=pmd.path/targetname=pmddepends=Sourcespmdrulesetfiles=${basedir}/pfc/rules/pmd-rulesets/favorites.xmlformattertype=xmltoFile=${basedir}/quality_reports/pmd.xml/formattertype=htmltoFile=${basedir}/quality_reports/pmd.html/filesetdir=${JavaSource}includename=**/*.java//fileset/pmd/target1.2 自定义PMD规则PMD 自带了很多规则集合，并且分类写入不同的 ruleset 文件。其中basic.xml包含了一般要遵守的最佳代码实践，详细规则描述参见PMD规则总结.xlsx.自定义PMD规则集，根据项目需要，用如下方式修改Ant指定的PMD规则文件favorites.xml：!-- 使用整个strings规则集 --ruleref=rulesets/strings.xml/!-- 使用某个规则集里的某个规则 --ruleref=rulesets/unusedcode.xml/UnusedLocalVariable/!-- 指定某个规则集里的某个规则的优先级 --ruleref=rulesets/basic.xml/EmptyCatchBlockmessage=Must handle exceptionspriority2/priority/rule!-- 去除某个规则集里的某个规则 --ruleref=rulesets/braces.xmlexcludename=WhileLoopsMustUseBracesRule//rule2．FindBugs2.1 Ant配置pathid=findbugs.pathfilesetdir =${lib.home}/findbugs-1.3.0includename =**/*.jar//fileset/pathtaskdefname=findbugsclassname=edu.umd.cs.findbugs.anttask.FindBugsTaskclasspathref =findbugs.path/propertyname =findbugs.homevalue =${lib.home}/findbugs-1.3.0/targetname =findbugs!--includeFilter指定要包含的规则的过滤器文件，excludeFilter包含要去除的规则过滤器文件 --findbugshome =${findbugs.home}includeFilter=${findbugs_include_filter}excludeFilter=${findbugs_exclude_filter}jvmargs=-Xmx384moutput =htmloutputFile =d:/test.html!-- 定义findbugs查找的类路径 --classlocation =${build.home}/WEB-INF/classes//!-- 定义上述类所依赖的类路径 --auxClasspathpath=${lib.home