Maven Checkstyle Plugin使用

为了在提交代码之前做一些必要的代码检查，我们需要使用一些工具来辅助我们的工作——对于maven工程我们可以使用maven checkstyle plugin。这里以 eclipse 为例介绍怎么使用 maven checkstyle plugin。 接下来会以如下步骤进行讲解：

• 定义规则文件

• 添加插件配置

• 运行mvn命令检测代码

定义规则文件

这里不具体介绍怎么制定规则文件，具体可以查看官网说明：http://maven.apache.org/plugins/maven-checkstyle-plugin/ ，本例中使用名为checkstyle.xml的规则文件。

添加插件配置

在我们的maven工程中有个pom.xml文件，修改如下：

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <checkstyle.config.location>checkstyle.xml</checkstyle.config.location>
  </properties>

上述添加了一段

<checkstyle.config.location>checkstyle.xml</checkstyle.config.location>

checkstyle.xml放在和pom.xml同级目录下。否则修改路径。

继续修改pom.xml文件,添加如下内容：

  <reporting>  
    <plugins>  
       <plugin>  
          <groupId>org.apache.maven.plugins</groupId>  
          <artifactId>maven-checkstyle-plugin</artifactId>  
          <version>2.9.1</version>  
       </plugin>  
  
       <plugin>  
          <groupId>org.apache.maven.plugins</groupId>  
          <artifactId>maven-jxr-plugin</artifactId>  
          <version>2.3</version>  
       </plugin>  
    </plugins>  
  </reporting>

如上内容添加了maven-checkstyle-plugin（执行mvn checkstyle:checkstyle根据规则检查代码）和maven-jxr-plugin （展示错误）插件。

运行mvn命令检测代码

修改完pom.xml文件之后就可以开始执行mvn命令来检测代码了。

1. 首先执行mvn checkstyle:checkstyle命令检查工程是否满足checkstyle。方法右键pom.xml文件，选择run as-->选择第二个maven build，在Goals中输入checkstyle:checkstyle（最好在Name中取个名字，方便复用），点击Run即可，具体的检测结果可以在taget\checkstyle-result中查看。

2. 执行mvn jxr:jxr命令可以查看有错的对应代码，网上说法，根据我自己试验以及官网说法，只看到在target/site下生成了xref，里面链接到可工程的javadoc，并没有看到什么查看错误代码的地方，不知道是怎么做到的，希望看到此文的大神能指导一下。

作者 [e-mail]2018 年 06月 07日

另外可参考：Jenkins+maven+checkstyle对java代码进行静态代码分析