如何在多模塊項目中使用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插件。我不希望它以這種方式工作。相反，我希望此插件僅針對根項目執行，並且可以跳過每個子模塊。同時，我有很多子模塊，我不喜歡在每一個模塊中明確跳過插件執行的想法。

的文檔checkstylesays「..ensure你不包括的Maven Checkstyle的插件在您的子模塊..」。但我怎麼能確保，如果我的子模塊繼承我的根pom.xml？我迷路了，請幫忙。

Answer 1

也許你應該將你的root pom分成兩個獨立的實體：parent pom和aggregator pom。你的聚合器pom甚至可能繼承父pom。

如果您下載hibernate的最新項目佈局，您將看到這個設計模式正在運行。

完成分離後，您可以在aggregator/root pom中定義並執行checkstyle插件。因爲它不再是你的子模塊的父親，它不會被它們繼承。

編輯
使用<relativePath>聲明只是爲了演示<parent>

時，下面是從Hibernate項目結構採取的一個例子。
整個分佈可以發現這裏 - >http://sourceforge.net/projects/hibernate/files/hibernate3

正是如此，你有一些背景，這裏是他們的目錄佈局的一個子集

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

    .. rest is scipped for brevity 

項目根/ 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> 

項目根/父/ pom.xml的片段

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

項目根/核心/ 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> 

Answer 2

但我怎麼能保證，如果我的子模塊繼承我的根pom.xml的？

要嚴格回答這個問題，您可以在<plugin>定義中指定<inherited>元素。從POM Reference：

繼承：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 Plugin執行此規則）。
• 人們通常希望使用a Custom Checkstyle Checker Configuration和/或a Suppressions Filter。
• Multimodule Configuration描述了一個允許在大型多模塊項目中共享配置文件的典型設置。