Java代码质量检查工具

落日映苍穹つ 2022-05-26 13:10 497阅读 0赞

一、编码格式规范（CheckStyle）

a、安装checkstyle 的Eclipse插件  
1.下载地址：http://pan.baidu.com/s/1o6LOSwM  
2.解压net.sf.eclipsecs-updatesite\_5.6.1.201306282206-bin.zip文件，到系统路径下。如：D:\\eclipse-plugins\\cs（注：一定不用起名为checkstyle，不知道为什么此名就是安装不成功），此文件夹下有两个文件夹features、plugins。  
3.我们使用link的方式安装。在Eclipse的dropins文件夹下新建checkstyle.link文件，内容为：path=D:\\\\eclipse-plugins\\\\cs  
关闭Eclipse，重启。然后在Eclipse的window》Preferences下就可以看到checkstyle菜单，安装成功，如下图

![70][]

b、使用checkstyle

导入CheckStyle规则my\_checkStyle.xml，eclipse——Windows——preferences

![70 1][]

![70 2][]

2.右击项目，选择preferences

![70 3][]

3.右击项目选择如下选择

![70 4][]

4.经CheckStyle检查过的代码如下

![20180503090859323][]

c、相关文档  
1.源代码https://github.com/checkstyle/checkstyle

2.文档http://checkstyle.sourceforge.net

例.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">
        <property name="severity" value="warning"/>
    	
        
        <module name="FileLength">
            <property name="max" value="1500"/>
    		<message key="maxLen.file" value="文件长度不超过1500行。"/>
        </module>	
    	
        <module name="TreeWalker">
    		
    	
    	<module name="MissingDeprecated"/>
    	
    	<module name="MissingOverride"/>
    	
    	<module name="UncommentedMain"/>
    	
    	<module name="TrailingComment"/>
    		
    	
    	
            <module name="IllegalImport"/>
    		
    	
            <module name="RedundantImport"/>
    		
    	
    	<module name="UnusedImports">
    		<message key="import.unused" value="没用的import."/>
    	</module>
    		
    		
    	
            
    	
    		
    		
    	
    	
    	<module name="AbstractClassName">
    		<message key="illegal.abstract.class.name" value="抽象类名称 ''{0}'' 要匹配''{1}''的格式."/>
    	</module>
            
    	<module name="LocalFinalVariableName">
    		<message key="name.invalidPattern" value="局部final变量 ''{0}'' 要匹配''{1}''的格式（建议除首单词外的单词的首字母大写）."/>
    	</module>
    		
    	
            <module name="LocalVariableName">
    		<property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
    		<message key="name.invalidPattern" value="局部的非final型的变量 ''{0}'' 要匹配''{1}''的格式（建议除首单词外的单词的首字母大写）."/>
    	</module>
    		
    	
    	<module name="StaticVariableName">
    		<message key="name.invalidPattern" value="静态非final变量 ''{0}'' 要匹配''{1}''的格式（建议除首单词外的单词的首字母大写）."/>
    	</module>
    		
    	<module name="TypeName">
    		<property name="format" value="^[A-Z][a-zA-Z0-9_]*$"/>
    		<message key="name.invalidPattern" value="名字 ''{0}'' 要符合 ''{1}''的格式（建议每个单词的首字母大写）."/>
    	</module>
    		
    	<module name="PackageName">
    		<property name="format" value="^[a-z]+(\.[a-z_][a-z0-9_]*)*$"/>
    		<message key="name.invalidPattern" value="包名 ''{0}''要匹配 ''{1}''的格式（所有字母全部小写）."/>
    	</module>
    		
    	
    	<module name="MemberName">
    		<message key="name.invalidPattern" value="非static型变量 ''{0}'' 要匹配''{1}''的格式（建议除首单词外的单词的首字母小写）."/>
    	</module>
    		
    	<module name="ConstantName">
    		<message key="name.invalidPattern" value="常量 ''{0}'' 要匹配''{1}''的格式（字母全部大写可以包含_）."/>
    	</module>
    		
    	<module name="MethodName">
    		<property name="format" value="^[a-z][a-zA-Z]*$"/>
    		<message key="name.invalidPattern" value="方法名 ''{0}'' 必须要满足 ''{1}''的格式，建议除首单词外每个单词的首字母大写."/>
    		<message key="method.name.equals.class.name" value="方法名 ''{0}'' 不能等于类名."/>
    	</module>
    		
    	<module name="ParameterName">
    		<property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
    		<message key="name.invalidPattern" value="方法的参数名 ''{0}''要匹配''{1}''的格式，建议除首单词外的每个单词的首字母大写."/>
    	</module>
    		
    		
    	
            
    	<module name="ArrayTypeStyle">
    		<message key="array.type.style" value="数组定义要采取String [] args这种方式。"/>
    	</module>
    		
    	<module name="UpperEll">
    		<message key="upperEll" value="应该使用大写的 ''L''."/>
    	</module>
    		
    		
    	
            
    	<module name="MethodLength">
    		<property name="max" value="150"/>
    		<message key="maxLen.method" value="方法大小不可以超过150行。"/>
    	</module>
    		
    	<module name="LineLength">
    		<property name="max" value="140" />
    		<message key="maxLineLen" value="每一行的最大长度为140个字符。"/>
    	</module>
    		
    	
            <module name="ParameterNumber">
                <property name="max" value="5" />
                <property name="tokens" value="METHOD_DEF" />
    		<message key="maxParam" value="方法参数个数不能超过5个。"/>
            </module>
    		
    		
    	
    	<module name="GenericWhitespace"/>
    	
    	<module name="MethodParamPad">
    		<property name="tokens" value="CTOR_DEF,METHOD_CALL,METHOD_DEF,SUPER_CTOR_CALL"/>
    		<message key="ws.notPreceded" value="''{0}'' 前面保留一个空格"/>
    		<message key="line.previous" value="''{0}'' 必须在前一行"/>
    		<message key="ws.preceded" value="''{0}'' 前面有一个空格"/>
    	</module>
    	
    	<module name="TypecastParenPad">
    		<property name="tokens" value="RPAREN,TYPECAST"/>
    		<message key="ws.followed" value="''{0}''后面有一个空格，请删除."/>
    		<message key="ws.preceded" value="''{0}''前面有一个空格，请删除."/>
    	</module>
    	
            <module name="NoWhitespaceAfter">
    		<message key="ws.followed" value="在某个特定关键字之后应保留空格."/>
    	</module>
    	
            <module name="NoWhitespaceBefore">
    		<message key="ws.preceded" value="在某个特定关键字之前应保留空格."/>
    	</module>
    	
            <module name="OperatorWrap">
    		<property name="option" value="nl"/>
    		<message key="line.new" value="操作符换行策略检查."/>
    	</module>
    	
            <module name="ParenPad"/>
    	
            <module name="WhitespaceAfter">
    		<message key="ws.notFollowed" value="分隔符在空白之后."/>
    		<message key="ws.typeCast" value="分隔符在空白之后."/>
    	</module>
    	
            <module name="WhitespaceAround">
    		<message key="ws.notPreceded" value="分隔符周围需要有空白."/>
    		<message key="ws.notFollowed" value="分隔符周围需要有空白."/>
    	</module>
    		
    	
            
            <module name="ModifierOrder"/>
    		
            
            <module name="RedundantModifier"/>
    		
    		
    	
    	
    	<module name="AvoidNestedBlocks">
    		
    		<message key="block.nested" value="语句中有嵌套的代码块"/>
    	</module>
    		
    	
    	<module name="EmptyBlock">
    		<message key="block.empty" value="{0}空的代码块."/>
    		<message key="block.noStmt" value="至少有一条代码语句."/>
    	</module>
    		
    	
            <module name="LeftCurly"/>
    		
    	
    	<module name="NeedBraces">
    		<message key="needBraces" value="代码中缺失大括号"/>
    	</module>
    		
    	
            <module name="RightCurly"/>
    		
    		
    	
    	
    	<module name="EmptyStatement">
    		<message key="empty.statement" value="；前面缺失语句"/>
    	</module>
    		
    	
            <module name="EqualsHashCode"/>
    		
    	
            <module name="HiddenField">
                <property name="tokens" value="VARIABLE_DEF"/>
            </module>
    		
    	
            <module name="InnerAssignment"/>
    		
    	
            <module name="MissingSwitchDefault"/>
    		
    	
            <module name="SimplifyBooleanExpression"/>
    		
            
            <module name="SimplifyBooleanReturn"/>
    		
    		
    	
    	
            
            <module name="FinalClass"/>
    		
    	
            <module name="InterfaceIsType"/>
    		
    	
            <module name="VisibilityModifier">
                <property name="packageAllowed" value="true"/>
                <property name="protectedAllowed" value="true"/>
            </module>
    		
    		
    	
    
    	<module name="RedundantThrows">
    		<property name="suppressLoadErrors" value="true"/>
    		<message key="redundant.throws.subclass" value="Redundant throws: ''{0}'' 是''{1}''的异常子类."/>
    		<message key="redundant.throws.classInfo" value="无法从 {0}获取类信息."/>
    		<message key="redundant.throws.duplicate" value="Redundant throws: ''{0}'' 重复抛出异常."/>
    		<message key="redundant.throws.unchecked" value="Redundant throws: ''{0}'' 没有检查异常."/>
    	</module>
    	
    	<module name="StringLiteralEquality" > 
    		<message key="string.literal.equality" value="String的比较不能用!= 和 ==."/>
    	</module>
    	  
    	<module name="NestedIfDepth">   
    		<property name="max" value="3" />   
    		<message key="nested.if.depth" value="if最多嵌套3层"/>
    	</module>
    		   
            <module name="NestedTryDepth">   
                    <property name="max" value="3" /> 
    		<message key="nested.if.depth" value="try最多被嵌套3层"/>
            </module> 
    	
            
               
    	<module name="SuperClone" />
    	   
            <module name="SuperFinalize" /> 
    
    	   
    	<module name="PackageDeclaration" /> 
               
    	<module name="ReturnCount">   
            <property name="max" value="2" /> 
    		<message key="return.count" value="一个方法中最多有2个return"/>
            </module> 
    	
    	
    	
    	<module name="MultipleVariableDeclarations">
    		<message key="multiple.variable.declarations.comma" value="每一行申请一个变量"/>
    		<message key="multiple.variable.declarations" value="每一行允许定义一个变量"/>
    	</module>
    	
    	<module name="UnnecessaryParentheses">
    		<message key="unnecessary.paren.assign" value="任务的右边含有不必要的圆括号"/>
    		<message key="unnecessary.paren.string" value="字符串 {0}含有不必要的圆括号."/>
    		<message key="unnecessary.paren.literal" value="''{0}''含有不必要的圆括号."/>
    		<message key="unnecessary.paren.ident" value="标识符''{0}''含有不必要的圆括号."/>
    		<message key="unnecessary.paren.return" value="return 值里含有不必要的圆括号"/>
    		<message key="unnecessary.paren.expr" value="表达式里含有不必要的圆括号"/>
    		<message key="unnecessary.paren.lambda" value="含有不必要的圆括号"/>
    	</module>
    		
    	<module name="Regexp">
                <property name="format" value="System\.out\.println"/>
                <property name="illegalPattern" value="true"/>
            </module>
    		
    	
    		
    	<module name="BooleanExpressionComplexity">
    		<property name="severity" value="warning"/>
    	</module>
    		
    	<module name="InnerTypeLast">
    		<property name="severity" value="warning"/>
    		<message key="arrangement.members.before.inner" value="最后声明内部类型"/>
    	</module>
    	
    	<module name="DefaultComesLast"/>
    	
    	<module name="EmptyStatement"/>
    	
    	<module name="EqualsAvoidNull"/>
    	
    	<module name="EqualsHashCode"/>
    	
    	<module name="ExplicitInitialization"/>
    	
    	
    	
            <module name="IllegalInstantiation"/>
    	
    	
            <module name="MagicNumber">
                <property name="ignoreNumbers" value="0, 1"/>
                <property name="ignoreAnnotation" value="true"/>
    	    <message key="magic.number" value="有魔术数字"/>
    	</module>
    	
    	<module name="MissingSwitchDefault"/>
    	
    	<module name="ModifiedControlVariable"/>
    	
    	
    	
    	<module name="ParameterAssignment"/>
    	
    	
    	
    	<module name="SimplifyBooleanExpression"/>
    	
    	<module name="SimplifyBooleanReturn"/>
    	
    	<module name="OneStatementPerLine"/>
    		
    	
            <module name="AvoidStarImport">
                <property name="excludes" value="java.io,java.net,java.lang.Math"/>
                
                <property name="allowClassImports" value="false"/>
                
                <property name="allowStaticMemberImports" value="true"/>
                </module>
    		
                <module name="OuterTypeNumber">
    		<property name="max" value="2"/>
    	    </module>
    	</module>
    </module>

二、代码重复检查（PMD）

a、安装PMD 的Eclipse插件  
1.下载地址：http://jingyan.baidu.com/article/19192ad835de6ee53e57073c.html  
2.解压net.sourceforge.pmd.eclipse-3.2.6.v200903300643.zip文件，到系统路径下。如：D:\\eclipse-plugins\\pmd，此文件夹下有两个文件夹features、plugins。  
3. 我们使用link的方式安装。在Eclipse的dropins文件夹下新建pmd.link文件，内容为：path=D:\\\\eclipse-plugins\\\\pmd  
4.关闭Eclipse，重启。然后在Eclipse的window》Preferences下就可以看到PMD菜单，安装成功，如下图

![70 5][]

b、使用PMD

1.右击项目，选择如下选项

![70 6][]

![70 7][]

2.下面是PCD生成的重复代码，可以对其中的代码进行分析，修改

![20180503092745448][]

三、依赖项分析（jdepend）

a、安装jdepend 的Eclipse插件

1.下载地址：http://andrei.gmxhome.de/jdepend4eclipse/links.html

![70 8][]

2.拷贝de.loskutov.eclipse.jdepend\_1.2.4.201406241900.jar文件，到Eclipse的dropins目录下。

3. 关闭Eclipse，重启。通过右键单击源文件夹并选择 Run JDepend Analysis。一定要选择一个含源代码的源文件夹；否则看不到此菜单项。

![70 9][]

b、使用PMD

1.右键单击源文件夹并选择 Run JDepend Analysis

![70 10][]

2.下面对jdepend的分析的结果简单介绍：  
A.Selected objects()：选择分析的包  
B.Package：包全路径  
C.CC(concr.cl.)：当前行对应包的具体类的数量。  
D.AC(abstr.cl.)：当前行对应包的抽象类和接口的数量。  
E.Ca(aff.)：依赖于被分析package的其他package的数量，用于衡量pacakge的职责。即有多少包调用了它。（AfferentCouplings）  
F.Ce(eff.)：被分析package的类所依赖的其他package的数量，用于衡量package的独立性。即它调用了多少其他包。（EfferentCouplings）  
G.A：被分析package中的抽象类和接口与所在package所有类数量的比例，取值范围为0－1。（Abstractness ）  
H.I：I=Ce/（Ce＋Ca），用于衡量package的不稳定性，取值范围为0－1。I＝0表示最稳定，I＝1表示最不稳定。即如果这个类不调用任何其他包，则它是最稳定的。（Instability ）  
I.D：分析package和理想曲线A＋I＝1的垂直距离，用于衡量package在稳定性和抽象性之间的平衡。（Distance）  
理想的package要么完全是抽象类和稳定（x＝0，y＝1），要么完全是具体类和不稳定（x＝1，y＝0）。取值范围为0－1，  
D＝0表示完全符合理想标准，  
D＝1表示package最大程度地偏离了理想标准。即你的包要么全是接口，不调用任何其他包（完全是抽象类和稳定），要么是具体类，不被任何其他包调用。  
J.Cycle!：循环依赖  
K.Package with cycle：包与包直接有循环调用  
L.Depends upon-efferentdependencies:依赖的包  
M.Used by-afferentdependencies:被引用的包

如果三个包中的类有传递依赖，Cycle!列中会出现感叹号警告。把其中的某个或者某些类再单独抽出新包，解决此问题。

四、代码覆盖率Coverlipse

a、安装coverlipse 的Eclipse插件  
1.下载地址：https://sourceforge.net/projects/coverlipse/files/Coverlipse/

2.下载下图中5个文件

![70 11][]

3.解压coverlipse-0.9.6.zip文件，到系统路径下。如：D:\\eclipse-plugins\\ 。  
4. 我们使用link的方式安装。在Eclipse的dropins文件夹下新建coverlipse.link文件，内容为：path=D:\\\\eclipse-plugins\\\\coverlipse

5.关闭Eclipse，重启。然后在Eclipse的window》Preferences下就可以看到PMD菜单，安装成功，如下图（需要junit测试）

![70 12][]

![70 13][]

b、使用PMD

1.右击项目，选择如下选项

![70 14][]

![70 15][]

2.可以对PCD生成的重复代码进行分析，修改

五、findbugs

1.下载地址：

http://downloads.sourceforge.net/project/findbugs/findbugs%20eclipse%20plugin/1.3.9/edu.umd.cs.findbugs.plugin.eclipse\_1.3.9.20090821.zip?use\_mirror=ncu

2.把下载的压缩包解压后，将其copy到eclipse的plugin目录中去。

[70]: /images/20220526/04908351010845f881c879e82e03257c.png
[70 1]: /images/20220526/a10b1211d1c5464f9c392d83e407af63.png
[70 2]: /images/20220526/a2469e2dadb54f389befa9a98152fb8d.png
[70 3]: /images/20220526/5faafbc1977945a9bde3c624079c13e5.png
[70 4]: /images/20220526/3d8269864e194425b49650ca9496d1da.png
[20180503090859323]: /images/20220526/78df67b6da1649d9b38283fb734ee4a8.png
[70 5]: /images/20220526/7c7e5999ec764cf68baa5124ac230592.png
[70 6]: /images/20220526/d93e4db8f5de41a6be0f855b6d48ac15.png
[70 7]: /images/20220526/9b36ac2e2d874be39d74746e129f1254.png
[20180503092745448]: /images/20220526/54f37f7afe6445818d547e7f13814727.png
[70 8]: /images/20220526/81ef0ca7ce5d40f9ae5c993c6316c87d.png
[70 9]: /images/20220526/1693f779937c44e29f11d3be91f195fc.png
[70 10]: /images/20220526/e235c37f94d54270b7d9c8a096093509.png
[70 11]: /images/20220526/aae49c843df1476b944be29a2f007a7c.png
[70 12]: /images/20220526/83d9585a714e44d8a2ea3d4d04146d25.png
[70 13]: /images/20220526/ddb83bca065741d19a8c152b46d34be6.png
[70 14]: /images/20220526/4371af8d41bc4489b5749a29510e2b7c.png
[70 15]: /images/20220526/4d9f54b07a164b5ca409e444bfe5caf3.png