checkstyle.xml 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  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. <module name="NewlineAtEndOfFile"/>
  8. <!-- 文件长度不超过1500行 -->
  9. <module name="FileLength">
  10. <property name="max" value="1500"/>
  11. </module>
  12. <!-- 每个java文件一个语法树 -->
  13. <module name="TreeWalker">
  14. <!-- import检查-->
  15. <!-- 避免使用*
  16. <module name="AvoidStarImport">
  17. <property name="excludes" value="java.io,java.net,java.lang.Math"/>
  18. 实例;import java.util.*;.
  19. <property name="allowClassImports" value="false"/>
  20. 实例 ;import static org.junit.Assert.*;
  21. <property name="allowStaticMemberImports" value="true"/>
  22. </module>
  23. -->
  24. <!-- 检查是否从非法的包中导入了类 -->
  25. <module name="IllegalImport"/>
  26. <!-- 检查是否导入了多余的包 -->
  27. <module name="RedundantImport"/>
  28. <!-- 没用的import检查,比如:1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
  29. <module name="UnusedImports" />
  30. <!-- 注释检查 -->
  31. <!-- 检查方法和构造函数的javadoc -->
  32. <module name="JavadocType">
  33. <property name="allowUnknownTags" value="true"/>
  34. <message key="javadoc.missing" value="类注释:缺少Javadoc注释。"/>
  35. </module>
  36. <module name="JavadocMethod">
  37. <property name="tokens" value="METHOD_DEF" />
  38. <!--允许get set 方法没有注释-->
  39. <property name="allowMissingPropertyJavadoc" value="true"/>
  40. <message key="javadoc.missing" value="方法注释:缺少Javadoc注释。"/>
  41. </module>
  42. <!-- 命名检查 -->
  43. <!-- 局部的final变量,包括catch中的参数的检查 -->
  44. <module name="LocalFinalVariableName" />
  45. <!-- 局部的非final型的变量,包括catch中的参数的检查 -->
  46. <module name="LocalVariableName" />
  47. <!-- 包名的检查(只允许小写字母),默认^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ -->
  48. <module name="PackageName">
  49. <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
  50. <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
  51. </module>
  52. <!-- 仅仅是static型的变量(不包括static final型)的检查 -->
  53. <module name="StaticVariableName" />
  54. <!-- Class或Interface名检查,默认^[A-Z][a-zA-Z0-9]*$-->
  55. <module name="TypeName">
  56. <property name="severity" value="warning"/>
  57. <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
  58. </module>
  59. <!-- 非static型变量的检查 -->
  60. <module name="MemberName" />
  61. <!-- 方法名的检查 -->
  62. <module name="MethodName" />
  63. <!-- 方法的参数名 -->
  64. <module name="ParameterName " />
  65. <!-- 常量名的检查(只允许大写),默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->
  66. <module name="ConstantName" />
  67. <!-- 定义检查 -->
  68. <!-- 检查数组类型定义的样式 -->
  69. <module name="ArrayTypeStyle"/>
  70. <!-- 检查long型定义是否有大写的“L” -->
  71. <module name="UpperEll"/>
  72. <!-- 长度检查 -->
  73. <!-- 每行不超过120个字符-->
  74. <module name="LineLength">
  75. <property name="max" value="150" />
  76. </module>
  77. <!-- 方法不超过50行 -->
  78. <module name="MethodLength">
  79. <property name="tokens" value="METHOD_DEF" />
  80. <property name="max" value="160" />
  81. </module>
  82. <!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->
  83. <module name="ParameterNumber">
  84. <property name="max" value="5" />
  85. <property name="ignoreOverriddenMethods" value="true"/>
  86. <property name="tokens" value="METHOD_DEF" />
  87. </module>
  88. <!-- 空格检查-->
  89. <!-- 方法名后跟左圆括号"(" -->
  90. <module name="MethodParamPad" />
  91. <!-- 在类型转换时,不允许左圆括号右边有空格,也不允许与右圆括号左边有空格 -->
  92. <module name="TypecastParenPad" />
  93. <!-- 检查在某个特定关键字之后应保留空格 -->
  94. <module name="NoWhitespaceAfter"/>
  95. <!-- 检查在某个特定关键字之前应保留空格 -->
  96. <module name="NoWhitespaceBefore"/>
  97. <!-- 操作符换行策略检查 -->
  98. <module name="OperatorWrap"/>
  99. <!-- 圆括号空白 -->
  100. <module name="ParenPad"/>
  101. <!-- 检查分隔符是否在空白之后 -->
  102. <module name="WhitespaceAfter"/>
  103. <!-- 检查分隔符周围是否有空白 -->
  104. <module name="WhitespaceAround"/>
  105. <!-- 修饰符检查 -->
  106. <!-- 检查修饰符的顺序是否遵照java语言规范,默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->
  107. <module name="ModifierOrder"/>
  108. <!-- 检查接口和annotation中是否有多余修饰符,如接口方法不必使用public -->
  109. <module name="RedundantModifier"/>
  110. <!-- 代码块检查 -->
  111. <!-- 检查是否有嵌套代码块 -->
  112. <module name="AvoidNestedBlocks"/>
  113. <!-- 检查是否有空代码块 -->
  114. <module name="EmptyBlock"/>
  115. <!-- 检查左大括号位置 -->
  116. <module name="LeftCurly"/>
  117. <!-- 检查代码块是否缺失{} -->
  118. <module name="NeedBraces"/>
  119. <!-- 检查右大括号位置 -->
  120. <module name="RightCurly"/>
  121. <!-- 代码检查 -->
  122. <!-- 检查空的代码段 -->
  123. <module name="EmptyStatement"/>
  124. <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
  125. <module name="EqualsHashCode"/>
  126. <!-- 检查局部变量或参数是否隐藏了类中的变量 -->
  127. <module name="HiddenField">
  128. <property name="tokens" value="VARIABLE_DEF"/>
  129. </module>
  130. <!-- 检查是否使用工厂方法实例化 -->
  131. <module name="IllegalInstantiation"/>
  132. <!-- 检查子表达式中是否有赋值操作 -->
  133. <module name="InnerAssignment"/>
  134. <!-- 检查是否有"魔术"数字 -->
  135. <module name="MagicNumber">
  136. <property name="ignoreNumbers" value="0, 1"/>
  137. <property name="ignoreAnnotation" value="true"/>
  138. </module>
  139. <!-- 检查switch语句是否有default -->
  140. <module name="MissingSwitchDefault"/>
  141. <!-- 检查是否有过度复杂的布尔表达式 -->
  142. <module name="SimplifyBooleanExpression"/>
  143. <!-- 检查是否有过于复杂的布尔返回代码段 -->
  144. <module name="SimplifyBooleanReturn"/>
  145. <!-- 类设计检查 -->
  146. <!-- 检查类是否为扩展设计l -->
  147. <!-- 检查只有private构造函数的类是否声明为final -->
  148. <module name="FinalClass"/>
  149. <!-- 检查工具类是否有putblic的构造器 -->
  150. <module name="HideUtilityClassConstructor"/>
  151. <!-- 检查接口是否仅定义类型 -->
  152. <module name="InterfaceIsType"/>
  153. <!-- 检查类成员的可见度 检查类成员的可见性。只有static final 成员是public的
  154. 除非在本检查的protectedAllowed和packagedAllowed属性中进行了设置-->
  155. <module name="VisibilityModifier">
  156. <property name="packageAllowed" value="true"/>
  157. <property name="protectedAllowed" value="true"/>
  158. </module>
  159. <!-- 语法 -->
  160. <!-- String的比较不能用!= 和 == -->
  161. <module name="StringLiteralEquality"/>
  162. <!-- 限制for循环最多嵌套2层 -->
  163. <module name="NestedForDepth">
  164. <property name="max" value="2"/>
  165. </module>
  166. <!-- if最多嵌套3层 -->
  167. <module name="NestedIfDepth">
  168. <property name="max" value="3"/>
  169. </module>
  170. <!-- 检查未被注释的main方法,排除以Appllication结尾命名的类 -->
  171. <module name="UncommentedMain">
  172. <property name="excludedClasses" value=".*Application$"/>
  173. </module>
  174. <!-- 禁止使用System.out.println -->
  175. <module name="Regexp">
  176. <property name="format" value="System\.out\.println"/>
  177. <property name="illegalPattern" value="true"/>
  178. </module>
  179. <!-- return个数 3个-->
  180. <module name="ReturnCount">
  181. <property name="max" value="3"/>
  182. </module>
  183. <!--try catch 异常处理数量 3-->
  184. <module name="NestedTryDepth ">
  185. <property name="max" value="3"/>
  186. </module>
  187. <!-- clone方法必须调用了super.clone() -->
  188. <module name="SuperClone" />
  189. <!-- finalize 必须调用了super.finalize() -->
  190. <module name="SuperFinalize" />
  191. </module>
  192. </module>