IDEA checkstyle插件安装及使用

╰+攻爆jí腚メ 2023-10-01 21:05 60阅读 0赞

## 流程 ##

1、首先打开IDEA菜单栏的Settings中的plugins，搜索CheckStyle-IDEA并安装:

2、安装重启IDEA之后，Settings下搜索Inspections,再查询CheckStyle，如果能查询到内容，说明安装成功：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAZkZlZS1vcHM_size_20_color_FFFFFF_t_70_g_se_x_16]  
3、配置checkStyle 在Settings中搜索CheckStyle，按下图导入上一步骤新建的checkstyle.xml文件(version要选择对)，文件在下方代码块中:  
**checkStyle版本: 8.1,不同版本对于checkStyle.xml格式是不一样的，一定要选对插件的版本**

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAZkZlZS1vcHM_size_20_color_FFFFFF_t_70_g_se_x_16 1]  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAZkZlZS1vcHM_size_20_color_FFFFFF_t_70_g_se_x_16 2]

4、使用checkStyle可以选择单个文件，也可以扫描整个包或整个项目，可以点击下图两个按钮，有文字提示：

上方的Rules要选择刚才上传的checkStyle文件

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAZkZlZS1vcHM_size_20_color_FFFFFF_t_70_g_se_x_16 3]  
5、静态检查通常会检查出大量的 “陈年老代码” 带来的历史遗留问题，而这些问题大部分没人维护，尽量不要进行随意修改；仅修改自己本次需要提交更改的部分符合规则即可

**checkstyle.xml:**

<?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">
        <module name="TreeWalker">
            
            
            <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>
    
            
            <module name="JavadocMethod">
                <property name="scope" value="private"/>
                <property name="allowMissingParamTags" value="false"/>
                <property name="allowMissingThrowsTags" value="false"/>
                <property name="allowMissingReturnTag" value="false"/>
                <property name="tokens" value="METHOD_DEF"/>
                <property name="allowUndeclaredRTE" value="true"/>
                <property name="allowThrowsTagsForSubclasses" value="true"/>
                
                <property name="allowMissingPropertyJavadoc" value="true"/>
            </module>
    
            
            
            
            
            
    
            
            <module name="ConstantName">
                <property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
            </module>
    
            
            <module name="LocalFinalVariableName">
                <property name="format" value="^[A_Z][A-Z0-9]*(_[A_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]*$"/>
                <property name="applyToPublic" value="true"/>
                <property name="applyToProtected" value="true"/>
                <property name="applyToPackage" value="true"/>
                <property name="applyToPrivate" value="true"/>
            </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-z][a-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]*$"/>
                <property name="tokens" value="CLASS_DEF,INTERFACE_DEF"/>
            </module>
    
    
            
            
            <module name="AvoidStarImport">
                <property name="excludes" value="java.io,java.util"/>
            </module>
    
            
            <module name="IllegalImport"/>
    
            
            <module name="ImportOrder">
                <property name="groups" value="java,javax"/>
                <property name="ordered" value="true"/>
                <property name="separated" value="true"/>
                <property name="caseSensitive" value="true"/>
            </module>
    
            
            <module name="RedundantImport"/>
    
            
            <module name="UnusedImports"/>
    
    
            
            
            <module name="AnonInnerLength">
                <property name="max" value="20"/>
            </module>
    
            
            <module name="ExecutableStatementCount">
                <property name="max" value="20"/>
                <property name="tokens" value="CTOR_DEF,METHOD_DEF,STATIC_INIT,INSTANCE_INIT"/>
            </module>
    
            
            
            
            
            
    
            
            <module name="LineLength">
                <property name="max" value="80"/>
                <property name="ignorePattern" value="^ *\* *[^ ]+$"/>
            </module>
    
            
            <module name="MethodLength">
                <property name="max" value="100"/>
                <property name="countEmpty" value="true"/>
                <property name="tokens" value="METHOD_DEF"/>
            </module>
    
            
            <module name="ParameterNumber">
                <property name="max" value="10"/>
                <property name="tokens" value="METHOD_DEF,CTOR_DEF"/>
            </module>
    
    
            
            
            <module name="EmptyForInitializerPad">
                <property name="option" value="space"/>
            </module>
    
            
            <module name="EmptyForIteratorPad">
                <property name="option" value="space"/>
            </module>
    
            
            <module name="NoWhitespaceAfter"/>
    
            
            <module name="NoWhitespaceBefore"/>
    
            
            <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>
    
            
            <module name="MethodParamPad">
                <property name="allowLineBreaks" value="false"/>
                <property name="option" value="space"/>
                <property name="tokens" value="METHOD_DEF,CTOR_DEF"/>
            </module>
    
            
            <module name="ParenPad">
                <property name="option" value="nospace"/>
            </module>
    
            
            <module name="TypecastParenPad">
                <property name="option" value="space"/>
            </module>
    
            
            <module name="WhitespaceAfter">
                <property name="tokens" value="COMMA,SEMI,TYPECAST"/>
            </module>
    
            
            <module name="WhitespaceAround">
                <property name="tokens" value="ASSIGN"/>
            </module>
    
    
            
            
            <module name="ModifierOrder"/>
    
            
            <module name="RedundantModifier">
                <property name="tokens" value="METHOD_DEF,VARIABLE_DEF"/>
            </module>
    
    
            
            
            <module name="AvoidNestedBlocks">
                <property name="allowInSwitchCase" value="true"/>
            </module>
    
    
    
            
            
            
            
            
            
            
            
            
    
            
            <module name="NeedBraces"/>
    
            
            <module name="RightCurly">
                <property name="option" value="alone"/>
                <property name="tokens" value="LITERAL_TRY"/>
            </module>
    
    
            
            
            <module name="AvoidInlineConditionals"/>
    
            
            <module name="CovariantEquals"/>
    
            
            <module name="DefaultComesLast"/>
    
            
            <module name="EmptyStatement"/>
    
            
            <module name="EqualsHashCode"/>
    
            
            <module name="ExplicitInitialization"/>
    
            
            <module name="FallThrough"/>
    
            
            <module name="FinalLocalVariable"/>
    
            
            <module name="HiddenField"/>
    
            
            <module name="IllegalInstantiation"/>
    
            
            <module name="IllegalCatch"/>
    
            
            <module name="InnerAssignment"/>
    
            
            <module name="MagicNumber">
                <property name="ignoreNumbers" value="0, 1"/>
                <property name="ignoreAnnotation" value="true"/>
            </module>
    
            
            <module name="MissingSwitchDefault"/>
    
            
            <module name="ModifiedControlVariable"/>
    
            
            <module name="MultipleStringLiterals">
                <property name="allowedDuplicates" value="3"/>
            </module>
    
            
            <module name="MultipleVariableDeclarations"/>
    
            
            <module name="NestedIfDepth">
                <property name="max" value="1"/>
            </module>
    
            
            <module name="NestedTryDepth">
                <property name="max" value="3"/>
            </module>
    
            
            <module name="PackageDeclaration"/>
    
            
            <module name="ParameterAssignment"/>
    
    
            
            <module name="RequireThis">
                <property name="checkFields" value="false"/>
                <property name="checkMethods" value="false"/>
            </module>
    
            
            <module name="Regexp">
                <property name="format" value="System\.out\.println"/>
                <property name="illegalPattern" value="true"/>
            </module>
    
            
            <module name="ReturnCount">
                <property name="max" value="3"/>
            </module>
    
            
            <module name="SimplifyBooleanExpression"/>
    
            
            <module name="SimplifyBooleanReturn"/>
    
            
            <module name="StringLiteralEquality"/>
    
            
            <module name="SuperClone"/>
    
            
            <module name="SuperFinalize"/>
    
            
            <module name="ArrayTrailingComma"/>
    
            
            <module name="UnnecessaryParentheses"/>
    
    
            
            
            <module name="DesignForExtension"/>
    
            
            <module name="FinalClass"/>
    
            
            <module name="HideUtilityClassConstructor"/>
    
            
            <module name="InterfaceIsType">
                <property name="allowMarkerInterfaces" value="true"/>
            </module>
    
            
            <module name="ThrowsCount">
                <property name="max" value="7"/>
            </module>
    
            
            <module name="VisibilityModifier">
                <property name="packageAllowed" value="false"/>
                <property name="protectedAllowed" value="false"/>
                <property name="publicMemberPattern" value="^seriaVersionUID$"/>
            </module>
    
    
    
            
            
            <module name="BooleanExpressionComplexity">
                <property name="max" value="7"/>
            </module>
    
            
            <module name="ClassDataAbstractionCoupling">
                <property name="max" value="7"/>
            </module>
    
            
            <module name="CyclomaticComplexity">
                <property name="severity" value="ignore"/>
            </module>
    
    
            
            
            <module name="ArrayTypeStyle">
                <property name="javaStyle" value="true"/>
            </module>
    
            
            <module name="FinalParameters"/>
    
            
            <module name="Indentation">
                <property name="basicOffset" value="4"/>
                <property name="braceAdjustment" value="0"/>
                <property name="caseIndent" value="4"/>
            </module>
    
    
    
            
            <module name="UncommentedMain">
                <property name="excludedClasses" value="^$"/>
            </module>
    
            
            <module name="UpperEll"/>
        </module>
    
    </module>

[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAZkZlZS1vcHM_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/c8d070892f344628a2c31e9f44c8081a.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAZkZlZS1vcHM=,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAZkZlZS1vcHM_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/764dae12a67e4a2cb13009cf16604a6d.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAZkZlZS1vcHM=,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAZkZlZS1vcHM_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/b36d5b4333a441bea3d79df0e19bd20b.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAZkZlZS1vcHM=,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAZkZlZS1vcHM_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/9831acdec9fd4399a5eb0db3030bfb9e.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAZkZlZS1vcHM=,size_20,color_FFFFFF,t_70,g_se,x_16