IDEA 2019 配置与使用CheckStyle

﹏ヽ暗。殇╰゛Y 2024-04-17 05:50 68阅读 0赞

> CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要，但是枯燥的任务中解脱出来。对相关方法、注释等不规范的可以及时修改

### 在idea中集成CheckStyle ###

*  File->Setting->Plugins至下图界面，搜索CheckStyle-IDEA，点击安装。(笔者此处已安装 )  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70]

### 配置CheckStyle ###

*  第一步，使CheckStyle在idea中生效
    
     *  settings->Editor->Inspections 勾选上  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 1]
 *  第二步，添加配置文件，即为CheckStyle配置检测的规范，设定需要的代码规范
    
     *  步骤：首先在本地新建一个XML文件，将上面的代码保存到XML文件中，打开settings->CheckStyle，如下图，点击＋
     *  内容建议可以自定义做修改
    
        <?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="NewlineAtEndOfFile"/>
        
            
            <module name="Translation"/>
            
            <module name="FileLength">
                <property name="max" value="1500"/>
            </module>
        
            
            <module name="FileTabCharacter"/>
        
            
            <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">
                
                
                <module name="JavadocMethod">
                    <property name="tokens" value="METHOD_DEF" />
                </module>
                
                <module name="JavadocType"/>
                
                <module name="JavadocVariable"/>
                
                <module name="JavadocStyle">
                    <property name="checkFirstSentence" value="false"/>
                </module>
                
                <module name="TodoComment"/>
        
                
                
                <module name="LocalFinalVariableName" />
                
                <module name="LocalVariableName" />
                
                <module name="PackageName">
                    <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
                    <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
                </module>
                
                <module name="StaticVariableName" />
                
                <module name="TypeName">
                    <property name="severity" value="warning"/>
                    <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
                </module>
                
                <module name="MemberName" />
                
                <module name="MethodName" />
                
                <module name="ParameterName " />
                
                <module name="ConstantName" />
        
                
                
                <module name="ArrayTypeStyle"/>
                
                
                
                <module name="UpperEll"/>
        
        
                
                
                
                
                
                
                
                
                
                
                
                
                
        
                
                
        
        
                
                
                <module name="AvoidStarImport"/>
                
                <module name="IllegalImport"/>
                
                <module name="RedundantImport"/>
                
                <module name="UnusedImports" />
        
                
                
                <module name="LineLength">
                    <property name="max" value="150" />
                </module>
                
                <module name="MethodLength">
                    <property name="tokens" value="METHOD_DEF" />
                    <property name="max" value="150" />
                </module>
                
                <module name="ParameterNumber">
                    <property name="max" value="10" />
                    <property name="ignoreOverriddenMethods" value="true"/>
                    <property name="tokens" value="METHOD_DEF" />
                </module>
        
                
                
                <module name="MethodParamPad" />
                
                <module name="TypecastParenPad" />
                
                
                
                
                
                <module name="NoWhitespaceAfter"/>
                
                <module name="NoWhitespaceBefore"/>
                
                <module name="OperatorWrap"/>
                
                <module name="ParenPad"/>
                
                <module name="WhitespaceAfter"/>
                
                <module name="WhitespaceAround"/>
        
        
                
                
                <module name="ModifierOrder"/>
                
                <module name="RedundantModifier"/>
        
        
                
                
                <module name="AvoidNestedBlocks"/>
                
                <module name="EmptyBlock"/>
                
                <module name="LeftCurly"/>
                
                <module name="NeedBraces"/>
                
                <module name="RightCurly"/>
        
        
                
                
                
                
                <module name="EmptyStatement"/>
                
                <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="0, 1"/>
                    <property name="ignoreAnnotation" value="true"/>
                </module>
                
                <module name="MissingSwitchDefault"/>
                
                <module name="SimplifyBooleanExpression"/>
                
                <module name="SimplifyBooleanReturn"/>
        
                
                
                
                
                <module name="FinalClass"/>
                
                <module name="HideUtilityClassConstructor"/>
                
                <module name="InterfaceIsType"/>
                
                <module name="VisibilityModifier"/>
        
        
                
                
        
                
                
            </module>
        </module>

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

*  在弹出的小窗口中选择我们刚才保存到本地的配置文  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 3]  
    点击Next后点击Finsh，完成配置。
 *  CheckStyle检验的主要内容
    
     *  Javadoc注释
     *  命名约定
     *  标题
     *  Import语句
     *  体积大小
     *  空白
     *  修饰符
     *  块
     *  代码问题
     *  类设计
     *  混合检查（包括一些有用的比如非必须的System.out和printstackTrace）
 *  第三步，测试我们配置的CheckStyle是否生效
    
     *  首先，选择我们配置的规则
     *  ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 4]  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 5]
 *  在某个类里鼠标右键，对某个类执行checkstyle  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 6]
 *  执行结果：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 7]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/4cfa70d99b4c421b847381ae59002cd8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/bfffb377f6b74b2c8a599e4f2d49c736.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/748c0ef04c4f48dab6ab5bf13d98dcf0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/60f5d476f0a94dfabeaa73053c385f60.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/03dbf8a2ba184e3ca38d924aae6b308e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/5edbca26baa24cc3811bfe7fdab52389.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/8c683257a98d4baf980bcb181c333ccd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDI0ODI1_size_16_color_FFFFFF_t_70 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/b240053e1d0c414792701e2ddd7f92f6.png