123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520 |
- <?xml version="1.0"?>
- <!DOCTYPE module PUBLIC
- "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
- "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
- <module name="Checker">
- <!-- 编码 -->
- <property name="charset" value="UTF-8"/>
- <!-- 严重性,默认警告 -->
- <property name="severity" value="warning"/>
- <!-- 检查一下3中结尾的文件 -->
- <property name="fileExtensions" value="java, properties, xml"/>
- <!-- Excludes all 'module-info.java' files -->
- <!-- See https://checkstyle.org/config_filefilters.html -->
- <module name="BeforeExecutionExclusionFileFilter">
- <property name="fileNamePattern" value="module\-info\.java$"/>
- </module>
- <!-- Checks for whitespace -->
- <!-- See http://checkstyle.org/config_whitespace.html -->
- <module name="FileTabCharacter">
- <property name="eachLine" value="true"/>
- </module>
- <!-- 检查文件是否以一个空行结束 -->
- <module name="NewlineAtEndOfFile"/>
- <!-- 文件长度不超过1500行 -->
- <module name="FileLength">
- <property name="max" value="1500"/>
- </module>
- <!-- 长度检查 -->
- <module name="LineLength">
- <!-- 只检查java文件 -->
- <property name="fileExtensions" value="java"/>
- <!-- 每行不超过120个字符 -->
- <property name="max" value="120" />
- <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
- </module>
- <!-- 每个java文件一个语法树 -->
- <module name="TreeWalker">
- <module name="OuterTypeFilename"/>
- <!-- 非法token -->
- <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>
- <!--避免转义的 Unicode 字符-->
- <module name="AvoidEscapedUnicodeCharacters">
- <property name="allowEscapesForControlCharacters" value="true"/>
- <property name="allowByTailComment" value="true"/>
- <property name="allowNonPrintableEscapes" value="true"/>
- </module>
- <!-- import检查-->
- <!-- 避免使用* -->
- <module name="AvoidStarImport">
- <property name="excludes" value="java.io,java.net,java.lang.Math"/>
- <!-- 实例;import java.util.*;.-->
- <property name="allowClassImports" value="false"/>
- <!-- 实例 ;import static org.junit.Assert.*;-->
- <property name="allowStaticMemberImports" value="true"/>
- </module>
- <!-- 一个顶级类检查 -->
- <module name="OneTopLevelClass"/>
- <!-- 未换行检查 -->
- <module name="NoLineWrap">
- <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
- </module>
- <!-- 检查是否有空代码块 -->
- <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">
- <property name="tokens"
- value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
- </module>
- <!-- 检查左大括号位置 -->
- <module name="LeftCurly">
- <property name="tokens"
- value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
- INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
- LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
- LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
- OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
- </module>
- <!-- 检查右大括号位置 -->
- <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, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,
- COMPACT_CTOR_DEF"/>
- </module>
- <module name="SuppressionXpathSingleFilter">
- <!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
- <property name="id" value="RightCurlyAlone"/>
- <property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]
- or preceding-sibling::*[last()][self::LCURLY]]"/>
- </module>
- <!-- 检查分隔符是否在空白之后 -->
- <module name="WhitespaceAfter">
- <property name="tokens"
- value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
- LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
- </module>
- <!-- 检查分隔符周围是否有空白 -->
- <module name="WhitespaceAround">
- <property name="allowEmptyConstructors" value="true"/>
- <property name="allowEmptyLambdas" value="true"/>
- <property name="allowEmptyMethods" value="true"/>
- <property name="allowEmptyTypes" value="true"/>
- <property name="allowEmptyLoops" value="true"/>
- <property name="ignoreEnhancedForColon" value="false"/>
- <property name="tokens"
- value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
- BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
- LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
- LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
- LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
- NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
- SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
- <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"/>
- <!-- 检查switch语句是否有default -->
- <module name="MissingSwitchDefault"/>
- <module name="FallThrough"/>
- <!-- 检查long型定义是否有大写的“L” -->
- <module name="UpperEll"/>
- <!-- 检查修饰符的顺序是否遵照java语言规范,默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->
- <module name="ModifierOrder"/>
- <module name="EmptyLineSeparator">
- <property name="tokens"
- value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
- STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,
- COMPACT_CTOR_DEF"/>
- <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/259 -->
- <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/258 -->
- <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>
- <!-- 包名的检查(只允许小写字母),默认^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ -->
- <module name="PackageName">
- <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
- <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
- </module>
- <!-- Class或Interface名检查,默认^[A-Z][a-zA-Z0-9]*$-->
- <module name="TypeName">
- <property name="severity" value="warning"/>
- <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
- </module>
- <!-- 非static型变量的检查 -->
- <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>
- <!-- lambada中参数名 -->
- <module name="LambdaParameterName">
- <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <!-- catch参数名 -->
- <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>
- <!-- 局部的非final型的变量,包括catch中的参数的检查 -->
- <module name="LocalVariableName" >
- <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="PatternVariableName">
- <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Pattern 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="RecordComponentName">
- <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Record component name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="RecordTypeParameterName">
- <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
- <message key="name.invalidPattern"
- value="Record 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">
- <!-- 基础缩进4个 -->
- <property name="basicOffset" value="4"/>
- <property name="braceAdjustment" value="2"/>
- <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="0"/>
- <property name="tokens"
- value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
- PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
- RECORD_COMPONENT_DEF"/>
- </module>
- <module name="NoWhitespaceBeforeCaseDefaultColon"/>
- <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"/>
- <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
- </module>
- <!-- 方法名后跟左圆括号"(" -->
- <module name="MethodParamPad" >
- <property name="tokens"
- value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
- SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/>
- </module>
- <!-- 检查在某个特定关键字之前应保留空格 -->
- <module name="NoWhitespaceBefore">
- <property name="tokens"
- value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
- LABELED_STAT, METHOD_REF"/>
- <property name="allowLineBreaks" value="true"/>
- </module>
- <!-- 圆括号空白 -->
- <module name="ParenPad">
- <property name="tokens"
- value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
- EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
- LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
- METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,
- RECORD_DEF"/>
- </module>
- <!-- 操作符换行策略检查 -->
- <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,
- TYPE_EXTENSION_AND "/>
- </module>
- <module name="AnnotationLocation">
- <property name="id" value="AnnotationLocationMostCases"/>
- <property name="tokens"
- value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,
- RECORD_DEF, COMPACT_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="InvalidJavadocPosition"/>
- <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="RequireEmptyLineBeforeBlockTagGroup"/>
- <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="accessModifiers" value="public"/>
- <property name="allowMissingParamTags" value="true"/>
- <property name="allowMissingReturnTag" value="true"/>
- <property name="allowedAnnotations" value="Override, Test"/>
- <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"/>
- </module>
- <module name="MissingJavadocMethod">
- <property name="scope" value="public"/>
- <property name="minLineCount" value="2"/>
- <property name="allowedAnnotations" value="Override, Test"/>
- <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,
- COMPACT_CTOR_DEF"/>
- </module>
- <module name="MissingJavadocType">
- <property name="scope" value="protected"/>
- <property name="tokens"
- value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
- RECORD_DEF, ANNOTATION_DEF"/>
- <property name="excludeScope" value="nothing"/>
- </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"/>
- <module name="EmptyCatchBlock">
- <property name="exceptionVariableName" value="expected"/>
- </module>
- <module name="CommentsIndentation">
- <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
- </module>
- <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
- <module name="SuppressionXpathFilter">
- <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
- default="checkstyle-xpath-suppressions.xml" />
- <property name="optional" value="true"/>
- </module>
- <!-- 检查是否从非法的包中导入了类 -->
- <module name="IllegalImport"/>
- <!-- 检查是否导入了多余的包 -->
- <module name="RedundantImport"/>
- <!-- 没用的import检查,比如:1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
- <module name="UnusedImports" />
- <!-- 注释检查 -->
- <!-- 检查方法和构造函数的javadoc -->
- <module name="JavadocType">
- <property name="allowUnknownTags" value="true"/>
- <message key="javadoc.missing" value="类注释:缺少Javadoc注释。"/>
- </module>
- <!-- 命名检查 -->
- <!-- 局部的final变量,包括catch中的参数的检查 -->
- <module name="LocalFinalVariableName" />
- <!-- 仅仅是static型的变量(不包括static final型)的检查 -->
- <module name="StaticVariableName" />
- <!-- 常量名的检查(只允许大写),默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->
- <module name="ConstantName" />
- <!-- 方法不超过50行 -->
- <module name="MethodLength">
- <property name="tokens" value="METHOD_DEF" />
- <property name="max" value="50" />
- </module>
- <!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->
- <module name="ParameterNumber">
- <property name="max" value="5" />
- <property name="ignoreOverriddenMethods" value="true"/>
- <property name="tokens" value="METHOD_DEF" />
- </module>
- <!-- 空格检查-->
- <!-- 在类型转换时,不允许左圆括号右边有空格,也不允许与右圆括号左边有空格 -->
- <module name="TypecastParenPad" />
- <!-- 检查在某个特定关键字之后应保留空格 -->
- <module name="NoWhitespaceAfter"/>
- <!-- 修饰符检查 -->
- <!-- 检查接口和annotation中是否有多余修饰符,如接口方法不必使用public -->
- <module name="RedundantModifier"/>
- <!-- 代码块检查 -->
- <!-- 检查是否有嵌套代码块 -->
- <module name="AvoidNestedBlocks"/>
- <!-- 代码检查 -->
- <!-- 检查空的代码段 -->
- <module name="EmptyStatement"/>
- <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
- <module name="EqualsHashCode"/>
- <!-- 检查局部变量或参数是否隐藏了类中的变量 -->
- <module name="HiddenField">
- <property name="tokens" value="VARIABLE_DEF"/>
- </module>
- <!-- 检查是否使用工厂方法实例化 -->
- <module name="IllegalInstantiation"/>
- <!-- 检查子表达式中是否有赋值操作 -->
- <module name="InnerAssignment"/>
- <!-- 检查是否有"魔术"数字 -->
- <module name="MagicNumber">
- <property name="ignoreNumbers" value="0, 1"/>
- <property name="ignoreAnnotation" value="true"/>
- </module>
- <!-- 检查是否有过度复杂的布尔表达式 -->
- <module name="SimplifyBooleanExpression"/>
- <!-- 检查是否有过于复杂的布尔返回代码段 -->
- <module name="SimplifyBooleanReturn"/>
- <!-- 类设计检查 -->
- <!-- 检查类是否为扩展设计l -->
- <!-- 检查只有private构造函数的类是否声明为final -->
- <module name="FinalClass"/>
- <!-- 检查工具类是否有putblic的构造器 -->
- <module name="HideUtilityClassConstructor"/>
- <!-- 检查接口是否仅定义类型 -->
- <module name="InterfaceIsType"/>
- <!-- 检查类成员的可见度 检查类成员的可见性。只有static final 成员是public的
- 除非在本检查的protectedAllowed和packagedAllowed属性中进行了设置-->
- <module name="VisibilityModifier">
- <property name="packageAllowed" value="true"/>
- <property name="protectedAllowed" value="true"/>
- </module>
- <!-- 语法 -->
- <!-- String的比较不能用!= 和 == -->
- <module name="StringLiteralEquality"/>
- <!-- 限制for循环最多嵌套2层 -->
- <module name="NestedForDepth">
- <property name="max" value="2"/>
- </module>
- <!-- if最多嵌套3层 -->
- <module name="NestedIfDepth">
- <property name="max" value="3"/>
- </module>
- <!-- 检查未被注释的main方法,排除以Appllication结尾命名的类 -->
- <module name="UncommentedMain">
- <property name="excludedClasses" value=".*Application$"/>
- </module>
- <!-- 禁止使用System.out.println -->
- <module name="Regexp">
- <property name="format" value="System\.out\.println"/>
- <property name="illegalPattern" value="true"/>
- </module>
- <!-- return个数 3个-->
- <module name="ReturnCount">
- <property name="max" value="3"/>
- </module>
- <!--try catch 异常处理数量 3-->
- <module name="NestedTryDepth ">
- <property name="max" value="3"/>
- </module>
- <!-- clone方法必须调用了super.clone() -->
- <module name="SuperClone" />
- <!-- finalize 必须调用了super.finalize() -->
- <module name="SuperFinalize" />
- </module>
- </module>
|