本文主要是介绍Intellij IDEA 使用checkstyle、pmd、findbugs检查静态代码质量,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
checkstye、pmd、findbugs的对比
在IDEA setting-plugins 下分别搜索 checkstyle、pmd、findbugs 安装,安装后要重启IDEA。
- checkstyle
如上图打开checkstyle面板。
可以自己设置检查规则,在setting-other setting-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"><!--规则版本号:V1.0(2018-05-11)本规则重在编程规范,请与PMD、FindBugs结合使用
-->
<module name="Checker"><!-- 每个java文件一个语法树 --><module name="TreeWalker"><!--Javadoc Comments2--><!--<module name="JavadocType"/><module name="JavadocMethod"><property name="scope" value="protected"/><property name="allowMissingPropertyJavadoc " value="true"/><property name="logLoadErrors" value="true"/><property name="suppressLoadErrors" value="true"/></module><module name="JavadocVariable"><property name="scope" value="public"/></module><module name="JavadocStyle"><property name="checkFirstSentence" value="false"/><property name="checkEmptyJavadoc" value="true"/><property name="checkHtml" value="false"/></module>--><!--Naming Conventions--><module name="ConstantName"><property name="format" value="(^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$)|(^log$)|(^logger$)"/></module><module name="LocalFinalVariableName"><property name="format" value="^[a-z][a-zA-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]*$"/></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-zA-Z_][a-zA-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]*$"/></module><!-- import --><!-- 避免使用* --><module name="AvoidStarImport"/><!-- 检查是否导入了多余的包 --><module name="RedundantImport"/><!-- 检查是否从非法的包中导入了类 --><module name="IllegalImport"/><!-- 没用的import检查 --><module name="UnusedImports"/><!--Size Violations--><!--<module name="LineLength"><property name="max" value="120"/></module>--><module name="AnonInnerLength"><property name="max" value="60"/></module><!--Whitespace--><module name="MethodParamPad"/><module name="NoWhitespaceAfter"/><module name="NoWhitespaceBefore"/><module name="OperatorWrap"/><module name="ParenPad"/><module name="TypecastParenPad"/><!--<module name="TabCharacter"/>--><module name="WhitespaceAround"><property name="tokens" value="COLON,NOT_EQUAL,QUESTION,DIV,DIV_ASSIGN,BXOR,BXOR_ASSIGN,MINUS,LCURLY,RCURLY,STAR,STAR_ASSIGN,TYPE_EXTENSION_AND,BAND,LAND,BAND_ASSIGN,MOD,MOD_ASSIGN,PLUS,PLUS_ASSIGN,LT,SL,SL_ASSIGN,LE,ASSIGN,MINUS_ASSIGN,EQUAL,GT,GE,SR,SR_ASSIGN,BSR,BSR_ASSIGN,BOR,BOR_ASSIGN,LOR,LITERAL_ASSERT,LITERAL_ASSERT,LITERAL_CATCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_RETURN,SLIST,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE"/></module><!--Modifiers--><module name="ModifierOrder"/><!-- Block Checks --><module name="EmptyBlock"/><module name="LeftCurly"><property name="option" value="eol"/></module><module name="NeedBraces"/><module name="RightCurly"><property name="option" value="alone"/></module><module name="AvoidNestedBlocks"><property name="allowInSwitchCase" value="true"/></module><!-- Coding --><!-- 检查局部变量或参数是否隐藏了类中的变量 --><module name="HiddenField"><property name="ignoreConstructorParameter" value="true"/><property name="ignoreSetter" value="true"/><property name="ignoreAbstractMethods" value="true"/></module><!-- 检查是否有"魔鬼"数字 --><module name="MagicNumber"><property name="tokens" value="NUM_DOUBLE, NUM_FLOAT, NUM_LONG"/><property name="ignoreNumbers" value="-1, 0, 1"/></module><!-- <module name="RedundantThrows"><property name="logLoadErrors" value="true"/><property name="suppressLoadErrors" value="true"/></module>--><module name="NestedTryDepth"><property name="max" value="2"/></module><module name="IllegalThrows"/><module name="DeclarationOrder"/><module name="UnnecessaryParentheses"/><!-- Class Design --><module name="VisibilityModifier"><property name="packageAllowed" value="true"/><property name="protectedAllowed" value="true"/></module><!--<module name="HideUtilityClassConstructor"/> --><module name="ThrowsCount"><property name="max" value="3"/></module><!-- Metrics --><module name="BooleanExpressionComplexity"><property name="max" value="5"/></module><!-- Miscellaneous --><!--<module name="Indentation"/>--><module name="UncommentedMain"/></module>
</module>
在checkstyle面板,点击检查按钮进行检查,也可以检查单个文件。
-
pmd的使用
-
findbugs的使用
这篇关于Intellij IDEA 使用checkstyle、pmd、findbugs检查静态代码质量的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!