idea 插件 checkstyle 规则示例和说明

idea 安装插件

idea 配置插件

checkstyle.xml 示例和说明

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>
 
    
    <module name="SuppressionFilter">
        <property name="file" value="scripts/suppressions.xml"/>
    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="200" />
            
            <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">
            
            <property name="allowSingleLineStatement" value="true" />
        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" />
        
        <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">
            
            <property name="id" value="SeparatorWrapEllipsis" />
            <property name="tokens" value="ELLIPSIS" />
            <property name="option" value="EOL" />
        module>
        <module name="SeparatorWrap">
            
            <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-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="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>
        
        <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="4" />
            
            <property name="braceAdjustment" value="0" />
            <property name="caseIndent" value="4" />
            <property name="throwsIndent" value="4" />
            <property name="lineWrappingIndentation" value="4" />
            <property name="arrayInitIndent" value="4" />
        module>
        
        <module name="AbbreviationAsWordInName">
            <property name="ignoreFinal" value="false" />
            <property name="allowedAbbreviationLength" value="3" />
        module>
        
        <module name="OverloadMethodsDeclarationOrder" />
        
        <module name="VariableDeclarationUsageDistance" />
        
        <module name="CustomImportOrder">
            
            <property name="sortImportsInGroupAlphabetically" value="false" />
            <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 )" />
            
            <property name="period" value="" />
        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="allowMissingJavadoc" value="true" />
            <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>

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

<suppressions>
suppressions>

使用插件

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

DOCTYPE module PUBLIC
        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
        "https://checkstyle.org/dtds/configuration_1_3.dtd">


<module name="Checker">
  <property name="severity" value="error"/>
  <property name="charset" value="UTF-8" />

  
  <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">
      
      
      
    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="NestedTryDepth">
    	<property name="max" value="3"/>
    module>
    
    
    
     
    
    <module name="DefaultComesLast"/>
    
    
    <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>
    
    <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="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> 
  <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>

---

（END）