Maven集成CheckStyle

最近在组里开发项目的时，经常遇到项目里面代码格式不统一，merge的时候经常冲突一大片，在网上搜索，查到了maven可以集成checkstyle进行代码格式化审查。现将我的经验做以分享。

参考网址：https://www.cnblogs.com/huang0925/p/3148389.html

 

配置CheckStyle插件

    org.apache.maven.plugins
    maven-checkstyle-plugin
    2.10
    
        
        config/google.xml
    
    
        
            checkstyle
            validate
            
                check
            
            
                true
            
        
    

 

我们定义了在maven lifecycle的validate阶段执行check task，并且如果发现有违反标准的情况就会fail当前的build。

maven-checkstyle-plugin内置了4种规范.

• config/sun_checks.xml
• config/maven_checks.xml
• config/turbine_checks.xml
• config/avalon_checks.xml

其中sun_checks.xml为默认值。如果想要使用其他三种规范，则只需配置configuration。

我的项目为spring boot项目，使用默认configuration会报错“Failed during checkstyle execution: Unable to find configuration file at location: config/maven_checks.xml: Could not find resource 'config/maven_checks.xml'” ，在此处我自定义加上了配置文件就成功了。

从官网找到了原因：

修改pom之后，就可运行CheckStyle检查，检查的报告文件在target\checkstyle-result.xml中

运行checkstyle检查：

mvn checkstyle:checkstyle

运行失败截图：

 

运行成功截图：

 

Spring Boot 集成checkstyle的demo地址

https://github.com/FrankQF823/SpringBoot-CheckStyle

 

checkstyle最小化xml
 

待补充：

checkstyle的规范写法

checkstyle和maven更好集成