Maven - Checkstyle 对模块的依赖不起作用答案

【问题标题】：Maven - Dependency on module for Checkstyle not workingMaven - Checkstyle 对模块的依赖不起作用
【发布时间】：2018-02-22 23:33:15
【问题描述】：

项目链接：https://github.com/randomquestion/MultiModuleMavenCheckstyleSample

我有一个包含多个模块的非常简单的 Maven 项目。我正在关注this Maven guide 以在其上启用 Checkstyle。因此，我创建了一个名为 build-tools 的通用模块（根据指南），并在根 pom 文件中添加了 Checkstyle 配置。但是我遇到了一个非常奇怪的问题。

当我从头开始创建一个新的 Maven 项目时，mvn clean install 似乎工作得很好，包括 Checkstyle。但是，一旦我重命名 checkstyle 文件并使用新名称更新 pom.xml，构建就会开始失败并出现错误 Could not find resource <new Checkstyle file name>。在那之后，我再也无法重建它了。问题似乎是根 pom 中对 build-tools 模块的依赖不起作用。

├── build-tools
│   ├── build-tools\ (1).iml
│   ├── pom.xml
│   ├── src
│       └── main
│           └── resources
│               └── default-checkstyle.xml
├── pom.xml

根 pom.xml：

<modules>
  <module>build-tools</module>
</modules>

<properties>
  <checkstyle.config.location>default-checkstyle.xml</checkstyle.config.location>
</properties>

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-checkstyle-plugin</artifactId>
      <version>2.17</version>
      <dependencies>
        <dependency>
          <groupId>com.mycompany.app</groupId>
          <artifactId>build-tools</artifactId>
          <version>1.0-SNAPSHOT</version>
        </dependency>
      </dependencies>
      <executions>
        <execution>
          <id>validate</id>
          <phase>validate</phase>
          <configuration>
            <configLocation>default-checkstyle.xml</configLocation>
            <encoding>UTF-8</encoding>
            <consoleOutput>true</consoleOutput>
            <failOnViolation>true</failOnViolation>
          </configuration>
          <goals>
            <goal>check</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

构建工具 pom.xml

<parent>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1.0-SNAPSHOT</version>
</parent>

<groupId>com.mycompany.app</groupId>
<artifactId>build-tools</artifactId>
<version>1.0-SNAPSHOT</version>
<name>build-tools</name>

错误：

INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO]
[INFO] my-app
[INFO] build-tools
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building my-app 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ my-app ---
[INFO] Deleting /Users/../workspace/my-app/target
[INFO]
[INFO] --- maven-checkstyle-plugin:2.17:check (validate) @ my-app ---
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] my-app ............................................. FAILURE [  1.170 s]
[INFO] build-tools ........................................ SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.291 s
[INFO] Finished at: 2017-09-13T22:25:26-07:00
[INFO] Final Memory: 12M/309M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:2.17:check (validate) on project my-app: Failed during checkstyle execution: Unable to find configuration file at location: default-checkstyle.xml: Could not find resource 'default-checkstyle.xml'. -> [Help 1]

对可能出现的问题有什么建议吗？为什么mvn install 不先构建build-tools 模块？

【问题讨论】：

标签： java maven maven-plugin checkstyle

【解决方案1】：

您当前的设置将不起作用！当我克隆您的项目并尝试构建时，它肯定会失败，因为在构建父 pom 时，我的本地存储库中没有 build-tool 工件。

这是你应该有的结构：

 -- build-tools
  |   |
  |   - pom.xml
  |
  - my app
  |   |
  |   - src
  |   - pom.xml
  |
  - pom.xml

这里是父pom.xml

<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/maven-v4_0_0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.mycompany.app</groupId>
 <artifactId>my-app-parent</artifactId>
 <packaging>pom</packaging>
 <version>1.0-SNAPSHOT</version>

 <name>my-app-parent</name>
 <url>http://maven.apache.org</url>

 <!--
   ~ Modules
 -->
 <modules>
   <module>build-tools</module>
   <module>my-app</module>    
 </modules>

 <build>
   <!--
     ~ Plugin Settings
   -->
   <pluginManagement>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
         <version>2.17</version>
         <dependencies>
           <dependency>
             <groupId>com.mycompany.app</groupId>
             <artifactId>build-tools</artifactId>
             <version>1.0-SNAPSHOT</version>
           </dependency>
         </dependencies>
         <executions>
           <execution>
             <id>validate</id>
             <phase>validate</phase>
             <goals>
               <goal>check</goal>
             </goals>
           </execution>
         </executions>
         <configuration>
           <configLocation>my-app-checkstyle.xml</configLocation>
         </configuration>
       </plugin>
     </plugins>
   </pluginManagement>
 </build>

 <reporting>
   <plugins>
     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-checkstyle-plugin</artifactId>
       <version>2.17</version>
       <configuration>
         <configLocation>default-checkstyle.xml</configLocation>
       </configuration>
     </plugin>
   </plugins>
 </reporting>
</project>

build-tools/pom.xml 为

<?xml version="1.0" encoding="UTF-8"?>
<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">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
  </parent>
  <artifactId>build-tools</artifactId>
</project>

你的其他项目/pom.xml

<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/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
     <groupId>com.mycompany.app</groupId>
     <artifactId>my-app-parent</artifactId>
     <version>1.0-SNAPSHOT</version>
   </parent>
  <artifactId>my-app</artifactId>
  <packaging>jar</packaging>

  <name>my-app</name>
  <url>http://maven.apache.org</url>

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

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

将 checkstyle 文件名重命名为build-tools/src/main/resources/my-app-checkstyle.xml

【讨论】：

我创建了一个pull request
谢谢！这也有效，但如果根/父模块中有 java 源，则会失败。提交的另一个拉取请求也适用于该案例。
根模块是maven pom aggregator，为什么你认为它应该有来源？
如果您仍然想在父级中拥有源代码，那么我可能会说创建一个单独的独立构建工具项目，它将作为外部依赖项满足您所有其他项目的需求。 build-tools 单独的项目遵循它自己的发布节奏，您需要将此工件部署到您的内部存储库，以便其他项目可以使用它。

【解决方案2】：

根据same document。除了<reporting> 标记中的<dependency>（在<build> 标记中）之外，您应该尝试将插件设置配置为：

<reporting>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-checkstyle-plugin</artifactId>
      <version>2.17</version>
      <configuration>
         <configLocation>default-checkstyle.xml</configLocation>
         <encoding>UTF-8</encoding>
         <consoleOutput>true</consoleOutput>
         <failOnViolation>true</failOnViolation>
      </configuration>
    </plugin>
  </plugins>
</reporting>

【讨论】：

这看起来不是问题。我认为问题在于 checkstyle 配置中对模块构建工具的依赖无法正常工作。这就是为什么当我重命名文件时，它失败了。
@RandomQuestion 你的意思是，把它重命名为checkstyle.xml 对你有用吗？
是的。它适用于原始文件名。我验证它的另一种方法是我创建了一个带有 root pom 和 build-tools 模块的全新项目。如果我直接在 root 上运行 mvn install ，它找不到 build-tools 的 jar，这表明它没有先构建 build-tools。