Mavenの依存関係管理

Maven の核となる機能の1つが依存管理です。多数のモジュール(数百または数千のモジュールやサブプロジェクトを含む)で構成されるプロジェクトを扱う場合、モジュール間の依存関係は非常に複雑になり、管理も困難になります。このような状況に対して、Maven は高度に制御する方法を提供します。


推移的依存関係の発見

よくある状況として、たとえば A が他のライブラリ B に依存しているとします。別のプロジェクト C が A を使用したい場合、C プロジェクトもライブラリ B を使用する必要があります。

Maven は、必要なすべてのライブラリを検索する手間を省くことができます。Maven はプロジェクトファイル(pom.xml)を読み取ることで、それらのプロジェクト間の依存関係を特定します。

私たちが行う必要があるのは、各プロジェクトの pom で直接的な依存関係を定義することだけです。その他のことは Maven が処理してくれます。

推移的依存関係によって、含まれるすべてのライブラリのグラフは急速に成長します。重複するライブラリがある場合、発生し得る状況は増え続けます。Maven は、推移的依存関係の程度を制御するためのいくつかの機能を提供します。

機能 機能の説明
依存関係の調停 複数の手動で作成されたバージョンが同時に存在する場合、どの依存バージョンが使用されるかを決定します。2つの依存バージョンが依存ツリー内の深さが同じ場合、最初に宣言された依存関係が使用されます。
依存管理 手動で作成された特定のバージョンを直接指定して使用できます。たとえば、プロジェクト C が依存項目としてプロジェクト B を含み、プロジェクト B がプロジェクト A に依存しているとします。この場合、プロジェクト B が参照されるときに使用されるプロジェクト A のバージョンを明示的に指定できます。つまり、プロジェクト B で使用されるプロジェクト A の特定のバージョンを制御できるということです。
依存スコープ ビルドプロセスの各段階に含まれる依存関係。
依存関係の除外 推移的依存関係はすべて、"exclusion" 要素によって除外できます。例:A は B に依存し、B は C に依存します。したがって、A は C を「除外」としてマークできます。
オプションの依存関係 推移的依存関係はすべて、"optional" 要素を使用してオプションとしてマークできます。例:A は B に依存し、B は C に依存します。したがって、B は C をオプションとしてマークできるため、A は C を使用しないようにできます。

依存スコープ

推移的依存関係の発見は、次の依存スコープを使用して制限できます:

スコープ 説明
コンパイル このスコープは、関連する依存関係がプロジェクトのクラスパスでのみ有効であることを示します。デフォルト値です。
提供 このスコープは、関連する依存関係が実行時の JDK または Web サーバーによって提供されることを示します。
ランタイム このスコープは、関連する依存関係がコンパイル段階では必須ではないが、実行段階では必須であることを示します。
テスト このスコープは、関連する依存関係がテストのコンパイル段階と実行段階でのみ必要であることを示します。
システム このスコープは、システムパスを提供する必要があることを示します。
インポート このスコープは、依存関係が pom 内で定義されている場合にのみ使用されます。また、現在のプロジェクトの POM ファイルのセクションで定義された依存関係は、特定の POM を置き換えることができます。

依存管理

通常、共通のプロジェクトの下に一連のプロジェクトがあります。この場合、共通の依存関係をすべて含む pom ファイルを作成できます。これを他のサブプロジェクトの pom の親 pom と呼びます。次の例は、この概念をよりよく理解するのに役立ちます。

以下は、上記の依存関係図の詳細な説明です。

  • App-UI-WAR は App-Core-lib と App-Data-lib に依存しています。

  • Root は App-Core-lib と App-Data-lib の親プロジェクトです。

  • Root は、その依存関係セクションで Lib1、lib2、Lib3 を依存関係として定義しています。

App-UI-WAR の 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/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.companyname.groupname</groupId> <artifactId>App-UI-WAR</artifactId> <version>1.0</version> <packaging>war</packaging> <dependencies> <dependency> <groupId>com.companyname.groupname</groupId> <artifactId>App-Core-lib</artifactId> <version>1.0</version> </dependency> </dependencies> <dependencies> <dependency> <groupId>com.companyname.groupname</groupId> <artifactId>App-Data-lib</artifactId> <version>1.0</version> </dependency> </dependencies> </project>

App-Core-lib の 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/xsd/maven-4.0.0.xsd"> <parent> <artifactId>Root</artifactId> <groupId>com.companyname.groupname</groupId> <version>1.0</version> </parent> <modelVersion>4.0.0</modelVersion> <groupId>com.companyname.groupname</groupId> <artifactId>App-Core-lib</artifactId> <version>1.0</version> <packaging>jar</packaging> </project>

App-Data-lib の 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/xsd/maven-4.0.0.xsd"> <parent> <artifactId>Root</artifactId> <groupId>com.companyname.groupname</groupId> <version>1.0</version> </parent> <modelVersion>4.0.0</modelVersion> <groupId>com.companyname.groupname</groupId> <artifactId>App-Data-lib</artifactId> <version>1.0</version> <packaging>jar</packaging> </project>

Root の 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/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.companyname.groupname</groupId> <artifactId>Root</artifactId> <version>1.0</version> <packaging>pom</packaging> <dependencies> <dependency> <groupId>com.companyname.groupname1</groupId> <artifactId>Lib1</artifactId> <version>1.0</version> </dependency> </dependencies> <dependencies> <dependency> <groupId>com.companyname.groupname2</groupId> <artifactId>Lib2</artifactId> <version>2.1</version> </dependency> </dependencies> <dependencies> <dependency> <groupId>com.companyname.groupname3</groupId> <artifactId>Lib3</artifactId> <version>1.1</version> </dependency> </dependencies> </project>

ここで App-UI-WAR プロジェクトをビルドすると、Maven は依存関係グラフを走査してすべての依存関係を特定し、アプリケーションをビルドします。

上記の例から、次の重要な概念を学ぶことができます:

  • 共通の依存関係は、親 pom の概念を使用してまとめて配置できます。App-Data-lib と App-Core-lib プロジェクトの依存関係は Root プロジェクトに列挙されています(Root のパッケージタイプを参照してください。POM です)。
  • App-UI-W で Lib1、lib2、Lib3 をその依存関係として宣言する必要はありません。Maven は推移的依存関係メカニズムを使用してこの詳細を実現します。
その他の拡張