maven集成checkStyle插件(完全自定义规则)的辛酸泪史

下这边文件主要是目前国内的大部分都是用的Google和sun的代码检测，如果你想装逼用自己的规则那就看看吧。

首先采用的是boot，为了规范 组内成员的代码风格和质量，特此用checkstyle来检测。

为什么用maven的checkstyle插件呢？说起来真的很严格，你如果代码不规范你连包都打不起，因为插件配到了maven的生命周期里面的。

好的开始搞

首先根目录下面建一个如上图所示的文件结构。checkstyle.xml就是我们的自定义代码规范约束文件了，suppressions.xml是干嘛的呢？

当某种情况可能你的一个类不得不导一个这样的包。比如：java.util.*（如果该包下面的所有类你都用上了，就是自动给你转换成.*），然而这种用.*的导包方式是被我们的代码规范所约束了的，所以会报错，所以suppressions.xml的作用就是剔除这种特殊的文件，让checkstyle插件不去检测。

 

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${checkstyle.version}</version>
    <configuration>
        <!-- Here is the custom specification file address, and the confing directory is parallel to the Pom.xml -->
     //checkstyle自定义文件位置
     <configLocation>config/checkStyle/checkstyle.xml</configLocation>
    //不需要检测的类的文件的位置
        <suppressionsLocation>config/checkStyle/suppressions.xml</suppressionsLocation>
    //检测结果是否在控制台输出
        <consoleOutput>true</consoleOutput>
        <detail>false</detail>
    </configuration>
//好像是执行的时候必须检测（不配置无法check代码）
<executions>
    <execution>
        <id>checkstyle</id>
        <phase>validate</phase>
        <goals>
            <goal>check</goal>
        </goals>
        <configuration>
            <failOnViolation>true</failOnViolation>
            <failsOnError>true</failsOnError>
        </configuration>
    </execution>
</executions>
</plugin>

把上述插件直接放在maven的生命周期里面，install就可以检测了，代码不规范无法打包项目哦

也可以单个检测文件，如图

 

需要的自己去网上找资料吧很简单。（checkstyle和suppressions的配置我贴在下一篇文章）