Maven项目使用Checkstyle检查代码

Maven项目使用Checkstyle检查代码

Checkstyle可以做到自定义风格的代码检查，这里提供一些使用的例子供参考。

idea中配置checkstyle-IDEA插件

使用checkstyle-IDEA插件，可以直接依靠idea检查代码，优点是有图形界面，操作直观，安装好之后所有项目共用，缺点是需要手动执行检查。
按快捷键 Ctrl+Alt+S ,选择Plugins ,在marketplace输入checkStyle-IDEA搜索安装。

如果搜索不到，也可以打开插件官网https://plugins.jetbrains.com/搜索checkStyle-IDEA，点击安装后，回到idea会自动下载安装。


安装好之后，按快捷键Ctrl+Alt+S,选择Checkstyle项进行配置，如图（检查规则文件可以参考文末我自定义的）

在左下角有Checkstyle的选项卡，选择规则文件运行即可。

在Maven项目中配置使用Checkstyle

由于项目是Maven项目，希望在编译的时候自动执行检查，不需要额外手动执行，可以选择在pom.xml配置maven-checkstyle-plugin插件，绑定到Maven的生命周期，这样在执行mvn compile等命令时自动触发执行检查。

单模块的maven项目

单模块的maven项目只需要配置plugins即可， pom.xml配置如下：

<build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-checkstyle-plugin</artifactId>
                    <version>3.1.1</version>
                    <dependencies>
                        <!--指定依赖的checkstyle版本-->
                        <dependency>
                            <groupId>com.puppycrawl.tools</groupId</