Mavenで重複する依存関係を削除する

投稿日: 2022-10-25 2022-10-25
タグ: Maven

1. 概要

このチュートリアルでは、Mavenコマンドを使用してpom.xmlで重複する依存関係を検出する方法を学習します。また、Maven Enforcerプラグインを使用して、重複する依存関係が存在する場合にビルドを失敗させる方法についても説明します。

2. 重複する依存関係を検出する理由

pom.xml に重複する依存関係がある場合のリスクは、ターゲットライブラリの最新バージョンがプロジェクトのビルドパスに適用されない可能性があることです。たとえば、次のpom.xmlについて考えてみましょう。

<project>
  [...]
  <dependencies>
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-lang3</artifactId>
      <version>3.12.0</version>
    </dependency>
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-lang3</artifactId>
      <version>3.11</version>
    </dependency>
  </dependencies>
   [...]
</project>

ご覧のとおり、同じライブラリには commons-lang3 という2つの依存関係がありますが、これらの依存関係の両方でバージョンが異なります。

次に、Mavenコマンドを使用してこれらの重複する依存関係を検出する方法を見てみましょう。

3. 依存関係ツリーコマンド

ターミナルからコマンドmvndependency：tree を実行して、出力を確認してみましょう。

$ mvn dependency:tree
[INFO] Scanning for projects...
[WARNING]
[WARNING] Some problems were encountered while building the effective model for com.baeldung:maven-duplicate-dependencies:jar:0
.0.1-SNAPSHOT
[WARNING] 'dependencies.dependency.(groupId:artifactId:type:classifier)' must be unique: org.apache.commons:commons-lang3:jar -
> version 3.12.0 vs 3.11 @ line 14, column 15
[WARNING]
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING]
[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.
[WARNING]
[INFO]
[INFO] -------------< com.baeldung:maven-duplicate-dependencies >--------------
[INFO] Building maven-duplicate-dependencies 0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-dependency-plugin:2.8:tree (default-cli) @ maven-duplicate-dependencies ---
[WARNING] The artifact xml-apis:xml-apis:jar:2.0.2 has been relocated to xml-apis:xml-apis:jar:1.0.b2
[INFO] com.baeldung:maven-duplicate-dependencies:jar:0.0.1-SNAPSHOT
[INFO] \- org.apache.commons:commons-lang3:jar:3.11:compile
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.136 s
[INFO] Finished at: 2021-12-20T09:45:20+05:30
[INFO] ------------------------------------------------------------------------

ここで、重複する依存関係の存在に関する警告が表示されます pom.xml。また、バージョン3.11の commons-lang3.jarはより高いバージョンであっても、プロジェクトに追加されましたが、 3.12.0、 が存在します。 Mavenが後でpom.xmlに表示される依存関係を選択したために発生しました。

4. 依存関係analyze-duplicateコマンド

次に、コマンド mvndependency：analyze-duplicate を実行して、出力を確認しましょう。

$ mvn dependency:analyze-duplicate
[INFO] Scanning for projects...
[WARNING]
[WARNING] Some problems were encountered while building the effective model for com.baeldung:maven-duplicate-dependencies:jar:0
.0.1-SNAPSHOT
[WARNING] 'dependencies.dependency.(groupId:artifactId:type:classifier)' must be unique: org.apache.commons:commons-lang3:jar -
> version 3.12.0 vs 3.11 @ line 14, column 15
[WARNING]
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING]
[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.
[WARNING]
[INFO]
[INFO] -------------< com.baeldung:maven-duplicate-dependencies >--------------
[INFO] Building maven-duplicate-dependencies 0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-dependency-plugin:2.8:analyze-duplicate (default-cli) @ maven-duplicate-dependencies ---
[WARNING] The artifact xml-apis:xml-apis:jar:2.0.2 has been relocated to xml-apis:xml-apis:jar:1.0.b2
[INFO] List of duplicate dependencies defined in <dependencies/> in your pom.xml:
        o org.apache.commons:commons-lang3:jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  0.835 s
[INFO] Finished at: 2021-12-20T09:54:02+05:30
[INFO] ------------------------------------------------------------------------

ここで、WARNINGとINFOの両方のログステートメントが重複する依存関係の存在に言及していることがわかります。

5. 重複する依存関係が存在する場合のビルドの失敗

上記の例では、重複する依存関係を検出する方法を見ましたが、BUILDは引き続き成功しています。これにより、使用されているjarのバージョンが正しくなくなる可能性があります。

Maven Enforcerプラグインを使用すると、重複する依存関係が存在する場合にビルドが失敗することを確認できます。

このためには、このMavenプラグインを pom.xml に追加し、ルール banDuplicatePomDependencyVersions：を追加する必要があります。

<project>
  [...]
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-enforcer-plugin</artifactId>
        <version>3.0.0</version>
        <executions>
          <execution>
            <id>no-duplicate-declared-dependencies</id>
            <goals>
              <goal>enforce</goal>
            </goals>
            <configuration>
              <rules>
                <banDuplicatePomDependencyVersions/>
              </rules>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  [...]
</project>

これで、ルールはMavenビルドをバインドします。

$ mvn verify
[INFO] Scanning for projects...
[WARNING]
[WARNING] Some problems were encountered while building the effective model for com.baeldung:maven-duplicate-dependencies:jar:0
.0.1-SNAPSHOT
[WARNING] 'dependencies.dependency.(groupId:artifactId:type:classifier)' must be unique: org.apache.commons:commons-lang3:jar -
> version 3.12.0 vs 3.11 @ line 14, column 14
[WARNING]
[INFO] -------------< com.baeldung:maven-duplicate-dependencies >--------------
[INFO] Building maven-duplicate-dependencies 0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-enforcer-plugin:3.0.0:enforce (no-duplicate-declared-dependencies) @ maven-duplicate-dependencies ---
[WARNING] Rule 0: org.apache.maven.plugins.enforcer.BanDuplicatePomDependencyVersions failed with message:
Found 1 duplicate dependency declaration in this project:
 - dependencies.dependency[org.apache.commons:commons-lang3:jar] ( 2 times )

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  0.537 s
[INFO] Finished at: 2021-12-20T09:55:46+05:30
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-enforcer-plugin:3.0.0:enforce (no-duplicate-declared-dependencies) on project maven-duplicate-dependencie
s: Some Enforcer rules have failed. Look above for specific messages explaining why the rule failed.

6. 重複する依存関係の削除

重複する依存関係を特定したら、それらを削除する最も簡単な方法は、 pom.xml からそれらを削除し、プロジェクトで使用される一意の依存関係のみを保持することです。

7. 結論

この記事では、 mvndependency：treeおよびmvndependency：analyze-duplicateコマンドを使用してMavenで重複する依存関係を検出する方法を学びました。また、Maven Enforcerプラグインを使用して、組み込みのルールを適用することにより、重複する依存関係を含むビルドを失敗させる方法も確認しました。

getdocs

13036