checkstyle.xml 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520
  1. <?xml version="1.0"?>
  2. <!DOCTYPE module PUBLIC
  3. "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
  4. "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
  5. <module name="Checker">
  6. <!-- 编码 -->
  7. <property name="charset" value="UTF-8"/>
  8. <!-- 严重性,默认警告 -->
  9. <property name="severity" value="warning"/>
  10. <!-- 检查一下3中结尾的文件 -->
  11. <property name="fileExtensions" value="java, properties, xml"/>
  12. <!-- Excludes all 'module-info.java' files -->
  13. <!-- See https://checkstyle.org/config_filefilters.html -->
  14. <module name="BeforeExecutionExclusionFileFilter">
  15. <property name="fileNamePattern" value="module\-info\.java$"/>
  16. </module>
  17. <!-- Checks for whitespace -->
  18. <!-- See http://checkstyle.org/config_whitespace.html -->
  19. <module name="FileTabCharacter">
  20. <property name="eachLine" value="true"/>
  21. </module>
  22. <!-- 检查文件是否以一个空行结束 -->
  23. <module name="NewlineAtEndOfFile"/>
  24. <!-- 文件长度不超过1500行 -->
  25. <module name="FileLength">
  26. <property name="max" value="1500"/>
  27. </module>
  28. <!-- 长度检查 -->
  29. <module name="LineLength">
  30. <!-- 只检查java文件 -->
  31. <property name="fileExtensions" value="java"/>
  32. <!-- 每行不超过120个字符 -->
  33. <property name="max" value="120" />
  34. <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
  35. </module>
  36. <!-- 每个java文件一个语法树 -->
  37. <module name="TreeWalker">
  38. <module name="OuterTypeFilename"/>
  39. <!-- 非法token -->
  40. <module name="IllegalTokenText">
  41. <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
  42. <property name="format"
  43. 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)"/>
  44. <property name="message"
  45. value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
  46. </module>
  47. <!--避免转义的 Unicode 字符-->
  48. <module name="AvoidEscapedUnicodeCharacters">
  49. <property name="allowEscapesForControlCharacters" value="true"/>
  50. <property name="allowByTailComment" value="true"/>
  51. <property name="allowNonPrintableEscapes" value="true"/>
  52. </module>
  53. <!-- import检查-->
  54. <!-- 避免使用* -->
  55. <module name="AvoidStarImport">
  56. <property name="excludes" value="java.io,java.net,java.lang.Math"/>
  57. <!-- 实例;import java.util.*;.-->
  58. <property name="allowClassImports" value="false"/>
  59. <!-- 实例 ;import static org.junit.Assert.*;-->
  60. <property name="allowStaticMemberImports" value="true"/>
  61. </module>
  62. <!-- 一个顶级类检查 -->
  63. <module name="OneTopLevelClass"/>
  64. <!-- 未换行检查 -->
  65. <module name="NoLineWrap">
  66. <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
  67. </module>
  68. <!-- 检查是否有空代码块 -->
  69. <module name="EmptyBlock">
  70. <property name="option" value="TEXT"/>
  71. <property name="tokens"
  72. value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
  73. </module>
  74. <!-- 检查代码块是否缺失{} -->
  75. <module name="NeedBraces">
  76. <property name="tokens"
  77. value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
  78. </module>
  79. <!-- 检查左大括号位置 -->
  80. <module name="LeftCurly">
  81. <property name="tokens"
  82. value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
  83. INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
  84. LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
  85. LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
  86. OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
  87. </module>
  88. <!-- 检查右大括号位置 -->
  89. <module name="RightCurly">
  90. <property name="id" value="RightCurlySame"/>
  91. <property name="tokens"
  92. value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
  93. LITERAL_DO"/>
  94. </module>
  95. <module name="RightCurly">
  96. <property name="id" value="RightCurlyAlone"/>
  97. <property name="option" value="alone"/>
  98. <property name="tokens"
  99. value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
  100. INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,
  101. COMPACT_CTOR_DEF"/>
  102. </module>
  103. <module name="SuppressionXpathSingleFilter">
  104. <!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
  105. <property name="id" value="RightCurlyAlone"/>
  106. <property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]
  107. or preceding-sibling::*[last()][self::LCURLY]]"/>
  108. </module>
  109. <!-- 检查分隔符是否在空白之后 -->
  110. <module name="WhitespaceAfter">
  111. <property name="tokens"
  112. value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
  113. LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
  114. </module>
  115. <!-- 检查分隔符周围是否有空白 -->
  116. <module name="WhitespaceAround">
  117. <property name="allowEmptyConstructors" value="true"/>
  118. <property name="allowEmptyLambdas" value="true"/>
  119. <property name="allowEmptyMethods" value="true"/>
  120. <property name="allowEmptyTypes" value="true"/>
  121. <property name="allowEmptyLoops" value="true"/>
  122. <property name="ignoreEnhancedForColon" value="false"/>
  123. <property name="tokens"
  124. value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
  125. BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
  126. LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
  127. LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
  128. LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
  129. NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
  130. SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
  131. <message key="ws.notFollowed"
  132. 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)"/>
  133. <message key="ws.notPreceded"
  134. value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
  135. </module>
  136. <module name="OneStatementPerLine"/>
  137. <module name="MultipleVariableDeclarations"/>
  138. <!-- 检查数组类型定义的样式 -->
  139. <module name="ArrayTypeStyle"/>
  140. <!-- 检查switch语句是否有default -->
  141. <module name="MissingSwitchDefault"/>
  142. <module name="FallThrough"/>
  143. <!-- 检查long型定义是否有大写的“L” -->
  144. <module name="UpperEll"/>
  145. <!-- 检查修饰符的顺序是否遵照java语言规范,默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->
  146. <module name="ModifierOrder"/>
  147. <module name="EmptyLineSeparator">
  148. <property name="tokens"
  149. value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
  150. STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,
  151. COMPACT_CTOR_DEF"/>
  152. <property name="allowNoEmptyLineBetweenFields" value="true"/>
  153. </module>
  154. <module name="SeparatorWrap">
  155. <property name="id" value="SeparatorWrapDot"/>
  156. <property name="tokens" value="DOT"/>
  157. <property name="option" value="nl"/>
  158. </module>
  159. <module name="SeparatorWrap">
  160. <property name="id" value="SeparatorWrapComma"/>
  161. <property name="tokens" value="COMMA"/>
  162. <property name="option" value="EOL"/>
  163. </module>
  164. <module name="SeparatorWrap">
  165. <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/259 -->
  166. <property name="id" value="SeparatorWrapEllipsis"/>
  167. <property name="tokens" value="ELLIPSIS"/>
  168. <property name="option" value="EOL"/>
  169. </module>
  170. <module name="SeparatorWrap">
  171. <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/258 -->
  172. <property name="id" value="SeparatorWrapArrayDeclarator"/>
  173. <property name="tokens" value="ARRAY_DECLARATOR"/>
  174. <property name="option" value="EOL"/>
  175. </module>
  176. <module name="SeparatorWrap">
  177. <property name="id" value="SeparatorWrapMethodRef"/>
  178. <property name="tokens" value="METHOD_REF"/>
  179. <property name="option" value="nl"/>
  180. </module>
  181. <!-- 包名的检查(只允许小写字母),默认^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ -->
  182. <module name="PackageName">
  183. <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
  184. <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
  185. </module>
  186. <!-- Class或Interface名检查,默认^[A-Z][a-zA-Z0-9]*$-->
  187. <module name="TypeName">
  188. <property name="severity" value="warning"/>
  189. <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
  190. </module>
  191. <!-- 非static型变量的检查 -->
  192. <module name="MemberName" >
  193. <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
  194. <message key="name.invalidPattern"
  195. value="Member name ''{0}'' must match pattern ''{1}''."/>
  196. </module>
  197. <!-- 方法的参数名 -->
  198. <module name="ParameterName" >
  199. <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
  200. <message key="name.invalidPattern"
  201. value="Parameter name ''{0}'' must match pattern ''{1}''."/>
  202. </module>
  203. <!-- lambada中参数名 -->
  204. <module name="LambdaParameterName">
  205. <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
  206. <message key="name.invalidPattern"
  207. value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
  208. </module>
  209. <!-- catch参数名 -->
  210. <module name="CatchParameterName">
  211. <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
  212. <message key="name.invalidPattern"
  213. value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
  214. </module>
  215. <!-- 局部的非final型的变量,包括catch中的参数的检查 -->
  216. <module name="LocalVariableName" >
  217. <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
  218. <message key="name.invalidPattern"
  219. value="Local variable name ''{0}'' must match pattern ''{1}''."/>
  220. </module>
  221. <module name="PatternVariableName">
  222. <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
  223. <message key="name.invalidPattern"
  224. value="Pattern variable name ''{0}'' must match pattern ''{1}''."/>
  225. </module>
  226. <module name="ClassTypeParameterName">
  227. <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
  228. <message key="name.invalidPattern"
  229. value="Class type name ''{0}'' must match pattern ''{1}''."/>
  230. </module>
  231. <module name="RecordComponentName">
  232. <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
  233. <message key="name.invalidPattern"
  234. value="Record component name ''{0}'' must match pattern ''{1}''."/>
  235. </module>
  236. <module name="RecordTypeParameterName">
  237. <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
  238. <message key="name.invalidPattern"
  239. value="Record type name ''{0}'' must match pattern ''{1}''."/>
  240. </module>
  241. <module name="MethodTypeParameterName">
  242. <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
  243. <message key="name.invalidPattern"
  244. value="Method type name ''{0}'' must match pattern ''{1}''."/>
  245. </module>
  246. <module name="InterfaceTypeParameterName">
  247. <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
  248. <message key="name.invalidPattern"
  249. value="Interface type name ''{0}'' must match pattern ''{1}''."/>
  250. </module>
  251. <module name="NoFinalizer"/>
  252. <module name="GenericWhitespace">
  253. <message key="ws.followed"
  254. value="GenericWhitespace ''{0}'' is followed by whitespace."/>
  255. <message key="ws.preceded"
  256. value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
  257. <message key="ws.illegalFollow"
  258. value="GenericWhitespace ''{0}'' should followed by whitespace."/>
  259. <message key="ws.notPreceded"
  260. value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
  261. </module>
  262. <module name="Indentation">
  263. <!-- 基础缩进4个 -->
  264. <property name="basicOffset" value="4"/>
  265. <property name="braceAdjustment" value="2"/>
  266. <property name="caseIndent" value="2"/>
  267. <property name="throwsIndent" value="4"/>
  268. <property name="lineWrappingIndentation" value="4"/>
  269. <property name="arrayInitIndent" value="2"/>
  270. </module>
  271. <module name="AbbreviationAsWordInName">
  272. <property name="ignoreFinal" value="false"/>
  273. <property name="allowedAbbreviationLength" value="0"/>
  274. <property name="tokens"
  275. value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
  276. PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
  277. RECORD_COMPONENT_DEF"/>
  278. </module>
  279. <module name="NoWhitespaceBeforeCaseDefaultColon"/>
  280. <module name="OverloadMethodsDeclarationOrder"/>
  281. <module name="VariableDeclarationUsageDistance"/>
  282. <module name="CustomImportOrder">
  283. <property name="sortImportsInGroupAlphabetically" value="true"/>
  284. <property name="separateLineBetweenGroups" value="true"/>
  285. <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
  286. <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
  287. </module>
  288. <!-- 方法名后跟左圆括号"(" -->
  289. <module name="MethodParamPad" >
  290. <property name="tokens"
  291. value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
  292. SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/>
  293. </module>
  294. <!-- 检查在某个特定关键字之前应保留空格 -->
  295. <module name="NoWhitespaceBefore">
  296. <property name="tokens"
  297. value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
  298. LABELED_STAT, METHOD_REF"/>
  299. <property name="allowLineBreaks" value="true"/>
  300. </module>
  301. <!-- 圆括号空白 -->
  302. <module name="ParenPad">
  303. <property name="tokens"
  304. value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
  305. EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
  306. LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
  307. METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,
  308. RECORD_DEF"/>
  309. </module>
  310. <!-- 操作符换行策略检查 -->
  311. <module name="OperatorWrap">
  312. <property name="option" value="NL"/>
  313. <property name="tokens"
  314. value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
  315. LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF,
  316. TYPE_EXTENSION_AND "/>
  317. </module>
  318. <module name="AnnotationLocation">
  319. <property name="id" value="AnnotationLocationMostCases"/>
  320. <property name="tokens"
  321. value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,
  322. RECORD_DEF, COMPACT_CTOR_DEF"/>
  323. </module>
  324. <module name="AnnotationLocation">
  325. <property name="id" value="AnnotationLocationVariables"/>
  326. <property name="tokens" value="VARIABLE_DEF"/>
  327. <property name="allowSamelineMultipleAnnotations" value="true"/>
  328. </module>
  329. <module name="NonEmptyAtclauseDescription"/>
  330. <module name="InvalidJavadocPosition"/>
  331. <module name="JavadocTagContinuationIndentation"/>
  332. <module name="SummaryJavadoc">
  333. <property name="forbiddenSummaryFragments"
  334. value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
  335. </module>
  336. <module name="JavadocParagraph"/>
  337. <module name="RequireEmptyLineBeforeBlockTagGroup"/>
  338. <module name="AtclauseOrder">
  339. <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
  340. <property name="target"
  341. value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
  342. </module>
  343. <module name="JavadocMethod">
  344. <property name="accessModifiers" value="public"/>
  345. <property name="allowMissingParamTags" value="true"/>
  346. <property name="allowMissingReturnTag" value="true"/>
  347. <property name="allowedAnnotations" value="Override, Test"/>
  348. <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"/>
  349. </module>
  350. <module name="MissingJavadocMethod">
  351. <property name="scope" value="public"/>
  352. <property name="minLineCount" value="2"/>
  353. <property name="allowedAnnotations" value="Override, Test"/>
  354. <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,
  355. COMPACT_CTOR_DEF"/>
  356. </module>
  357. <module name="MissingJavadocType">
  358. <property name="scope" value="protected"/>
  359. <property name="tokens"
  360. value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
  361. RECORD_DEF, ANNOTATION_DEF"/>
  362. <property name="excludeScope" value="nothing"/>
  363. </module>
  364. <!-- 方法名的检查 -->
  365. <module name="MethodName" >
  366. <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
  367. <message key="name.invalidPattern"
  368. value="Method name ''{0}'' must match pattern ''{1}''."/>
  369. </module>
  370. <module name="SingleLineJavadoc"/>
  371. <module name="EmptyCatchBlock">
  372. <property name="exceptionVariableName" value="expected"/>
  373. </module>
  374. <module name="CommentsIndentation">
  375. <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
  376. </module>
  377. <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
  378. <module name="SuppressionXpathFilter">
  379. <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
  380. default="checkstyle-xpath-suppressions.xml" />
  381. <property name="optional" value="true"/>
  382. </module>
  383. <!-- 检查是否从非法的包中导入了类 -->
  384. <module name="IllegalImport"/>
  385. <!-- 检查是否导入了多余的包 -->
  386. <module name="RedundantImport"/>
  387. <!-- 没用的import检查,比如:1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
  388. <module name="UnusedImports" />
  389. <!-- 注释检查 -->
  390. <!-- 检查方法和构造函数的javadoc -->
  391. <module name="JavadocType">
  392. <property name="allowUnknownTags" value="true"/>
  393. <message key="javadoc.missing" value="类注释:缺少Javadoc注释。"/>
  394. </module>
  395. <!-- 命名检查 -->
  396. <!-- 局部的final变量,包括catch中的参数的检查 -->
  397. <module name="LocalFinalVariableName" />
  398. <!-- 仅仅是static型的变量(不包括static final型)的检查 -->
  399. <module name="StaticVariableName" />
  400. <!-- 常量名的检查(只允许大写),默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->
  401. <module name="ConstantName" />
  402. <!-- 方法不超过50行 -->
  403. <module name="MethodLength">
  404. <property name="tokens" value="METHOD_DEF" />
  405. <property name="max" value="50" />
  406. </module>
  407. <!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->
  408. <module name="ParameterNumber">
  409. <property name="max" value="5" />
  410. <property name="ignoreOverriddenMethods" value="true"/>
  411. <property name="tokens" value="METHOD_DEF" />
  412. </module>
  413. <!-- 空格检查-->
  414. <!-- 在类型转换时,不允许左圆括号右边有空格,也不允许与右圆括号左边有空格 -->
  415. <module name="TypecastParenPad" />
  416. <!-- 检查在某个特定关键字之后应保留空格 -->
  417. <module name="NoWhitespaceAfter"/>
  418. <!-- 修饰符检查 -->
  419. <!-- 检查接口和annotation中是否有多余修饰符,如接口方法不必使用public -->
  420. <module name="RedundantModifier"/>
  421. <!-- 代码块检查 -->
  422. <!-- 检查是否有嵌套代码块 -->
  423. <module name="AvoidNestedBlocks"/>
  424. <!-- 代码检查 -->
  425. <!-- 检查空的代码段 -->
  426. <module name="EmptyStatement"/>
  427. <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
  428. <module name="EqualsHashCode"/>
  429. <!-- 检查局部变量或参数是否隐藏了类中的变量 -->
  430. <module name="HiddenField">
  431. <property name="tokens" value="VARIABLE_DEF"/>
  432. </module>
  433. <!-- 检查是否使用工厂方法实例化 -->
  434. <module name="IllegalInstantiation"/>
  435. <!-- 检查子表达式中是否有赋值操作 -->
  436. <module name="InnerAssignment"/>
  437. <!-- 检查是否有"魔术"数字 -->
  438. <module name="MagicNumber">
  439. <property name="ignoreNumbers" value="0, 1"/>
  440. <property name="ignoreAnnotation" value="true"/>
  441. </module>
  442. <!-- 检查是否有过度复杂的布尔表达式 -->
  443. <module name="SimplifyBooleanExpression"/>
  444. <!-- 检查是否有过于复杂的布尔返回代码段 -->
  445. <module name="SimplifyBooleanReturn"/>
  446. <!-- 类设计检查 -->
  447. <!-- 检查类是否为扩展设计l -->
  448. <!-- 检查只有private构造函数的类是否声明为final -->
  449. <module name="FinalClass"/>
  450. <!-- 检查工具类是否有putblic的构造器 -->
  451. <module name="HideUtilityClassConstructor"/>
  452. <!-- 检查接口是否仅定义类型 -->
  453. <module name="InterfaceIsType"/>
  454. <!-- 检查类成员的可见度 检查类成员的可见性。只有static final 成员是public的
  455. 除非在本检查的protectedAllowed和packagedAllowed属性中进行了设置-->
  456. <module name="VisibilityModifier">
  457. <property name="packageAllowed" value="true"/>
  458. <property name="protectedAllowed" value="true"/>
  459. </module>
  460. <!-- 语法 -->
  461. <!-- String的比较不能用!= 和 == -->
  462. <module name="StringLiteralEquality"/>
  463. <!-- 限制for循环最多嵌套2层 -->
  464. <module name="NestedForDepth">
  465. <property name="max" value="2"/>
  466. </module>
  467. <!-- if最多嵌套3层 -->
  468. <module name="NestedIfDepth">
  469. <property name="max" value="3"/>
  470. </module>
  471. <!-- 检查未被注释的main方法,排除以Appllication结尾命名的类 -->
  472. <module name="UncommentedMain">
  473. <property name="excludedClasses" value=".*Application$"/>
  474. </module>
  475. <!-- 禁止使用System.out.println -->
  476. <module name="Regexp">
  477. <property name="format" value="System\.out\.println"/>
  478. <property name="illegalPattern" value="true"/>
  479. </module>
  480. <!-- return个数 3个-->
  481. <module name="ReturnCount">
  482. <property name="max" value="3"/>
  483. </module>
  484. <!--try catch 异常处理数量 3-->
  485. <module name="NestedTryDepth ">
  486. <property name="max" value="3"/>
  487. </module>
  488. <!-- clone方法必须调用了super.clone() -->
  489. <module name="SuperClone" />
  490. <!-- finalize 必须调用了super.finalize() -->
  491. <module name="SuperFinalize" />
  492. </module>
  493. </module>