• 介绍

  CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要，但是枯燥的任务中解脱出来。

  现在就来看看CheckStyle，从安装、checkstyle规范的编写及配置。

• 安装CheckStyle插件

  要使用 checkstyle 需要安装一个 插件 CheckStyle-IDEA,可以通过在线安装插件的方式去安装,如下图： 

  

• 配置 checkstyle 文件

  当安装好插件，打开 IDEA的设置页面 settings -> Other Settings 你会发现默认的 Checkstyle , 勾选就OK了,如下图。

  

  其实在还可以点击上面绿色加号添加自定义checkstyle文件，该文件放在项目的根目录。在里面可以设置你想要的格式，如第一次跟我一样不会写的这里有个自己可以去看。

  如果不想向上面那样每次手动的去添加加载的话，可以用代码来加载，可以在项目的.idea文件中添加checkstyle-idea.xml和codesStyleSettings.xml两个文件：

  

• checkstyle-idea.xml

• codesStyleSettings.xml

自定义的checkstyle还需要在Maven pom.xml中配置就OK了，如下图：

• pom.xml

           
        
         4.0.0
        ......  
                
                     
                          
           
            org.apache.maven.plugins
                           
           
            maven-checkstyle-plugin
                           
           
            2.17
                           
                               
            
             checkstyle.xml
                                
            
             UTF-8
                                
            
             true
                                
            
             true
                                
            
             warning
                            
                           
                               
             
             
              com.puppycrawl.tools
              
             
              checkstyle
              
             
              7.8
              
                            
                       
                      ......        
             
        
       

 

到此，基本的配置就完毕了。现在 IDEA的控制面板会多一个 CheckStyle，你可以在这里方便的进行代码检查。可以点击面板的左上角下拉框 Rules 去动态切换不同的 checkstyle。