<?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">
    <!--
        If you set the basedir property below, then all reported file
        names will be relative to the specified directory. See
        http://checkstyle.sourceforge.net/5.x/config.html#Checker
        <property name="basedir" value="${basedir}"/>
    -->
    <!-- 检查每个包中是否有java注释文件，默认有package-info.java -->
    <!-- <module name="JavadocPackage"/> -->
    <!-- 检查文件是否以一个空行结束 -->
    <!-- <module name="NewlineAtEndOfFile"/> -->

    <!-- 检查property文件中是否有相同的key -->
    <module name="Translation"/>
    <!-- 文件长度不超过1500行 -->
    <module name="FileLength">
        <property name="max" value="1500"/>
    </module>

    <!-- 检查文件中是否含有'\t' -->
    <!-- <module name="FileTabCharacter"/> -->

    <!-- Miscellaneous other checks. -->
    <module name="RegexpSingleline">
        <property name="format" value="^\s$"/>
        <property name="minimum" value="0"/>
        <property name="maximum" value="0"/>
    </module>

    <!-- 每个java文件一个语法树 -->
    <module name="TreeWalker">

        <!-- =============注释检查============= -->

        <!-- 检查方法的javadoc的注释
            scope: 可以检查的方法的范围，例如：public只能检查public修饰的方法，private可以检查所有的方法
            allowMissingParamTags: 是否忽略对参数注释的检查
            allowMissingThrowsTags: 是否忽略对throws注释的检查
            allowMissingReturnTag: 是否忽略对return注释的检查
        -->
        <module name="JavadocMethod">
            <property name="scope" value="private"/>
            <property name="allowMissingParamTags" value="true"/>
            <property name="allowMissingThrowsTags" value="true"/>
            <property name="allowMissingReturnTag" value="true"/>
            <property name="tokens" value="METHOD_DEF" />
            <property name="allowUndeclaredRTE" value="true"/>
            <property name="allowThrowsTagsForSubclasses" value="true"/>
            <!--允许get set 方法没有注释-->
            <!-- <property name="allowMissingPropertyJavadoc" value="true"/> -->
            <!--有此注释跳过javaDoc检查-->
            <property name="allowedAnnotations" value ="SuppressWarnings,Override"/>
        </module>

        <!--允许get set 方法没有注释-->
        <!-- ！！！注意！！！ -->
        <!-- ！！！注意！！！ -->
        <!-- ！！！注意！！！ -->
        <!-- 最低版本为 Checkstyle 8.21 否则无效 -->
        <module name="MissingJavadocMethod">
            <property name="allowMissingPropertyJavadoc" value="true"/>
            <!-- 排除被以下注解标注的方法 -->
            <property name="allowedAnnotations" value="Override,Deprecated,Test,SuppressWarnings,ApiOperation,Bean"/>
            <!-- 排除开头为以下字符串的方法 -->
            <property name="ignoreMethodNamesRegex" value="^(get|set|is|main|select|delete|update|insert|list|input|save|init|lock|unLock|modifyById|page).*$"/>
            <!-- 排除构造方法 -->
            <property name="tokens" value="METHOD_DEF,ANNOTATION_FIELD_DEF"/>
        </module>

        <!--允许以下注解的类没有注释-->
        <!-- ！！！注意！！！ -->
        <!-- ！！！注意！！！ -->
        <!-- ！！！注意！！！ -->
        <!-- 最低版本为 Checkstyle 8.20 否则无效 -->
        <module name="MissingJavadocType">
            <property name="skipAnnotations" value="SpringBootApplication,Configuration"/>
        </module>

        <!-- 检查类和接口的javadoc 默认不检查author 和version tags
            authorFormat: 检查author标签的格式
            versionFormat: 检查version标签的格式
            scope: 可以检查的类的范围，例如：public只能检查public修饰的类，private可以检查所有的类
            excludeScope: 不能检查的类的范围，例如：public，public的类将不被检查，但访问权限小于public的类仍然会检查，其他的权限以此类推
            tokens: 该属性适用的类型，例如：CLASS_DEF,INTERFACE_DEF
        -->
        <module name="JavadocType">
            <property name="authorFormat" value="\S"/>
            <property name="scope" value="protected"/>
            <property name="versionFormat" value="\$Revision.*\$"/>
            <property name="excludeScope" value="public"/>
            <property name="tokens" value="CLASS_DEF,INTERFACE_DEF"/>
        </module>

        <!-- 检查变量是否具有Javadoc注释
            scope: 检查变量的范围，例如：public只能检查public修饰的变量，private可以检查所有的变量 -->
        <!-- <module name="JavadocVariable">
            <property name="scope" value="private"/> -->
            <!-- 屏蔽指定字符串结尾的警告 -->
            <!-- <property name="ignoreNamePattern" value ="^[\w]*(controller|service|mapper|Controller|Service|Mapper|Task)$" /> -->
            <!-- 取消常量注释检查 -->
            <!-- <property name="tokens" value="CTOR_DEF"/> -->
        <!-- </module> -->

        <!-- 检查javadoc的格式 -->
        <module name="JavadocStyle">
            <property name="checkFirstSentence" value="false"/>
        </module>
        <!-- 检查TODO:注释 -->
        <module name="TodoComment"/>


        <!-- =============命名检查============= -->

        <!-- 局部的final变量，包括catch中的参数的检查 -->
        <module name="LocalFinalVariableName" />
        <!-- 局部的非final型的变量，包括catch中的参数的检查 -->
        <module name="LocalVariableName" />
        <!-- 包名的检查（只允许小写字母），默认^[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>
        <!-- 仅仅是static型的变量（不包括static final型）的检查 -->
        <module name="StaticVariableName" />
        <!-- 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型变量的检查 -->
        <!-- 检查成员变量（非静态字段）的名称是否遵守命名规约
            format: 定义非静态成员变量的命名规则
　　　　    applyToPublic: 是否适用于public的成员变量
　　　　    applyToProtected: 是否适用于protected的成员变量
　　　　    applyToPackage: 是否适用于package的成员变量
　　　　    applyToPrivate: 是否适用于private的成员变量 -->
        <module name="MemberName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
            <property name="applyToPublic" value="true"/>
            <property name="applyToProtected" value="true"/>
            <property name="applyToPackage" value="true"/>
            <property name="applyToPrivate" value="true"/>
        </module>
        <!-- 方法名的检查 -->
        <module name="MethodName" />
        <!-- 方法的参数名 -->
        <module name="ParameterName " />
        <!-- 常量名的检查（只允许大写），默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->
        <module name="ConstantName" />

        <!-- 定义检查 -->
        <!-- 检查数组类型定义的样式 -->
        <module name="ArrayTypeStyle"/>
        <!-- 检查方法名、构造函数、catch块的参数是否是final的 -->
        <!-- <module name="FinalParameters"/> -->
        <!-- 检查long型定义是否有大写的“L” -->
        <module name="UpperEll"/>


        <!-- Checks for Headers                                -->
        <!-- See http://checkstyle.sf.net/config_header.html   -->
        <!-- <module name="Header">                            -->
        <!-- The follow property value demonstrates the ability     -->
        <!-- to have access to ANT properties. In this case it uses -->
        <!-- the ${basedir} property to allow Checkstyle to be run  -->
        <!-- from any directory within a project. See property      -->
        <!-- expansion,                                             -->
        <!-- http://checkstyle.sf.net/config.html#properties        -->
        <!-- <property                                              -->
        <!--     name="headerFile"                                  -->
        <!--     value="${basedir}/java.header"/>                   -->
        <!-- </module> -->

        <!-- Following interprets the header file as regular expressions. -->
        <!-- <module name="RegexpHeader"/>                                -->


        <!-- =============import检查=============-->

        <!-- 避免使用* -->
        <!--检查没有import语句使用*符号
            excludes: 定义可以使用*导入的包 -->
        <module name="AvoidStarImport">
            <property name="excludes" value="java.io,java.util"/>
        </module>
        <!-- 检查是否从非法的包中导入了类 -->
        <module name="IllegalImport"/>
        <!-- 检查是否导入了多余的包 -->
        <module name="RedundantImport"/>
        <!-- 没用的import检查，比如：1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
        <module name="UnusedImports" />


        <!-- =============长度检查============= -->

        <!--　检查源码每行的长度 -->
        <module name="LineLength">
            <property name="max" value="200"/>
            <property name="ignorePattern" value="^ *\* *[^ ]+$"/>
        </module>
        <!--　检查方法和构造器的长度
            max: 最多容许的行数
　　　　    countEmpty: 是否计算空行
　　　　    tokens: 定义检查的类型 -->
        <module name="MethodLength">
            <property name="max" value="200"/>
            <property name="countEmpty" value="true"/>
            <property name="tokens" value="METHOD_DEF"/>
        </module>
        <!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->
        <module name="ParameterNumber">
            <property name="max" value="10" />
            <property name="ignoreOverriddenMethods" value="true"/>
            <property name="tokens" value="METHOD_DEF" />
        </module>
        <!--　检查要执行的语句的数目，将可执行语句的数量限制为一个指定的限值
            max: 定义所能容许的语句的最多数目
　　　　    tokens: 定义可以检查的类型，例如：CTOR_DEF,METHOD_DEF,STATIC_INIT,INSTANCE_INIT -->
        <module name="ExecutableStatementCount">
            <property name="max" value="40"/>
            <property name="tokens" value="CTOR_DEF,METHOD_DEF,INSTANCE_INIT"/>
        </module>

        <!--　检查一个方法或构造器的参数的数量
            max: 定义最多有多少个参数
　　　　    tokens: 定义检查的类型　 -->
        <module name="ParameterNumber">
            <property name="max" value="10"/>
            <property name="tokens" value="METHOD_DEF,CTOR_DEF"/>
        </module>



        <!-- =============空格检查============= -->

        <!--　检查空的for循环初始化语句的填充符
            option: 定义初始化语句中是否使用空格，例如：space表示使用空格，则for(int i = 0; i < 100; i++)
            就是符合格式要求的，而for(int i=0; i<100;i++)就不符合要求　 -->
        <module name="EmptyForInitializerPad">
            <property name="option" value="space"/>
        </module>

        <!--　检查for iterator语句是否使用空格
            option:定义初始化语句是否使用空格，例如：space表示使用空格，则for(Iterator iterator = List.iterator();iterator.hasNext(); iterator.next())就是形式合理的，否则就是形式不合理的 -->
        <module name="EmptyForIteratorPad">
            <property name="option" value="space"/>
        </module>

        <!--　检查指定标记之后没有空格。若要禁用指定标记之后的换行符，将allowLineBreaks属性设为false即可。 -->
        <module name="NoWhitespaceAfter"/>

        <!--　检查指定标记之前没有空格。若要允许指定标记之前的换行符，将allowLineBreaks属性设为true即可 -->
        <module name="NoWhitespaceBefore"/>

        <!--　检查代码自动换行时，运算符所处位置的策略
            option: 定义运算符的位置，eol在同一行，nl在下一行
　　　　    tokens: 定义检查的类型 -->
        <module name="OperatorWrap">
            <property name="tokens"
                value="ASSIGN, DIV, DIV_ASSIGN, PLUS_ASSIGN, MINUS, MINUS_ASSIGN, STAR, STAR_ASSIGN, MOD, MOD_ASSIGN, SR, SR_ASSIGN, BSR, BSR_ASSIGN, SL, SL_ASSIGN, BXOR, BXOR_ASSIGN, BOR, BOR_ASSIGN, BAND, BAND_ASSIGN,PLUS, QUESTION"/>
            <property name="option" value="eol"/>
        </module>

        <!--　检查方法定义、构造器定义、方法调用、构造器调用的标识符和参数列表的左圆括号之间的填充符
            allowLineBreaks: 参数是否允许在不同行
　　　　    option: 在参数和括号、参数和标识符之间是否包含空格
　　　　    tokens: 检查的类型 -->
        <module name="MethodParamPad">
            <property name="allowLineBreaks" value="false"/>
            <property name="option" value="nospace"/>
            <property name="tokens" value="METHOD_DEF,CTOR_DEF"/>
        </module>

        <!--　检查圆括号的填充符策略，也就是在左圆括号之后和右圆括号之前是否需要有一个空格
            option: space表示有空格，nospace表示没有空格
　　　　    tokens: 定义检查的类型 -->
        <module name="ParenPad">
            <property name="option" value="nospace"/>
        </module>

        <!--　检查类型转换的圆括号的填充符策略。也就是，在左圆括号之后和右圆括号之前是否需要有一个空格
            option: space表示有空格，nospace表示没有空格
　　　　    tokens: 定义检查的类型 -->
        <module name="TypecastParenPad">
            <property name="option" value="nospace"/>
        </module> 

        <!--　检查指定标记之后是否紧跟了空格
        　    tokens: 检查的类型 -->
        <module name="WhitespaceAfter">
            <property name="tokens" value="COMMA,SEMI,TYPECAST,LITERAL_IF,LITERAL_ELSE,LITERAL_WHILE,LITERAL_DO,LITERAL_FOR,DO_WHILE"/>
        </module>

        <!--　检查指定标记的周围是否有空格
            可以选择性地从检查策略中排除，通过设置allowEmptyMethods和allowEmptyConstructors属性即可
        　    tokens: 检查的类型 -->
        <module name="WhitespaceAround">
            <!-- <property name="tokens" value=" LCURLY , LE , LITERAL_CATCH , LITERAL_DO , LITERAL_ELSE , LITERAL_FINALLY , LITERAL_FOR , LITERAL_IF , LITERAL_RETURN , LITERAL_SWITCH , LITERAL_SYNCHRONIZED , LITERAL_TRY , LITERAL_WHILE"/> -->
        </module>


        <!-- 修饰符检查 -->
        <!-- 检查修饰符的顺序是否遵照java语言规范，默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->
        <module name="ModifierOrder"/>
        <!--　在以下部分检查是否有多余的修饰符：
　　　　    1. 接口和注解的定义；
　　　　    2. final类的方法的final修饰符；
　　　　    3. 被声明为static的内部接口声明
　            tokens: 检查的类型 -->
        <module name="RedundantModifier">
            <property name="tokens" value="METHOD_DEF"/>
        </module>


        <!-- =============代码块检查============= -->

        <!-- 检查是否有嵌套代码块 -->
        <module name="AvoidNestedBlocks"/>
        <!-- 检查是否有空代码块 -->
        <module name="EmptyBlock"/>
        <!-- 检查左大括号位置 -->
        <module name="LeftCurly"/>
        <!-- 检查代码块是否缺失{} -->
        <module name="NeedBraces"/>
        <!-- 检查右大括号位置 -->
        <module name="RightCurly"/>


        <!-- 代码检查 -->
        <!-- 检查是否在同一行初始化 -->
        <!-- <module name="AvoidInlineConditionals"/> -->
        <!-- 检查空的代码段 -->
        <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="-20,-19,-18,-17,-16,-15,-14,-13,-12,-11,-10,-9,-8,-7,-6,-5,-4,-3,-2,-1,0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20"/>
            <property name="ignoreAnnotation" value="true"/>
            <property name="ignoreHashCodeMethod" value="true"/>
            <property name="ignoreFieldDeclaration" value="true"/>
        </module>
        <!-- 检查switch语句是否有default -->
        <module name="MissingSwitchDefault"/>
        <!-- 检查是否有过度复杂的布尔表达式 -->
        <module name="SimplifyBooleanExpression"/>
        <!-- 检查是否有过于复杂的布尔返回代码段 -->
        <module name="SimplifyBooleanReturn"/>

        <!-- 类设计检查 -->
        <!-- 检查类是否为扩展设计l -->
        <!-- <module name="DesignForExtension"/> -->
        <!-- 检查只有private构造函数的类是否声明为final -->
        <module name="FinalClass"/>
        <!-- 检查工具类是否有putblic的构造器 -->
        <!-- <module name="HideUtilityClassConstructor"/> -->
        <!-- 检查接口是否仅定义类型 -->
<!--        <module name="InterfaceIsType"/>-->
        <!-- 检查类成员的可见度 -->
        <module name="VisibilityModifier">
            <!-- 允许同包下的所有类型 -->
            <property name="packageAllowed" value="true"/>
            <!-- 允许protected类修饰的属性 -->
            <property name="protectedAllowed" value="true"/>
        </module>


        <!-- 其他检查 -->
        <!-- 文件中使用了System.out.print等
        <module name="GenericIllegalRegexp">
            <property name="format" value="System\.out\.print"/>
        </module>
        <module name="GenericIllegalRegexp">
            <property name="format" value="System\.exit"/>
        </module>
        <module name="GenericIllegalRegexp">
            <property name="format" value="printStackTrace"/>
        </module>-->

        <!-- 代码质量 -->
        <!-- 圈复杂度
        <module name="CyclomaticComplexity">
              <property name="max" value="2"/>
        </module> -->


    </module>
</module>