idea 插件 checkstyle 规则示例和说明

idea 安装插件

在这里插入图片描述

idea 配置插件

checkstyle.xml 示例和说明

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
    <!--字符集编码-->
    <property name="charset" value="UTF-8" />
    <!--违规级别-->
    <property name="severity" value="warning" />
    <!--可接受的文件扩展名-->
    <property name="fileExtensions" value="java, properties, xml" />
    <!--检查文件是否包含制表符-->
    <module name="FileTabCharacter">
        <property name="eachLine" value="true" />
    </module>
 
    <!-- 检查样式抑制，value指向的文件路径是相对于项目根目录的路径 -->
    <module name="SuppressionFilter">
        <property name="file" value="scripts/suppressions.xml"/>
    </module>

    <!--检查Java源文件并定义一些适用于检查此类文件的一些属性-->
    <module name="TreeWalker">
        <!--检查外部类型名称和文件名是否匹配，例如，类Foo必须位于名为Foo.java的文件中-->
        <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>
        <!--限制使用Unicode转义-->
        <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="200" /><!--mine-->
            <!--可以忽略检查的行-->
            <property name="ignorePattern"
                value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
        </module>
        <!--检查使用*表示的import语句-->
        <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">
            <!--允许没有大括号的单行语句-->
            <property name="allowSingleLineStatement" value="true" /><!--mine-->
        </module>
        <!--检查代码块的左花括号（'{'）的位置-->
        <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" />
        <!--检查switch语句是否具有“default”子句-->
        <module name="MissingSwitchDefault" />
        <!--检查switch语句-->
        <module name="FallThrough" />
        <!--检查常量是否用大写定义-->
        <module name="UpperEll" />
        <!--检查修饰符是否符合Java建议-->
        <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>
        <!--检查包名称是否符合format属性指定的格式-->
        <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>
        <!--检查类型名称是否符合format属性指定的格式-->
        <module name="TypeName">
            <message key="name.invalidPattern"
                value="Type name ''{0}'' must match pattern ''{1}''." />
        </module>
        <!--检查实例变量名称是否符合format属性指定的格式-->
        <module name="MemberName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$" /><!--mine-->
            <message key="name.invalidPattern"
                value="Member name ''{0}'' must match pattern ''{1}''." />
        </module>
        <!--检查参数名称是否符合format属性指定的格式-->
        <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>
        <!--检查以验证lambda参数名称-->
        <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参数名称是否符合format属性指定的格式-->
        <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变量名称是否符合format属性指定的格式-->
        <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>
        <!--检查类类型参数名称是否符合format属性指定的格式-->
        <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>
        <!--检查方法类型参数名称是否符合format属性指定的格式-->
        <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>
        <!--检查接口类型参数名称是否符合format属性指定的格式-->
        <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>
        <!--验证类中没有定义finalize()方法-->
        <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>
        <!--检查Java代码的正确缩进-->
        <module name="Indentation">
            <!--换行默认缩进字符数-->
            <property name="basicOffset" value="4" /><!--mine-->
            <!--在下一行时，大括号应缩进多远-->
            <property name="braceAdjustment" value="0" />
            <property name="caseIndent" value="4" /><!--mine-->
            <property name="throwsIndent" value="4" />
            <property name="lineWrappingIndentation" value="4" />
            <property name="arrayInitIndent" value="4" /><!--mine-->
        </module>
        <!--检查连续大写字母的长度-->
        <module name="AbbreviationAsWordInName">
            <property name="ignoreFinal" value="false" />
            <property name="allowedAbbreviationLength" value="3" /><!--mine-->
        </module>
        <!--检查重载方法是否组合在一起-->
        <module name="OverloadMethodsDeclarationOrder" />
        <!--检查变量声明与其首次使用之间的距离-->
        <module name="VariableDeclarationUsageDistance" />
        <!--检查导入声明组是否按用户指定的顺序显示-->
        <module name="CustomImportOrder">
            <!--是否按字母顺序导包-->
            <property name="sortImportsInGroupAlphabetically" value="false" /><!--mine-->
            <property name="separateLineBetweenGroups" value="true" />
            <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE" />
        </module>
        <!--检查方法名称和左括号之间的空格-->
        <module name="MethodParamPad" />
        <!--检查tokens指定的字符前面是否有空格-->
        <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" />
        <!--检查Javadoc摘要语句是否包含不建议使用的短语-->
        <module name="SummaryJavadoc">
            <property name="forbiddenSummaryFragments"
                value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )" />
            <!--指定第一个javadoc句末尾的结束符-->
            <property name="period" value="" /><!--mine-->
        </module>
        <!--检查Javadoc段落-->
        <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>
        <!--检查方法或构造函数的Javadoc-->
        <module name="JavadocMethod">
            <property name="allowMissingJavadoc" value="true" /><!--mine-->
            <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>
        <!--检查方法名称是否符合format属性指定的格式-->
        <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>
        <!--检查JavaDoc块是否可以放在一行中，并且不包含@子句-->
        <module name="SingleLineJavadoc">
            <property name="ignoreInlineTags" value="false" />
        </module>
        <!--检查空catch块-->
        <module name="EmptyCatchBlock">
            <property name="exceptionVariableName" value="expected" />
        </module>
        <!--控制注释和周围代码之间的缩进-->
        <module name="CommentsIndentation" />
    </module>
</module>

<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
        "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
        "https://checkstyle.org/dtds/suppressions_1_2.dtd">

<suppressions>
</suppressions>

使用插件

在这里插入图片描述

最后附我个人使用的一个xml（上面那个xml是比较全的解释）

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/dtds/configuration_1_3.dtd">
<!--
    This configuration file was written by the eclipse-cs plugin configuration editor
-->
<!--
    Checkstyle-Configuration: CTP
    Description: none
-->
<module name="Checker">
  <property name="severity" value="error"/>
  <property name="charset" value="UTF-8" />

  <!-- 检查样式抑制，value是指向的路径是相对于项目根目录的 -->
  <module name="SuppressionFilter">
    <property name="file" value="scripts/suppressions.xml"/>
  </module>

  <!-- 长度方面的检查 -->
  <module name="LineLength">
    <property name="max" value="150"/>
    <property name="tabWidth" value="4"/>
  </module>

  <module name="TreeWalker">
    <module name="JavadocMethod">
      <!--<property name="suppressLoadErrors" value="true"/>-->
      <!--<property name="allowUndeclaredRTE" value="true"/>-->
      <!--<property name="allowMissingPropertyJavadoc" value="true"/>-->
    </module>
    <module name="MissingJavadocMethod" />
    <module name="NonEmptyAtclauseDescription" />
    <module name="JavadocVariable"/>
    <module name="JavadocStyle">
      <property name="checkEmptyJavadoc" value="true" />
      <property name="checkFirstSentence" value="false" />
      <property name="checkHtml" value="false" />
      <message key="javadoc.missing" value="空白注释，请确保注释中至少留有一行为纯中文功能描述注释"/>
    </module>
    <module name="JavadocType">
      <property name="scope" value="public" />
      <property name="allowMissingParamTags" value="true" />
      <property name="allowUnknownTags" value="true" />
      <property name="authorFormat" value="[\u4e00-\u9fa5]" />
      <message key="javadoc.missing" value="类注释:缺少Javadoc注释.或者作者格式没按照 @author +中文姓名 来注释"/>
    </module>
    <module name="AnnotationUseStyle">
      <property name="elementStyle" value="ignore" />
      <property name="trailingArrayComma" value="ignore" />
      <property name="closingParens" value="ignore" />
    </module>
    <module name="AvoidStarImport">
      <property name="severity" value="error"/>
      <message key="import.avoidStar" value="请不要使用''.*''进行import - {0}."/>
    </module>
    <!--module name="MultipleStringLiterals"/-->
    <!--module name="MultipleVariableDeclarations"/-->  
    <module name="NestedTryDepth">
    	<property name="max" value="3"/>
    </module>
    <!-- clone方法必须调用了super.clone() -->
    <!--module name="SuperClone"/-->
    <!-- finalize 必须调用了super.finalize() -->
    <!--module name="SuperFinalize"/--> 
    <!-- switch要有default -->
    <module name="DefaultComesLast"/>
    <!--module name="ParameterNumber">
      <message key="maxParam" value="参数太多 ，共{1,number,integer}个，最好不要超过 {0,number,integer}个。"/>
    </module-->
    <!-- 类名(class 或interface) 的检查 -->
    <module name="TypeName" />
    <!-- 变量的检查 -->
    <module name="MemberName" />
    <!-- 方法名的检查 -->
    <module name="MethodName" />
    <!-- 常量名的检查 -->
    <module name="ConstantName" />
    <module name="MethodLength">
      <property name="tokens" value="METHOD_DEF" />
      <property name="max" value="150" />
    </module>
    <!-- 方法的参数个数不超过3个。 -->
    <module name="ParameterNumber">
      <property name="max" value="15" />
    </module>
    <module name="EmptyBlock"/>
    <module name="EmptyStatement"/>
    <module name="InnerAssignment"/>
     <!-- 所有区域都要使用大括号。 -->
    <module name="NeedBraces" />
    <module name="UpperEll">
      <metadata name="net.sf.eclipsecs.core.comment" value="使用大写L，l和1太像"/>
      <property name="severity" value="error"/>
    </module>
    <module name="NestedIfDepth">
      <property name="max" value="3" />
    </module>
    <module name="NestedTryDepth">
      <property name="max" value="3" />
    </module>
    <module name="NestedForDepth">
      <property name="max" value="3" />
    </module>
    <!-- 同一行不能有多个声明 -->
    <module name="MultipleVariableDeclarations" />
    <!--module name="ParameterNumber">
      <property name="severity" value="error"/>
    </module-->
    <!--module name="CyclomaticComplexity"/-->
    <module name="StringLiteralEquality">
      <metadata name="net.sf.eclipsecs.core.comment" value="String比较请使用equals"/>
      <property name="severity" value="error"/>
      <message key="string.literal.equality" value="String比较请使用equals(), 而不是 ''{0}''."/>
    </module>
    <module name="ParameterAssignment">
      <metadata name="net.sf.eclipsecs.core.comment" value="方法参数不允许赋值"/>
      <property name="severity" value="error"/>
      <message key="parameter.assignment" value="请不要对方法的参数赋值：''{0}''"/>
    </module>
    <!--module name="ModifiedControlVariable">
      <metadata name="net.sf.eclipsecs.core.comment" value="不允许修改循环控制变量"/>
      <property name="severity" value="error"/>
    </module-->
    <!--module name="ReturnCount">
      <metadata name="net.sf.eclipsecs.core.comment" value="方法最多允许3个return"/>
      <property name="severity" value="error"/>
      <property name="max" value="4"/>
    </module-->
  </module> 
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="不允许使用System.out.print"/>
    <property name="severity" value="error"/>
    <property name="format" value="System\.out\.print"/>
    <property name="message" value="不允许使用System.out.print，请使用log输出"/>
  </module>
</module>