都优先在开发过程中本地使用 ,推荐程度 : lint > checkStyles > findbugs > PMD
将lint配置到jenkins ,打包前检查 ,主要检查未使用资源
区别 :
findbug :检查JAVA类和JAR 包,发现如NPE 等问题
PMD : 检查源代码,发现如无用代码等问题
checkStyles : 按照规则,检查不符合代码规范的问题
Lint :Android代码检查工具,发现如无用资源等问题 , 强烈推荐
刚开始使用的时候可以只针对修改的代码检查,所以大家不用排斥,30分钟就能上手
lint :
findbug:
PMD :
checkStyle:
安装 :
findBug :安装插件 FindBugs-IDEA
PMD : 安装插件 QAPlug-PMD
checkStyles: 安装插件 CheckStyle-IDEA
Lint : Android studio 系统自带,无需安装
======================================================================
========================分割线, 非作战人员无需继续===========================
=====================================================================
使用与分析:
Lint:
Android studio 自带代码检查工具(也是我自己最喜欢的)
配置,可自行配置检查规则以及报告等级
运行命令 : gradlew lint 或者 点击 Analyze => inspacte code 或者其他
检查结果 :
findbugs :
添加过滤 过滤掉R文件与测试文件
<?xml version="1.0" encoding="UTF-8"?> <FindBugsFilter> <Match> <!-- ignore all issues in resource generation --> <Class name="~.*\.R\$.*"/> </Match> <Match> <Class name="~.*\.Manifest\$.*"/> </Match> <Match> <Class name="~.*\.*Test" /> <!-- test classes are suffixed by 'Test' --> <Not> <Bug code="IJU" /> <!-- 'IJU' is the code for bugs related to JUnit test code --> </Not> </Match> </FindBugsFilter>
分析结果 :
每一个都会指出准确位置与原因说明,可结合业务逻辑,按需修改
checkStyle :
配置文件: 以google checkstyle文件为例
<?xml version="1.0"?> | |
<!DOCTYPE module PUBLIC | |
"-//Puppy Crawl//DTD Check Configuration 1.3//EN" | |
"http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd"> | |
<!-- | |
Checkstyle configuration that checks the Google coding conventions from Google Java Style | |
that can be found at https://google.github.io/styleguide/javaguide.html. | |
Checkstyle is very configurable. Be sure to read the documentation at | |
http://checkstyle.sf.net (or in your downloaded distribution). | |
To completely disable a check, just comment it out or delete it from the file. | |
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. | |
--> | |
<module name = "Checker"> | |
<property name="charset" value="UTF-8"/> | |
<property name="severity" value="warning"/> | |
<property name="fileExtensions" value="java, properties, xml"/> | |
<!-- Checks for whitespace --> | |
<!-- See http://checkstyle.sf.net/config_whitespace.html --> | |
<module name="FileTabCharacter"> | |
<property name="eachLine" value="true"/> | |
</module> | |
<module name="TreeWalker"> | |
<module name="OuterTypeFilename"/> | |
<module name="IllegalTokenText"> | |
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/> | |
<property name="format" value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/> | |
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/> | |
</module> | |
<module name="AvoidEscapedUnicodeCharacters"> | |
<property name="allowEscapesForControlCharacters" value="true"/> | |
<property name="allowByTailComment" value="true"/> | |
<property name="allowNonPrintableEscapes" value="true"/> | |
</module> | |
<module name="LineLength"> | |
<property name="max" value="100"/> | |
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/> | |
</module> | |
<module name="AvoidStarImport"/> | |
<module name="OneTopLevelClass"/> | |
<module name="NoLineWrap"/> | |
<module name="EmptyBlock"> | |
<property name="option" value="TEXT"/> | |
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/> | |
</module> | |
<module name="NeedBraces"/> | |
<module name="LeftCurly"/> | |
<module name="RightCurly"> | |
<property name="id" value="RightCurlySame"/> | |
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/> | |
</module> | |
<module name="RightCurly"> | |
<property name="id" value="RightCurlyAlone"/> | |
<property name="option" value="alone"/> | |
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/> | |
</module> | |
<module name="WhitespaceAround"> | |
<property name="allowEmptyConstructors" value="true"/> | |
<property name="allowEmptyMethods" value="true"/> | |
<property name="allowEmptyTypes" value="true"/> | |
<property name="allowEmptyLoops" value="true"/> | |
<message key="ws.notFollowed" | |
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/> | |
<message key="ws.notPreceded" | |
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/> | |
</module> | |
<module name="OneStatementPerLine"/> | |
<module name="MultipleVariableDeclarations"/> | |
<module name="ArrayTypeStyle"/> | |
<module name="MissingSwitchDefault"/> | |
<module name="FallThrough"/> | |
<module name="UpperEll"/> | |
<module name="ModifierOrder"/> | |
<module name="EmptyLineSeparator"> | |
<property name="allowNoEmptyLineBetweenFields" value="true"/> | |
</module> | |
<module name="SeparatorWrap"> | |
<property name="id" value="SeparatorWrapDot"/> | |
<property name="tokens" value="DOT"/> | |
<property name="option" value="nl"/> | |
</module> | |
<module name="SeparatorWrap"> | |
<property name="id" value="SeparatorWrapComma"/> | |
<property name="tokens" value="COMMA"/> | |
<property name="option" value="EOL"/> | |
</module> | |
<module name="SeparatorWrap"> | |
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 --> | |
<property name="id" value="SeparatorWrapEllipsis"/> | |
<property name="tokens" value="ELLIPSIS"/> | |
<property name="option" value="EOL"/> | |
</module> | |
<module name="SeparatorWrap"> | |
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 --> | |
<property name="id" value="SeparatorWrapArrayDeclarator"/> | |
<property name="tokens" value="ARRAY_DECLARATOR"/> | |
<property name="option" value="EOL"/> | |
</module> | |
<module name="SeparatorWrap"> | |
<property name="id" value="SeparatorWrapMethodRef"/> | |
<property name="tokens" value="METHOD_REF"/> | |
<property name="option" value="nl"/> | |
</module> | |
<module name="PackageName"> | |
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/> | |
<message key="name.invalidPattern" | |
value="Package name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="TypeName"> | |
<message key="name.invalidPattern" | |
value="Type name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="MemberName"> | |
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> | |
<message key="name.invalidPattern" | |
value="Member name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="ParameterName"> | |
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/> | |
<message key="name.invalidPattern" | |
value="Parameter name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="CatchParameterName"> | |
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/> | |
<message key="name.invalidPattern" | |
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="LocalVariableName"> | |
<property name="tokens" value="VARIABLE_DEF"/> | |
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/> | |
<message key="name.invalidPattern" | |
value="Local variable name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="ClassTypeParameterName"> | |
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> | |
<message key="name.invalidPattern" | |
value="Class type name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="MethodTypeParameterName"> | |
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> | |
<message key="name.invalidPattern" | |
value="Method type name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="InterfaceTypeParameterName"> | |
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> | |
<message key="name.invalidPattern" | |
value="Interface type name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="NoFinalizer"/> | |
<module name="GenericWhitespace"> | |
<message key="ws.followed" | |
value="GenericWhitespace ''{0}'' is followed by whitespace."/> | |
<message key="ws.preceded" | |
value="GenericWhitespace ''{0}'' is preceded with whitespace."/> | |
<message key="ws.illegalFollow" | |
value="GenericWhitespace ''{0}'' should followed by whitespace."/> | |
<message key="ws.notPreceded" | |
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/> | |
</module> | |
<module name="Indentation"> | |
<property name="basicOffset" value="2"/> | |
<property name="braceAdjustment" value="0"/> | |
<property name="caseIndent" value="2"/> | |
<property name="throwsIndent" value="4"/> | |
<property name="lineWrappingIndentation" value="4"/> | |
<property name="arrayInitIndent" value="2"/> | |
</module> | |
<module name="AbbreviationAsWordInName"> | |
<property name="ignoreFinal" value="false"/> | |
<property name="allowedAbbreviationLength" value="1"/> | |
</module> | |
<module name="OverloadMethodsDeclarationOrder"/> | |
<module name="VariableDeclarationUsageDistance"/> | |
<module name="CustomImportOrder"> | |
<property name="sortImportsInGroupAlphabetically" value="true"/> | |
<property name="separateLineBetweenGroups" value="true"/> | |
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/> | |
</module> | |
<module name="MethodParamPad"/> | |
<module name="NoWhitespaceBefore"> | |
<property name="tokens" value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/> | |
<property name="allowLineBreaks" value="true"/> | |
</module> | |
<module name="ParenPad"/> | |
<module name="OperatorWrap"> | |
<property name="option" value="NL"/> | |
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/> | |
</module> | |
<module name="AnnotationLocation"> | |
<property name="id" value="AnnotationLocationMostCases"/> | |
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/> | |
</module> | |
<module name="AnnotationLocation"> | |
<property name="id" value="AnnotationLocationVariables"/> | |
<property name="tokens" value="VARIABLE_DEF"/> | |
<property name="allowSamelineMultipleAnnotations" value="true"/> | |
</module> | |
<module name="NonEmptyAtclauseDescription"/> | |
<module name="JavadocTagContinuationIndentation"/> | |
<module name="SummaryJavadoc"> | |
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/> | |
</module> | |
<module name="JavadocParagraph"/> | |
<module name="AtclauseOrder"> | |
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/> | |
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/> | |
</module> | |
<module name="JavadocMethod"> | |
<property name="scope" value="public"/> | |
<property name="allowMissingParamTags" value="true"/> | |
<property name="allowMissingThrowsTags" value="true"/> | |
<property name="allowMissingReturnTag" value="true"/> | |
<property name="minLineCount" value="2"/> | |
<property name="allowedAnnotations" value="Override, Test"/> | |
<property name="allowThrowsTagsForSubclasses" value="true"/> | |
</module> | |
<module name="MethodName"> | |
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/> | |
<message key="name.invalidPattern" | |
value="Method name ''{0}'' must match pattern ''{1}''."/> | |
</module> | |
<module name="SingleLineJavadoc"> | |
<property name="ignoreInlineTags" value="false"/> | |
</module> | |
<module name="EmptyCatchBlock"> | |
<property name="exceptionVariableName" value="expected"/> | |
</module> | |
<module name="CommentsIndentation"/> | |
</module> | |
</module> |
检查结果示例 :
PMD :
添加gradle 任务
apply plugin: 'pmd'
task pmd(type: Pmd) { ignoreFailures = false ruleSetFiles = files("$configDir/PMDRules.xml") ruleSets = [] source 'src' include '**/*.java' exclude '**/gen/**' exclude 'androidTest/**' exclude 'test/**' reports { xml.enabled = false html.enabled = true xml { destination "$reportsDir/pmd/pmd.xml" } html { destination "$reportsDir/pmd/pmd.html" } } }
配置文件:
添加过滤 过滤掉R文件与测试文件
<?xml version="1.0"?>
-<ruleset xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd" xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd" xmlns="http://pmd.sf.net/ruleset/1.0.0" name="Android Application Rules" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<description>Custom ruleset for Android application</description>
<exclude-pattern>.*/R.java</exclude-pattern>
<exclude-pattern>.*/gen/.*</exclude-pattern>
<rule ref="rulesets/java/android.xml"/>
<rule ref="rulesets/java/clone.xml"/>
<rule ref="rulesets/java/finalizers.xml"/>
-<rule ref="rulesets/java/imports.xml">
<!-- Espresso is designed this way !-->
<exclude name="TooManyStaticImports"/>
</rule>
<rule ref="rulesets/java/logging-java.xml"/>
<rule ref="rulesets/java/braces.xml"/>
<rule ref="rulesets/java/strings.xml"/>
<rule ref="rulesets/java/basic.xml"/>
-<rule ref="rulesets/java/naming.xml">
<exclude name="AbstractNaming"/>
<exclude name="LongVariable"/>
<exclude name="ShortMethodName"/>
<exclude name="ShortVariable"/>
<exclude name="VariableNamingConventions"/>
</rule>
</ruleset>
分析结果 :结果不太友好,阅读困难,结果未做分类