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

<!--
  规则版本号：V1.0（2024-12-10）
  本规则重在编程规范。配置适用于Checkstyle插件版本10.20.2。
-->

<module name="Checker">
    <!-- 设置字符集 -->
    <property name="charset" value="UTF-8"/>

    <!-- 文件长度不超过1500行 -->
    <module name="FileLength">
        <property name="max" value="1500"/>
    </module>

    <!-- 行长度不超过80个字符 -->
    <module name="LineLength">
        <property name="max" value="80"/>
        <property name="ignorePattern" value="^$"/>
    </module>

    <!-- 每个Java文件一个语法树 -->
    <module name="TreeWalker">
        <!-- Javadoc 注释检查 -->
        <!-- 类、接口和枚举必须有Javadoc注释 -->
        <module name="JavadocType">
            <property name="scope" value="public"/>
        </module>
        <!-- 方法级别的Javadoc检查 -->
        <module name="JavadocMethod"/>
        <!-- 公有变量必须有Javadoc注释 -->
        <module name="JavadocVariable">
            <property name="scope" value="public"/>
        </module>
        <!-- 检查Javadoc格式 -->
        <module name="JavadocStyle">
            <property name="checkFirstSentence" value="false"/>
            <property name="checkEmptyJavadoc" value="false"/>
            <property name="checkHtml" value="false"/>
        </module>

        <!-- 命名约定检查 -->
        <!-- 检查数组类型的定义样式 -->
        <module name="ArrayTypeStyle"/>
        <!-- 检查long型定义是否有大写的“L” -->
        <module name="UpperEll"/>
        <!-- 检查常量命名 -->
        <module name="ConstantName">
            <property name="format" value="(^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$)|(^log$)|(^logger$)"/>
        </module>
        <!-- 检查局部final变量命名 -->
        <module name="LocalFinalVariableName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
        </module>
        <!-- 检查局部变量命名 -->
        <module name="LocalVariableName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
        </module>
        <!-- 检查成员变量命名 -->
        <module name="MemberName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
        </module>
        <!-- 检查方法命名 -->
        <module name="MethodName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
        </module>
        <!-- 检查包名命名 -->
        <module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-zA-Z_][a-zA-Z0-9_]*)*$"/>
        </module>
        <!-- 检查参数命名 -->
        <module name="ParameterName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
        </module>
        <!-- 检查静态变量命名 -->
        <module name="StaticVariableName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
        </module>
        <!-- 检查类型名命名 -->
        <module name="TypeName">
            <property name="format" value="^[A-Z][a-zA-Z0-9]*$"/>
        </module>

        <!-- Import 检查 -->
        <!-- 避免使用*通配符导入 -->
        <module name="AvoidStarImport"/>
        <!-- 检查是否有冗余的import语句 -->
        <module name="RedundantImport"/>
        <!-- 检查非法的import语句 -->
        <module name="IllegalImport"/>
        <!-- 检查未使用的import语句 -->
        <module name="UnusedImports"/>

        <!-- 尺寸限制检查 -->
        <!-- 匿名内部类长度不超过60行 -->
        <module name="AnonInnerLength">
            <property name="max" value="60"/>
        </module>
        <!-- 方法长度不超过200行 -->
        <module name="MethodLength">
            <property name="tokens" value="METHOD_DEF"/>
            <property name="max" value="200"/>
        </module>
        <!-- 方法参数数量不超过5个 -->
        <module name="ParameterNumber">
            <property name="max" value="5"/>
            <property name="ignoreOverriddenMethods" value="true"/>
            <property name="tokens" value="METHOD_DEF"/>
        </module>

        <!-- 空白检查 -->
        <!-- 检查方法参数的空格 -->
        <module name="MethodParamPad"/>
        <!-- 检查操作符前后的空白 -->
        <module name="NoWhitespaceAfter"/>
        <module name="NoWhitespaceBefore"/>
        <module name="ParenPad"/>
        <module name="TypecastParenPad"/>
        <!-- 检查各种符号周围的空格 -->
        <module name="WhitespaceAround">
            <property name="tokens" value="COLON,NOT_EQUAL,QUESTION,DIV,DIV_ASSIGN,BXOR,BXOR_ASSIGN,MINUS,LCURLY,RCURLY,STAR,STAR_ASSIGN,TYPE_EXTENSION_AND,BAND,LAND,BAND_ASSIGN,MOD,MOD_ASSIGN,PLUS,PLUS_ASSIGN,LT,SL,SL_ASSIGN,LE,ASSIGN,MINUS_ASSIGN,EQUAL,GT,GE,SR,SR_ASSIGN,BSR,BSR_ASSIGN,BOR,BOR_ASSIGN,LOR,LITERAL_ASSERT,LITERAL_CATCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_RETURN,SLIST,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE"/>
        </module>

        <!-- 修改器检查 -->
        <!-- 检查修饰符的顺序 -->
        <module name="ModifierOrder"/>
        <!-- 检查接口和annotation中是否有多余修饰符 -->
        <module name="RedundantModifier"/>

        <!-- 块检查 -->
        <!-- 检查空块 -->
        <module name="EmptyBlock"/>
        <!-- 左花括号应放在行尾 -->
        <module name="LeftCurly">
            <property name="option" value="eol"/>
        </module>
        <!-- 检查是否需要大括号 -->
        <module name="NeedBraces"/>
        <!-- 避免嵌套的代码块 -->
        <module name="AvoidNestedBlocks">
            <property name="allowInSwitchCase" value="true"/>
        </module>

        <!-- 编码检查 -->
        <!-- 检查子表达式中是否有赋值操作 -->
        <module name="InnerAssignment"/>
        <!-- 检查switch语句是否有default -->
        <module name="MissingSwitchDefault"/>
        <!-- 检查是否有过度复杂的布尔表达式 -->
        <module name="SimplifyBooleanExpression"/>
        <!-- 检查是否有过于复杂的布尔返回代码段 -->
        <module name="SimplifyBooleanReturn"/>
        <!-- 检查空的代码段 -->
        <module name="EmptyStatement"/>
        <!-- 检查equals方法后是否重写了hashCode方法 -->
        <module name="EqualsHashCode"/>
        <!-- 检查局部变量或参数是否隐藏了类中的变量 -->
        <module name="HiddenField">
            <property name="ignoreConstructorParameter" value="true"/>
            <property name="ignoreSetter" value="true"/>
            <property name="ignoreAbstractMethods" value="true"/>
        </module>
        <!-- 检查魔法数字 -->
        <module name="MagicNumber">
            <property name="tokens" value="NUM_DOUBLE, NUM_FLOAT, NUM_LONG"/>
            <property name="ignoreNumbers" value="-1, 0, 1"/>
        </module>
        <!-- 检查try-catch嵌套深度 -->
        <module name="NestedTryDepth">
            <property name="max" value="2"/>
        </module>
        <!-- 检查抛出异常的数量 -->
        <module name="ThrowsCount">
            <property name="max" value="3"/>
        </module>
        <!-- 检查声明的顺序 -->
        <module name="DeclarationOrder"/>
        <!-- 检查不必要的括号 -->
        <module name="UnnecessaryParentheses"/>
        <!-- 检查只有private构造函数的类是否声明为final -->
        <module name="FinalClass"/>
        <!-- 检查接口是否仅定义类型 -->
        <module name="InterfaceIsType"/>
        <!-- 检查String的比较不能用!= 和 == -->
        <module name="StringLiteralEquality"/>
        <!-- 限制for循环最多嵌套2层 -->
        <module name="NestedForDepth">
            <property name="max" value="2"/>
        </module>
        <!-- if最多嵌套3层 -->
        <module name="NestedIfDepth">
            <property name="max" value="3"/>
        </module>

        <!-- 杂项检查 -->
        <!-- 检查未被注释的main方法，排除以Application结尾命名的类 -->
        <module name="UncommentedMain">
            <property name="excludedClasses" value=".*[Application,Test]$"/>
        </module>
        <!-- 禁止使用System.out.println -->
        <module name="Regexp">
            <property name="format" value="System\.out\.println"/>
            <property name="illegalPattern" value="true"/>
        </module>
        <!-- return个数不超过3个 -->
        <module name="ReturnCount">
            <property name="max" value="3"/>
        </module>
        <!-- try-catch 异常处理嵌套深度不超过3 -->
        <module name="NestedTryDepth">
            <property name="max" value="3"/>
        </module>
        <!-- clone方法必须调用了super.clone() -->
        <module name="SuperClone"/>
        <!-- finalize 必须调用了super.finalize() -->
        <module name="SuperFinalize"/>
        <!-- 布尔表达式的复杂度不超过5 -->
        <module name="BooleanExpressionComplexity">
            <property name="max" value="5"/>
        </module>
    </module>
</module>