检查样式不起作用

Question

我是 Maven 和 chekstyle 的新手，所以需要问一些问题...我想在我的基于 Maven 的项目中使用 checkstyle，所以在我的 pom.xml 中我添加了依赖项

<dependency>
   <groupId>checkstyle</groupId>
   <artifactId>checkstyle</artifactId>
   <version>2.4</version>
</dependency>

，而且我也有在插件标签中添加了条目：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-checkstyle-plugin</artifactId>
  <version>2.4</version>
  <configuration>
    <enableRulesSummary>true</enableRulesSummary>
    <configLocation>checkstyle.xml</configLocation>
  </configuration>
</plugin>

但是当我使用命令 mvn clean install 运行我的 Maven 构建时，checkstyle 不执行任何操作。由于我的系统中还没有任何 checkstyle.xml ，它不应该向我抱怨该错误吗？

我还缺少什么配置？

Answer 1

我想在我的基于 Maven 的项目中使用 checkstyle，所以在我的 pom.xml 中我添加了依赖项 (...)

你不需要添加这个依赖项，你只需要声明插件（一个插件声明它的自己的依赖项）。

(...)但是当我使用命令 mvn clean install 运行我的 Maven 构建时，checkstyle 不会执行任何操作。

是的，因为您只声明插件，所以您没有绑定check 目标是生命周期阶段，因此正常构建不会触发 checkstyle 插件。如果您希望 checkstyle:check 作为构建的一部分被触发，您需要在执行中声明 check 目标（它默认将自身绑定到 验证阶段）。像这样：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-checkstyle-plugin</artifactId>
  <!-- Lock down plugin version for build reproducibility -->
  <version>2.5</version>
  <configuration>
    <consoleOutput>true</consoleOutput>
    <configLocation>checkstyle.xml</configLocation>
    ...
  </configuration>
  <executions>
    <execution>
      <goals>
        <goal>check</goal>
      </goals>
    </execution>
  </executions>
</plugin>

现在，调用包括 verify 在内的任何阶段都将调用 checkstyle。

由于我的系统中还没有任何 checkstyle.xml，它不应该向我抱怨该错误吗？

它将...在调用时（通过 mvn checkstyle:check 显式调用，或者如果您按照建议修改设置，则作为构建的一部分）。