未使用のMaven依存関係を見つける

投稿日: 2022-11-05 2022-11-05
タグ: Maven

1. 概要

Mavenを使用してプロジェクトの依存関係を管理する場合、アプリケーションで使用されている依存関係を追跡できなくなる可能性があります。

この短いチュートリアルでは、プロジェクトで未使用の依存関係を見つけるのに役立つプラグインであるMaven依存関係プラグインの使用方法について説明します。

2. プロジェクトの設定

いくつかの依存関係を追加することから始めましょう。slf4j-api（使用するもの）と common-collections （使用しないもの）：

<dependencies>
    <dependency>
        <groupId>commons-collections</groupId>
        <artifactId>commons-collections</artifactId>
        <version>3.2.2</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.25</version>
    </dependency>
</dependencies>

pomで指定しなくても、Maven依存関係プラグインにアクセスできます。いずれの場合も、 pom.xml 定義を使用して、バージョンと、必要に応じていくつかのプロパティを指定できます。

<build>
    <plugins>
        <plugin>
            <artifactId>maven-dependency-plugin</artifactId>
            <version>3.1.2</version>
        </plugin>
    </plugins>
</build>

3. コードサンプル

プロジェクトが設定されたので、前に定義した依存関係の1つを使用するコード行を記述しましょう：

public Logger getLogger() {
    return LoggerFactory.getLogger(UnusedDependenciesExample.class);
}

Slf4JライブラリのLoggerFactoryはメソッドで返されますが、common-collectionsライブラリは使用されないため、削除の候補になります。

4. 未使用の依存関係を見つける

Maven依存関係プラグインを使用すると、プロジェクトで使用されていない依存関係を見つけることができます。そのために、プラグインの分析目標を呼び出します。

$ mvn dependency:analyze

[INFO] --- maven-dependency-plugin:3.1.1:analyze (default-cli) @ maven-unused-dependencies ---
[WARNING] Unused declared dependencies found:
[WARNING]    commons-collections:commons-collections:jar:3.2.2:compile
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.225 s
[INFO] Finished at: 2020-04-01T16:10:25-04:00
[INFO] ------------------------------------------------------------------------

プロジェクトで使用されていないすべての依存関係について、Mavenは分析レポートで警告を発行します。

5. 使用する依存関係を指定する

プロジェクトの性質によっては、プラグイン指向のプロジェクトなど、実行時にクラスをロードする必要がある場合があります。

依存関係はコンパイル時に使用されないため、 maven-dependency-plugin は、依存関係が実際には使用されているにもかかわらず、使用されていないことを示す警告を発行します。そのために、ライブラリが使用されていることをプラグインに強制して指示することができます。

これを行うには、usedDependenciesプロパティ内の依存関係を一覧表示します。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <configuration>
        <usedDependencies>
            <dependency>commons-collections:commons-collections</dependency>
        </usedDependencies>
    </configuration>
</plugin>

analysis ゴールを再度実行すると、未使用の依存関係がレポートで考慮されなくなっていることがわかります。

6. 結論

この短いチュートリアルでは、未使用のMaven依存関係を見つける方法を学びました。保守性が向上し、プロジェクトのライブラリサイズが小さくなるため、未使用の依存関係を定期的にチェックすることをお勧めします。

いつものように、すべての例を含む完全なソースコードは、GitHubでから入手できます。

getdocs

13036