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="error" />

    <property name="fileExtensions" value="java, properties, xml" />

    <!-- Excludes all 'module-info.java' files              -->
    <!-- See https://checkstyle.org/config_filefilters.html -->
    <module name="BeforeExecutionExclusionFileFilter">
        <property name="fileNamePattern" value="module\-info\.java$" />
    </module>

    <!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
    <module name="SuppressionFilter">
        <property name="file" value="${org.checkstyle.sun.suppressionfilter.config}"
            default="checkstyle-suppressions.xml" />
        <property name="optional" value="true" />
    </module>

    <!-- Checks that a package-info.java file exists for each package.     -->
    <!-- See https://checkstyle.org/config_javadoc.html#JavadocPackage -->
    <!-- <module name="JavadocPackage"/>--> <!--BY
    Dew 过于严格 -->

    <!-- Checks whether files end with a new line.                        -->
    <!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
    <module name="NewlineAtEndOfFile" />

    <!-- Checks that property files contain the same keys.         -->
    <!-- See https://checkstyle.org/config_misc.html#Translation -->
    <module name="Translation" />

    <!-- Checks for Size Violations.                    -->
    <!-- See https://checkstyle.org/config_sizes.html -->
    <module name="FileLength" />
    <module name="LineLength">
        <!--由100修改成150-->
        <property name="max" value="150" />
        <property name="ignorePattern"
            value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
    </module>

    <!-- Checks for whitespace                               -->
    <!-- See https://checkstyle.org/config_whitespace.html -->
    <module name="FileTabCharacter" />

    <!-- Miscellaneous other checks.                   -->
    <!-- See https://checkstyle.org/config_misc.html -->
    <module name="RegexpSingleline">
        <property name="format" value="\s+$" />
        <property name="minimum" value="0" />
        <property name="maximum" value="0" />
        <property name="message" value="Line has trailing spaces." />
    </module>

    <module name="TreeWalker">
        <!-- Checks for Javadoc comments.                     -->
        <!-- See https://checkstyle.org/config_javadoc.html -->
        <module name="InvalidJavadocPosition" />
        <module name="JavadocMethod" />
        <module name="JavadocType" />
        <module name="JavadocVariable">
            <property name="scope" value="public" />
        </module>
        <module name="JavadocStyle">
            <property name="checkFirstSentence" value="false" />
        </module>
        <module name="MissingJavadocMethod" />

        <!-- Checks for Naming Conventions.                  -->
        <!-- See https://checkstyle.org/config_naming.html -->
        <module name="ConstantName" />
        <module name="LocalFinalVariableName" />
        <module name="LocalVariableName" />
        <!-- <module name="MemberName"/>--> <!--BY
        Dew E.g. 允许自定义 -->
        <module name="MethodName" />
        <module name="PackageName" />
        <!-- <module name="ParameterName"/>--> <!--BY
        Dew E.g. 允许自定义 -->
        <module name="StaticVariableName" />
        <!--  <module name="TypeName"/> --> <!--BY
        Dew E.g. $.xx -->

        <!-- Checks for imports                              -->
        <!-- See https://checkstyle.org/config_imports.html -->
        <!-- <module name="AvoidStarImport"/>--> <!--BY
        Dew E.g. 允许使用* -->
        <module name="IllegalImport" /> <!-- defaults to sun.* packages -->
        <module name="RedundantImport" />
        <module name="UnusedImports" />

        <!-- Checks for Size Violations.                    -->
        <!-- See https://checkstyle.org/config_sizes.html -->
        <module name="MethodLength" />
        <module name="ParameterNumber">
            <property name="max" value="12" /> <!--BY
            Dew E.g. 放宽限制 -->
        </module>

        <!-- Checks for whitespace                               -->
        <!-- See https://checkstyle.org/config_whitespace.html -->
        <module name="EmptyForIteratorPad" />
        <module name="GenericWhitespace" />
        <module name="MethodParamPad" />
        <module name="NoWhitespaceAfter" />
        <module name="NoWhitespaceBefore" />
        <module name="OperatorWrap">
            <property name="tokens"
                value="QUESTION , COLON , EQUAL , NOT_EQUAL , DIV , MINUS , STAR , MOD , SR , BSR , GE , GT , SL , LE , LT ,
                       BXOR , BOR , LOR , BAND , LAND , TYPE_EXTENSION_AND , LITERAL_INSTANCEOF " />  <!--BY
            Dew E.g. 去掉 PLUS -->

        </module>
        <module name="ParenPad" />
        <module name="TypecastParenPad" />
        <module name="WhitespaceAfter" />
        <module name="WhitespaceAround" />

        <!-- Modifier Checks                                    -->
        <!-- See https://checkstyle.org/config_modifier.html -->
        <module name="ModifierOrder" />
        <module name="RedundantModifier" />

        <!-- Checks for blocks. You know, those {}'s         -->
        <!-- See https://checkstyle.org/config_blocks.html -->
        <module name="AvoidNestedBlocks" />
        <module name="EmptyBlock" />
        <module name="LeftCurly" />
        <module name="NeedBraces" />
        <module name="RightCurly" />

        <!-- Checks for common coding problems               -->
        <!-- See https://checkstyle.org/config_coding.html -->
        <module name="EmptyStatement" />
        <module name="EqualsHashCode" />
        <!-- <module name="HiddenField"/>--> <!--BY
        Dew 没有必要 -->
        <module name="IllegalInstantiation" />
        <module name="InnerAssignment" />
        <!-- <module name="MagicNumber"/>--> <!--BY
        Dew 过于严格 -->
        <module name="MissingSwitchDefault" />
        <module name="MultipleVariableDeclarations" />
        <module name="SimplifyBooleanExpression" />
        <module name="SimplifyBooleanReturn" />

        <!-- Checks for class design                         -->
        <!-- See https://checkstyle.org/config_design.html -->
        <module name="DesignForExtension">
            <property name="ignoredAnnotations" value="Override, Test" /> <!--BY
            Dew 忽略 -->
        </module>
        <!-- <module name="FinalClass"/>--> <!--BY
        Dew 过于严格且在内部类时有问题 -->
        <module name="HideUtilityClassConstructor" />
        <module name="InterfaceIsType" />
        <!-- <module name="VisibilityModifier"/>--> <!--BY
        Dew 对应不可变结构体可直接访问 -->

        <!-- Miscellaneous other checks.                   -->
        <!-- See https://checkstyle.org/config_misc.html -->
        <module name="ArrayTypeStyle" />
        <!-- <module name="FinalParameters"/>--> <!--BY
        Dew 过于严格 -->
        <module name="TodoComment" />
        <module name="UpperEll" />

        <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
        <module name="SuppressionXpathFilter">
            <property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}"
                default="checkstyle-xpath-suppressions.xml" />
            <property name="optional" value="true" />
        </module>

    </module>

</module>