使用自定义Checkstyle运行Maven Checkstyle

Question

我运行了mvn checkstyle:checkstyle，但它并没有使用我的自定义checkstyle XML文件。

请建议我如何使用自己的checkstyle文件而不是默认/当前配置的文件？

- Kevin Meredith

---

你也可以查看qulice-maven-plugin，它将Checkstyle、PMD、FindBugs和其他一些静态分析工具结合在一起，并进行了预配置。 - yegor256

Answer 1

您需要在pom.xml文件中配置文件位置：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-checkstyle-plugin</artifactId>
      <version>2.9.1</version>  
      <configuration>
        <configLocation><!-- Specify file here --></configLocation>
      </configuration>
    </plugin>  
  </plugins>
</build>

请查看此页面以查看其他配置选项。

- Duncan Jones

---

更新了POM文件的标签后，mvn checkstyle:checkstyle会获取正确的checkstyle文件吗？还是只有mvn build -options install才能获取？ - Kevin Meredith

我认为它应该始终使用指定的文件（获取最新副本）。您可以随时进行实验以确保这一点。 - Duncan Jones

Answer 2

现在最新版本的CheckStyle已经发生了变化，您需要使用属性声明文件位置：

<project
  xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  ...

  <properties>
    <checkstyle.config.location><!-- Specify file here --></checkstyle.config.location>
  </properties>

  <build>
    ...

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.9.1</version>
      </plugin>
    </plugins>
  </build>

</project>

从我的自定义checkstyle检查编写示例中获取：

http://blog.blundellapps.co.uk/create-your-own-checkstyle-check/

这里是源代码：

https://github.com/blundell/CreateYourOwnCheckStyleCheck

- Blundell

---

博客链接已失效。 - Filip Procházka

修复了链接。 - Blundell

只是提供信息，根据我的测试，似乎不需要使用属性来声明文件位置，但现在这是一种选择（仍然可以使用configLocation）。 - Woodchuck