如何在多模块项目中使用Maven Checkstyle插件？

Question

这是我在多模块项目中的父 pom.xml （其中一部分）：

...
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <executions>
                <execution>
                    <phase>compile</phase>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
…

此配置指示 mvn 在根项目和每个子模块。我不希望它以这种方式工作。相反，我希望仅针对根项目执行此插件，并针对每个子模块跳过该插件。同时，我有很多子模块，我不喜欢在每个子模块中显式跳过插件执行的想法。

Checkstyle 的文档说 "< em>..确保您的子模块中不包含 Maven Checkstyle 插件..”。但是我如何确保我的子模块继承我的根pom.xml？我迷路了，请帮忙。

Answer 1

但是我如何确保我的子模块继承我的根pom.xml？

要严格回答这个问题，您可以在 元素> 定义。来自 POM 参考：

继承： true 或 false，无论此插件配置是否应应用于从该插件继承的 POM。

像这样的东西：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-checkstyle-plugin</artifactId>
  <!-- Lock down plugin version for build reproducibility -->
  <version>2.5</version>
  <inherited>true</inherited>
  <configuration>
    ...
  </configuration>
</plugin> 

一些更多的建议/评论（可能不适用）：

• 您应该始终锁定插件版本以实现构建可重复性（您可以使用 Maven Enforcer 插件）。
• 人们通常希望使用自定义 Checkstyle 检查器配置 和/或抑制过滤器。
• 多模块配置描述了典型的设置允许在大型多模块项目中共享配置文件。

Answer 2

也许您应该将根 pom 分成 2 个独立的实体：父 pom 和聚合器 pom。您的聚合器 pom 甚至可能继承自父 pom。

如果您下载最新的 hibernate 项目布局，您将看到此设计模式的实际应用。

完成此分离后，您可以在 aggregator/root pom 中定义并执行 checkstyle 插件。因为它不再是子模块的父模块，所以它们不会继承它。

编辑
声明 时使用

只是为了演示，下面是一个取自 hibernate 项目结构的示例。
整个分布可以在这里找到-> http://sourceforge.net/projects/hibernate/files/hibernate3

就是这样，您有一些上下文，这是其目录布局的子集

project-root
   |
   +-pom.xml
   |
   + parent
   |  |
   |  +-pom.xml
   |
   + core
      |
      +-pom.xml

   .. rest is scipped for brevity

project-root/pom.xml片段

<parent>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-parent</artifactId>
    <version>3.5.4-Final</version>
    <relativePath>parent/pom.xml</relativePath>
</parent>

<groupId>org.hibernate</groupId>
<artifactId>hibernate</artifactId>
<packaging>pom</packaging>

<name>Hibernate Core Aggregator</name>
<description>Aggregator of the Hibernate Core modules.</description>

<modules>
    <module>parent</module>
    <module>core</module>

project-root/parent/pom.xml片段

<groupId>org.hibernate</groupId>
<artifactId>hibernate-parent</artifactId>
<packaging>pom</packaging>
<version>3.5.4-Final</version>

project-root/core/pom.xml片段

<parent>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-parent</artifactId>
    <version>3.5.4-Final</version>
    <relativePath>../parent/pom.xml</relativePath>
</parent>

<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
<packaging>jar</packaging>