checkstyle自定义规则

参考官网教程：http://checkstyle.sourceforge.net/config_blocks.html；

checkstyle是一个开发工具，帮助我们检查代码大部分不规范地方，提高检查效率，也节约大量人工审查成本，也可以支持开发自定义规则，适应项目的风格。

兼容ide插件：eclipse，idea；

文章主要介绍下checkstyle自定义规则的大概用法，checkstyle是通过xml来管理每个check模块，通过配置我们需要的模块（module），目前checkstyle已经提供了很多模块给我们使用，直接应用就可以了。

xml的格式：

 

<module name="Checker">
   <property name="severity" value="error"/>  
    <module name="TreeWalker">
        <module name="AvoidStarImport"/>
        <module name="ConstantName"/>
        <module name="EmptyBlock"/>
         ....
    </module>
</module>

针对官网的案例，详细描述具体用途：

 

1.<module name="Checker">定义标准xml的根模块节点；

2.<property name="severity" value="error"/>全局属性，定义严重级别；

3. <module name="TreeWalker"> 定义检查的语法树，包含多个我们需要的检查的模块，在代码进行check操作的时候会工具配置的子节点模块进行check；

4.AvoidStarImport(import语句不使用通配符),ConstantName(常量命名),EmptyBlock(空的代码块)等标准的checkstyle模块；

 

checkstyle提供的标准模块，我们可以在<TreeWalker>工具需要应用

1.Annotations 注解；

2.Block Check 代码块；

3.Class Design 类设计；

4.Codding 代码风格；

5.Javadoc Comments 注释；

6.Regexp 正则表达匹配，自己定义正在表达；

......

注：以上是常用的几个模块，具体每个模块的参数使用可以参考官网的文档具体描述；

       附件是参考的自定配置的模板，可以参考下，借鉴的是网上一个哥们共享的，并且自己又修改增加一些验证模块，idea使用过没问题，非常感谢分享。