checkstyle教程：idea和eclipse集成checkstyle插件及导入规则配置文件

亦凉 2023-10-15 21:43 24阅读 0赞

## idea ##

### 安装插件 ###

打开IDEA菜单栏的Settings中的plugins，搜索`CheckStyle-IDEA`并安装:

![在这里插入图片描述][b7fa8e49b0524ed3b67021e545ae3c13.png]  
安装完成后restart：  
![在这里插入图片描述][413df434de9041d88a16412d62dec6da.png]  
安装重启IDEA之后，Settings下搜索Inspections,再查询CheckStyle，如果能查询到内容，说明安装成功：  
![在这里插入图片描述][d8897ef08eb844b7ae6486bd1f4c515b.png]

### 导入CheckStyle配置 ###

#### 配置文件示例 ####

首先在本地新建checkstyle.xml文件，里面的内容如下：

<?xml version="1.0" encoding="UTF-8"?>
    <!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="FileLength">
            <property name="max" value="1500"/>
        </module>
        
        <module name="LineLength">
            <property name="max" value="150"/>
        </module>
    
        <module name="TreeWalker">
            
    
            
    
            
            
            <module name="JavadocStyle">
                
                <property name='checkFirstSentence' value='false'/>
                <property name='checkEmptyJavadoc' value='true'/>
            </module>
            
            <module name="JavadocType">
                
                <property name='allowUnknownTags' value='true'/>
            </module>
            
            <module name='MissingJavadocMethod'>
                <property name="allowMissingPropertyJavadoc" value="true"/>
                <property name="allowedAnnotations" value="Override,Deprecated,ApiOperation"/>
                <property name="ignoreMethodNamesRegex" value="main"/>
            </module>
            <module name="JavadocMethod"/>
            
            <module name="JavadocVariable">
                
                <property name='ignoreNamePattern' value='.*Business|.*Service|.*Handler|.*Mapper|.*Template|.*Client|.*Util.*|LOG|LOGGER'/>
            </module>
    
            
            
            <module name="AvoidStarImport"/>
            
            <module name="IllegalImport"/>
            
            <module name="RedundantImport"/>
            
            <module name="UnusedImports"/>
    
            
            
            <module name="PackageName">
                <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
                <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
            </module>
            
            <module name="TypeName">
                <property name="severity" value="warning"/>
                <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
            </module>
            
            <module name="MethodName"/>
            
            <module name="ParameterName "/>
            
            <module name="MemberName"/>
            
            <module name="ConstantName"/>
            
            <module name="LocalFinalVariableName"/>
            
            <module name="LocalVariableName"/>
            
            <module name="StaticVariableName"/>
    
            
            <module name="ParameterNumber">
                <property name="tokens" value="METHOD_DEF"/>
                <property name="ignoreOverriddenMethods" value="true"/>
                <property name="max" value="5"/>
            </module>
    
            
            
            
            <module name="MethodLength">
                <property name="tokens" value="METHOD_DEF"/>
                <property name="max" value="300"/>
            </module>
            
            
            
            <module name="MethodParamPad"/>
    
            
            <module name="ParenPad"/>
    
            
            <module name="TypecastParenPad"/>
    
            
            
            <module name="NoWhitespaceAfter"/>
            
            <module name="NoWhitespaceBefore"/>
            
            <module name="OperatorWrap"/>
            
            <module name="WhitespaceAfter"/>
            
            <module name="WhitespaceAround"/>
    
    
            
            
            <module name="ModifierOrder"/>
            
            <module name="RedundantModifier"/>
    
    
            
            
            <module name="EmptyBlock"/>
            
            <module name="NeedBraces"/>
            
            <module name="AvoidNestedBlocks">
                <property name="allowInSwitchCase" value="true"/>
            </module>
            
            <module name="LeftCurly"/>
            
            <module name="RightCurly"/>
    
            
            
            <module name="EmptyStatement"/>
            
            
            <module name="EqualsHashCode"/>
            
            
            <module name="MissingSwitchDefault"/>
            
            <module name="HiddenField">
                <property name="tokens" value="VARIABLE_DEF"/>
            </module>
            
            <module name="InnerAssignment"/>
            
            
            <module name="ModifiedControlVariable"/>
            
            
            <module name="SimplifyBooleanExpression"/>
            
            <module name="SimplifyBooleanReturn"/>
            
            <module name="StringLiteralEquality"/>
            
            <module name="NestedForDepth">
                <property name="max" value="4"/>
            </module>
            
            <module name="NestedIfDepth">
                <property name="max" value="5"/>
            </module>
            
            <module name="NestedTryDepth">
                <property name="max" value="5"/>
            </module>
            
            <module name="OverloadMethodsDeclarationOrder"/>
            
            <module name="SuperClone"/>
            
            <module name="SuperFinalize"/>
            
            
            <module name="PackageDeclaration"/>
            
            <module name="ReturnCount">
                <property name="max" value="10"/>
                <property name="maxForVoid" value="10"/>
            </module>
            
            <module name="ExplicitInitialization"/>
            
            
            <module name="MultipleVariableDeclarations"/>
            
            <module name="UnnecessaryParentheses"/>
            
            <module name="BooleanExpressionComplexity">
                <property name="max" value="8"/>
            </module>
            
            <module name="ClassDataAbstractionCoupling">
                <property name="max" value="50"/>
            </module>
            
            
    
            
            
            <module name="FinalClass"/>
            
            
            <module name="VisibilityModifier">
                <property name="packageAllowed" value="true"/>
                <property name="protectedAllowed" value="true"/>
            </module>
    
            
            <module name="Regexp">
                <property name="format" value=".printStackTrace"/>
                <property name="illegalPattern" value="true"/>
            </module>
            <module name="Regexp">
                <property name="format" value="System.out.println"/>
                <property name="illegalPattern" value="true"/>
            </module>
    
            
            
            <module name="UpperEll"/>
            
            <module name="ArrayTypeStyle"/>
            
            
            
            <module name="UncommentedMain">
                <property name="excludedClasses" value=".*[Application,Test]$"/>
            </module>
            
            <module name="UpperEll"/>
        </module>
    </module>

### idea中导入配置文件 ###

在Settings中搜索CheckStyle，按下图导入上一步骤新建的checkstyle.xml文件:  
![在这里插入图片描述][c71b9bd4e49046c3b37fddec94429feb.png]  
![在这里插入图片描述][ebdd164c0628406d867ab34fc0e13798.png]  
勾选新增的配置文件，完成：  
![在这里插入图片描述][c7a05c39ece7475c8395844e97218c67.png]

![在这里插入图片描述][6dbe0d00327349509467de72a4b248dc.png]

### 使用 ###

直接打开要检查的文件，`Rules`处选择上面配置的规则名称，然后直接点击下图的启动图标即可:  
![在这里插入图片描述][43fcc870c4bd47cf83d44af0330464ae.png]  
![在这里插入图片描述][53054ffb92844567861432ae5832ed73.png]  
![在这里插入图片描述][7a79959032744511b2a03455d27cfa2f.png]

如果想扫描整个包或整个项目，可以点击下图两个按钮，有提示：

*  检查整个工程：

![在这里插入图片描述][532281ccdb0342118ce99fcbe441fd0b.png]

*  检查module：

![在这里插入图片描述][9411b5847797412b8be5f62c32e303e9.png]

## eclipse ##

### 安装插件 ###

![在这里插入图片描述][3263e7208f0c41b58c2dae1a71df132b.png]  
![在这里插入图片描述][90550d814d43438e9439d56c2d7381fc.png]

### 导入配置 ###

![在这里插入图片描述][798eb133038d408e9d3bc6832fd49ebe.png]

![在这里插入图片描述][a2f6a0537cec4a809f9a3d2cf473dc08.png]

![在这里插入图片描述][3d7e3c18f7f0482f8a7dcd45f32151eb.png]  
设为默认的检查规则：  
![在这里插入图片描述][c5c6139578a540c4962d79f1a9f7fa04.png]

### 使用 ###

右击项目或文件，选择`checkstyle -- check code with checkstyle`  
单个文件的行号处会给出优化提示：  
![在这里插入图片描述][297a02a685404d84b087e29c60345bcd.png]  
如下为扫描整个工程后给出的优化提示：  
![在这里插入图片描述][2d97ee9ce86c4ca980e9c2ed799bb647.png]

[b7fa8e49b0524ed3b67021e545ae3c13.png]: https://img-blog.csdnimg.cn/b7fa8e49b0524ed3b67021e545ae3c13.png
[413df434de9041d88a16412d62dec6da.png]: https://img-blog.csdnimg.cn/413df434de9041d88a16412d62dec6da.png
[d8897ef08eb844b7ae6486bd1f4c515b.png]: https://img-blog.csdnimg.cn/d8897ef08eb844b7ae6486bd1f4c515b.png
[c71b9bd4e49046c3b37fddec94429feb.png]: https://img-blog.csdnimg.cn/c71b9bd4e49046c3b37fddec94429feb.png
[ebdd164c0628406d867ab34fc0e13798.png]: https://img-blog.csdnimg.cn/ebdd164c0628406d867ab34fc0e13798.png
[c7a05c39ece7475c8395844e97218c67.png]: https://img-blog.csdnimg.cn/c7a05c39ece7475c8395844e97218c67.png
[6dbe0d00327349509467de72a4b248dc.png]: https://img-blog.csdnimg.cn/6dbe0d00327349509467de72a4b248dc.png
[43fcc870c4bd47cf83d44af0330464ae.png]: https://img-blog.csdnimg.cn/43fcc870c4bd47cf83d44af0330464ae.png
[53054ffb92844567861432ae5832ed73.png]: https://img-blog.csdnimg.cn/53054ffb92844567861432ae5832ed73.png
[7a79959032744511b2a03455d27cfa2f.png]: https://img-blog.csdnimg.cn/7a79959032744511b2a03455d27cfa2f.png
[532281ccdb0342118ce99fcbe441fd0b.png]: https://img-blog.csdnimg.cn/532281ccdb0342118ce99fcbe441fd0b.png
[9411b5847797412b8be5f62c32e303e9.png]: https://img-blog.csdnimg.cn/9411b5847797412b8be5f62c32e303e9.png
[3263e7208f0c41b58c2dae1a71df132b.png]: https://img-blog.csdnimg.cn/3263e7208f0c41b58c2dae1a71df132b.png
[90550d814d43438e9439d56c2d7381fc.png]: https://img-blog.csdnimg.cn/90550d814d43438e9439d56c2d7381fc.png
[798eb133038d408e9d3bc6832fd49ebe.png]: https://img-blog.csdnimg.cn/798eb133038d408e9d3bc6832fd49ebe.png
[a2f6a0537cec4a809f9a3d2cf473dc08.png]: https://img-blog.csdnimg.cn/a2f6a0537cec4a809f9a3d2cf473dc08.png
[3d7e3c18f7f0482f8a7dcd45f32151eb.png]: https://img-blog.csdnimg.cn/3d7e3c18f7f0482f8a7dcd45f32151eb.png
[c5c6139578a540c4962d79f1a9f7fa04.png]: https://img-blog.csdnimg.cn/c5c6139578a540c4962d79f1a9f7fa04.png
[297a02a685404d84b087e29c60345bcd.png]: https://img-blog.csdnimg.cn/297a02a685404d84b087e29c60345bcd.png
[2d97ee9ce86c4ca980e9c2ed799bb647.png]: https://img-blog.csdnimg.cn/2d97ee9ce86c4ca980e9c2ed799bb647.png