Maven从父级继承checkstyle

Question

我有一个带有这种 checkstyle 配置的 父 POM：

<properties>
    <checkstyle.configLocation>src/checkstyle/checkstyle.xml</checkstyle.configLocation>
    <checkstyle.suppressionsLocation>src/checkstyle/checkstyle-suppressions.xml</checkstyle.suppressionsLocation>
    <maven-checkstyle-plugin.version>2.17</maven-checkstyle-plugin.version>
<properties>

<build>
    <pluginManagement>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>${maven-checkstyle-plugin.version}</version>
            <configuration>
                <skip>true</skip>
            </configuration>
            <executions>
                <execution>
                    <id>validate</id>
                    <phase>validate</phase>
                    <configuration>
                        <configLocation>${checkstyle.configLocation}</configLocation>
                        <suppressionsLocation>${checkstyle.suppressionsLocation}</suppressionsLocation>
                    </configuration>
                </execution>
            </executions>     
        </plugin>
    </pluginManagement>
</build>

这是继承的 POM：

<build>
    <plugins>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
    </plugins>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <configuration>
                    <configLocation>${project.parent.basedir}/${checkstyle.configLocation}</configLocation>
                    <suppressionsFile>${project.parent.basedir}/${checkstyle.suppressionsLocation}</suppressionsFile>
                </configuration>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

我只想在继承的项目中执行 checkstyle（因为我将有多个使用父 pom 的项目）。在父项目中，不需要运行 checkstyle，但我必须在父项目上使用 checkstyle.xml 和 checkstyle-suppressions.xml 配置文件，并使用来自继承的项目。

这是mvn clean install后得到的错误：

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:2.17:check (validate) on project MyProject: Failed during checkstyle execution: Unable to find suppressions file at location: src/checkstyle/checkstyle-suppressions.xml: Could not find resource 'src/checkstyle/checkstyle-suppressions.xml'. -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

子项目没有找到父项目的checkstyle配置文件。

Answer 1

来自文档

pluginManagement：是一个可以在侧面插件中看到的元素。 插件管理以几乎相同的方式包含插件元素， 除了为此配置插件信息 特定的项目构建，它旨在配置项目构建 从这个继承。但是，这只配置插件 实际上是在子元素的 plugins 元素中引用的。 孩子们有权覆盖 pluginManagement 定义。

考虑到您的继承 POM，使用的 maven-checkstyle-plugin 将是您首先声明的（在 pluginManagement 之外）。取而代之的是，对于继承的pom.xml，要覆盖配置，您必须在plugins 而不是pluginManagement 下指定相同的配置。尝试将 pom 的构建标签简化为 --

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <!--Note - the version would be inherited-->
            <configuration>
                <configLocation>${project.parent.basedir}/${checkstyle.configLocation}</configLocation>
                <suppressionsFile>${project.parent.basedir}/${checkstyle.suppressionsLocation}</suppressionsFile>
            </configuration>
        </plugin>
    </plugins>
</build>

Edit : - 从评论中可以看出，OP 没有使用 Simple Inheritance structure，因此在这种情况下使用 相对路径 可以解决问题.

Answer 2

如果您继承的项目位于不同的存储库中，则需要另一种方法。只需将父级添加为插件中的依赖项即可。请注意，您不能在 <reporting> 中使用此方法，因为它不支持插件依赖项。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <!--version is inherited-->
            <dependencies>
                <dependency>
                    <groupId>parent.group.id</groupId>
                    <artifactId>parent</artifactId>
                    <version>1.0.0-SNAPSHOT</version>
                </dependency>
            </dependencies>
         </plugin>
    </plugins>
</build>

有关详细信息，请参阅 https://maven.apache.org/plugins/maven-checkstyle-plugin/examples/multi-module-config.html