最新公告
  • 新注册用户请前往个人中心绑定邮箱以便接收相关凭证邮件!!!点击前往个人中心
  • idea使用CheckStyle来检查你的代码规范

    CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。
    idea版(版本:2018.2)
    在idea中集成CheckStyle
    File->Setting->Plugins至下图界面,搜索CheckStyle-IDEA,点击安装。
    在idea中使用CheckStyle
    第一步,使CheckStyle在idea中生效
    settings->Editor->Inspections
    第二步,添加配置文件,即为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”>

    <modulename=“Checker”>
       <!–
           If you set the basedir property below, then all reported file
           names will be relative to the specified directory. See
    http://checkstyle.sourceforge.net/5.x/config.html#Checker
           <property name=”basedir” value=”${basedir}”/>
       –>
       <!– 检查每个包中是否有java注释文件,默认有package-info.java –>
       <!– <module name=”JavadocPackage”/> –>
       <!– 检查文件是否以一个空行结束 –>
       <modulename=“NewlineAtEndOfFile”/>

       <!– 检查property文件中是否有相同的key –>
       <modulename=“Translation”/>
       <!– 文件长度不超过1500行 –>
       <modulename=“FileLength”>
           <propertyname=“max”value=“1500”/>
       </module>

       <!– 检查文件中是否含有’t’ –>
       <modulename=“FileTabCharacter”/>

       <!– Miscellaneous other checks. –>
       <modulename=“RegexpSingleline”>
           <propertyname=“format”value=“s+$”/>
           <propertyname=“minimum”value=“0”/>
           <propertyname=“maximum”value=“0”/>
           <propertyname=“message”value=“Line has trailing spaces.”/>
       </module>

       <!– 每个java文件一个语法树 –>
       <modulename=“TreeWalker”>
           <!– 注释检查 –>
           <!– 检查方法和构造函数的javadoc –>
           <modulename=“JavadocMethod”>
               <propertyname=“tokens”value=“METHOD_DEF” />
           </module>
           <!– 检查类和接口的javadoc。默认不检查author和version tags –>
           <modulename=“JavadocType”/>
           <!– 检查变量的javadoc –>
           <modulename=“JavadocVariable”/>
           <!– 检查javadoc的格式 –>
           <modulename=“JavadocStyle”>
               <propertyname=“checkFirstSentence”value=“false”/>
           </module>
           <!– 检查TODO:注释 –>
           <modulename=“TodoComment”/>

           <!– 命名检查 –>
           <!– 局部的final变量,包括catch中的参数的检查 –>
           <modulename=“LocalFinalVariableName” />
           <!– 局部的非final型的变量,包括catch中的参数的检查 –>
           <modulename=“LocalVariableName” />
           <!– 包名的检查(只允许小写字母),默认^[a-z]+(.[a-zA-Z_][a-zA-Z_0-9_]*)*$ –>
           <modulename=“PackageName”>
               <propertyname=“format”value=“^[a-z]+(.[a-z][a-z0-9]*)*$” />
               <messagekey=“name.invalidPattern”value=“包名 ”{0}” 要符合 ”{1}”格式.”/>
           </module>
           <!– 仅仅是static型的变量(不包括static final型)的检查 –>
           <modulename=“StaticVariableName” />
           <!– Class或Interface名检查,默认^[A-Z][a-zA-Z0-9]*$–>
           <modulename=“TypeName”>
               <propertyname=“severity”value=“warning”/>
               <messagekey=“name.invalidPattern”value=“名称 ”{0}” 要符合 ”{1}”格式.”/>
           </module>
           <!– 非static型变量的检查 –>
           <modulename=“MemberName” />
           <!– 方法名的检查 –>
           <modulename=“MethodName” />
           <!– 方法的参数名 –>
           <modulename=“ParameterName “ />
           <!– 常量名的检查(只允许大写),默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ –>
           <modulename=“ConstantName” />

           <!– 定义检查 –>
           <!– 检查数组类型定义的样式 –>
           <modulename=“ArrayTypeStyle”/>
           <!– 检查方法名、构造函数、catch块的参数是否是final的 –>
           <!– <module name=”FinalParameters”/> –>
           <!– 检查long型定义是否有大写的“L” –>
           <modulename=“UpperEll”/>


           <!– Checks for Headers                                –>
           <!– See http://checkstyle.sf.net/config_header.html   –>
           <!– <module name=”Header”>                            –>
           <!– The follow property value demonstrates the ability     –>
           <!– to have access to ANT properties. In this case it uses –>
           <!– the ${basedir} property to allow Checkstyle to be run  –>
           <!– from any directory within a project. See property      –>
           <!– expansion,                                             –>
           <!– http://checkstyle.sf.net/config.html#properties        –>
           <!– <property                                              –>
           <!–     name=”headerFile”                                  –>
           <!–     value=”${basedir}/java.header”/>                   –>
           <!– </module> –>

           <!– Following interprets the header file as regular expressions. –>
           <!– <module name=”RegexpHeader”/>                                –>


           <!– import检查–>
           <!– 避免使用* –>
           <modulename=“AvoidStarImport”/>
           <!– 检查是否从非法的包中导入了类 –>
           <modulename=“IllegalImport”/>
           <!– 检查是否导入了多余的包 –>
           <modulename=“RedundantImport”/>
           <!– 没用的import检查,比如:1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 –>
           <modulename=“UnusedImports” />

           <!– 长度检查 –>
           <!– 每行不超过150个字符 –>
           <modulename=“LineLength”>
               <propertyname=“max”value=“150” />
           </module>
           <!– 方法不超过150行 –>
           <modulename=“MethodLength”>
               <propertyname=“tokens”value=“METHOD_DEF” />
               <propertyname=“max”value=“150” />
           </module>
           <!– 方法的参数个数不超过5个。 并且不对构造方法进行检查–>
           <modulename=“ParameterNumber”>
               <propertyname=“max”value=“10” />
               <propertyname=“ignoreOverriddenMethods”value=“true”/>
               <propertyname=“tokens”value=“METHOD_DEF” />
           </module>

           <!– 空格检查–>
           <!– 方法名后跟左圆括号”(” –>
           <modulename=“MethodParamPad” />
           <!– 在类型转换时,不允许左圆括号右边有空格,也不允许与右圆括号左边有空格 –>
           <modulename=“TypecastParenPad” />
           <!– Iterator –>
           <!– <module name=”EmptyForIteratorPad”/> –>
           <!– 检查尖括号 –>
           <!– <module name=”GenericWhitespace”/> –>
           <!– 检查在某个特定关键字之后应保留空格 –>
           <modulename=“NoWhitespaceAfter”/>
           <!– 检查在某个特定关键字之前应保留空格 –>
           <modulename=“NoWhitespaceBefore”/>
           <!– 操作符换行策略检查 –>
           <modulename=“OperatorWrap”/>
           <!– 圆括号空白 –>
           <modulename=“ParenPad”/>
           <!– 检查分隔符是否在空白之后 –>
           <modulename=“WhitespaceAfter”/>
           <!– 检查分隔符周围是否有空白 –>
           <modulename=“WhitespaceAround”/>


           <!– 修饰符检查 –>
           <!– 检查修饰符的顺序是否遵照java语言规范,默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp –>
           <modulename=“ModifierOrder”/>
           <!– 检查接口和annotation中是否有多余修饰符,如接口方法不必使用public –>
           <modulename=“RedundantModifier”/>


           <!– 代码块检查 –>
           <!– 检查是否有嵌套代码块 –>
           <modulename=“AvoidNestedBlocks”/>
           <!– 检查是否有空代码块 –>
           <modulename=“EmptyBlock”/>
           <!– 检查左大括号位置 –>
           <modulename=“LeftCurly”/>
           <!– 检查代码块是否缺失{} –>
           <modulename=“NeedBraces”/>
           <!– 检查右大括号位置 –>
           <modulename=“RightCurly”/>


           <!– 代码检查 –>
           <!– 检查是否在同一行初始化 –>
           <!– <module name=”AvoidInlineConditionals”/> –>
           <!– 检查空的代码段 –>
           <modulename=“EmptyStatement”/>
           <!– 检查在重写了equals方法后是否重写了hashCode方法 –>
           <modulename=“EqualsHashCode”/>
           <!– 检查局部变量或参数是否隐藏了类中的变量 –>
           <modulename=“HiddenField”>
               <propertyname=“tokens”value=“VARIABLE_DEF”/>
           </module>
           <!– 检查是否使用工厂方法实例化 –>
           <modulename=“IllegalInstantiation”/>
           <!– 检查子表达式中是否有赋值操作 –>
           <modulename=“InnerAssignment”/>
           <!– 检查是否有”魔术”数字 –>
           <modulename=“MagicNumber”>
               <propertyname=“ignoreNumbers”value=“0, 1”/>
               <propertyname=“ignoreAnnotation”value=“true”/>
           </module>
           <!– 检查switch语句是否有default –>
           <modulename=“MissingSwitchDefault”/>
           <!– 检查是否有过度复杂的布尔表达式 –>
           <modulename=“SimplifyBooleanExpression”/>
           <!– 检查是否有过于复杂的布尔返回代码段 –>
           <modulename=“SimplifyBooleanReturn”/>

           <!– 类设计检查 –>
           <!– 检查类是否为扩展设计l –>
           <!– <module name=”DesignForExtension”/> –>
           <!– 检查只有private构造函数的类是否声明为final –>
           <modulename=“FinalClass”/>
           <!– 检查工具类是否有putblic的构造器 –>
           <modulename=“HideUtilityClassConstructor”/>
           <!– 检查接口是否仅定义类型 –>
           <modulename=“InterfaceIsType”/>
           <!– 检查类成员的可见度 –>
           <modulename=“VisibilityModifier”/>


           <!– 其他检查 –>
           <!– 文件中使用了System.out.print等
           <module name=”GenericIllegalRegexp”>
               <property name=”format” value=”System.out.print”/>
           </module>
           <module name=”GenericIllegalRegexp”>
               <property name=”format” value=”System.exit”/>
           </module>
           <module name=”GenericIllegalRegexp”>
               <property name=”format” value=”printStackTrace”/>
           </module>–>

           <!– 代码质量 –>
           <!– 圈复杂度
           <module name=”CyclomaticComplexity”>
                 <property name=”max” value=”2″/>
           </module> –>
       </module>
    </module>

    步骤:首先在本地新建一个XML文件,将上面的代码保存到XML文件中,打开
    settings->CheckStyle,如下图,点击+
    在弹出的小窗口中选择我们刚才保存到本地的配置文件
    点击Next后点击Finsh,完成配置。
    • Javadoc注释
    • 命名约定
    • 标题
    • Import语句
    • 体积大小
    • 空白
    • 修饰符
    • 代码问题
    • 类设计
    • 混合检查(包括一些有用的比如非必须的System.out和printstackTrace)

    第三步,测试我们配置的CheckStyle是否生效
    首先,选择我们配置的规则
    然后创建一段不怎么符合规范的代码
    publicclassTestCheck {
       publicvoidMytest(){
           System.out.println(“这是一个不符合命名规范的方法”);
       }
    }

    然后右击选择Check Current File
    点击之后,我们可以看到,CheckStyle帮我们指出了代码中的不规范

    本站所有文章均由网友分享,仅用于参考学习用,请勿直接转载,如有侵权,请联系网站客服删除相关文章。若由于商用引起版权纠纷,一切责任均由使用者承担
    极客文库 » idea使用CheckStyle来检查你的代码规范

    常见问题FAQ

    如果资源链接失效了怎么办?
    本站用户分享的所有资源都有自动备份机制,如果资源链接失效,请联系本站客服QQ:2580505920更新资源地址。
    如果用户分享的资源与描述不符怎么办?
    可以联系客服QQ:2580505920,如果要求合理可以安排退款或者退赞助积分。
    如何分享个人资源获取赞助积分或其他奖励?
    本站用户可以分享自己的资源,但是必须保证资源没有侵权行为。点击个人中心,根据操作填写并上传即可。资源所获收益完全归属上传者,每周可申请提现一次。
    如果您发现了本资源有侵权行为怎么办?
    及时联系客服QQ:2580505920,核实予以删除。

    参与讨论

    • 159会员总数(位)
    • 3736资源总数(个)
    • 1本周发布(个)
    • 0 今日发布(个)
    • 405稳定运行(天)

    欢迎加入「极客文库」,成为原创作者从这里开始!

    立即加入 了解更多
    成为赞助用户享有更多特权立即升级