Maven依存メカニズム
Maven依存メカニズムは Apache Maven ビルドツールの中核機能の1つであり、プロジェクトに必要な外部ライブラリ(JAR ファイル)とその依存関係を自動的にダウンロードおよび管理します。
Maven依存メカニズムにより Java プロジェクトのビルドプロセスが大幅に簡素化され、開発者はさまざまなサードパーティライブラリを手動でダウンロードおよび管理する必要がなくなります。
Maven は中央リポジトリ(Maven Central Repository)に数百万のオープンソースライブラリを格納しており、プロジェクトで依存関係を宣言すると、Maven はリポジトリからそのライブラリとそのすべての依存項目を自動的にダウンロードします。
依存宣言方法
pom.xml の <dependency> タグを使用して宣言します:
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
</dependencies>
Maven依存の基本概念
1. 座標システム (Coordinates)
Maven は3つの基本座標を使用して依存項目を一意に識別します:
- groupId: プロジェクトが属する組織や会社を定義します(例:
org.apache) - artifactId: プロジェクト名を定義します(例:
commons-lang3) - version: プロジェクトのバージョンを定義します(例:
3.12.0)
この3つの要素が組み合わさって、Maven依存の一意の識別子が形成されます。
2. 依存スコープ (Scope)
Maven はさまざまな依存スコープを定義しており、依存関係がどの段階で使用できるかを決定します:
- compile(デフォルト):コンパイル、テスト、実行時に使用可能
- provided: コンパイルおよびテスト時には使用可能ですが、実行時は JDK またはコンテナによって提供されます
- runtime: テストおよび実行時にのみ必要
- test: テストのコンパイルおよび実行段階でのみ必要
- system: provided に似ていますが、JAR パスを明示的に指定する必要があります
3. 推移的依存 (Transitive Dependencies)
プロジェクト A がプロジェクト B に依存し、プロジェクト B がプロジェクト C に依存する場合、Maven はプロジェクト C もプロジェクト A の依存として自動的に取り込みます。この依存関係を自動的に処理する特性を推移的依存と呼びます。
推移ルールはスコープによって異なります:
| 現在の依存スコープ \ 推移的依存スコープ | compile | provided | runtime | test |
|---|---|---|---|---|
| compile | compile | - | runtime | - |
| provided | provided | provided | provided | - |
| runtime | runtime | - | runtime | - |
| test | - | - | - | - |
プロジェクトでMaven依存を使用する方法
1. pom.xml で依存を追加する
Maven プロジェクトのpom.xmlファイル内の<dependencies>セクションはプロジェクトの依存関係を宣言するために使用されます:
例
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.12.0</version>
</dependency>
</dependencies>
2. 依存の除外 (Exclusions)
推移的依存を除外する必要がある場合があります。その場合は<exclusions>タグを使用できます:
例
<groupId>com.example</groupId>
<artifactId>example-library</artifactId>
<version>1.0</version>
<exclusions>
<exclusion>
<groupId>org.unwanted</groupId>
<artifactId>unwanted-dependency</artifactId>
</exclusion>
</exclusions>
</dependency>
3. 依存管理 (Dependency Management)
マルチモジュールプロジェクトでは、親 POM で<dependencyManagement>を使用して依存バージョンを一元管理できます:
例
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>5.3.20</version>
</dependency>
</dependencies>
</dependencyManagement>
子モジュールで参照する場合は、groupId と artifactId を宣言するだけでよく、バージョンを指定する必要はありません。
依存管理の高度な機能
依存バージョン管理
使用するdependencyManagementでバージョンを一元管理します:
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>5.3.18</version>
</dependency>
</dependencies>
</dependencyManagement>
<!-- 子模块使用时无需指定版本 -->
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
</dependency>
</dependencies>
BOMインポート
関連する一連の依存関係のバージョンを管理します:
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>2.6.4</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
任意依存 (Optional)
依存関係をオプションとしてマークし、推移させません:
<dependency>
<groupId>com.example</groupId>
<artifactId>optional-lib</artifactId>
<version>1.0</version>
<optional>true</optional>
</dependency>
Maven依存解決メカニズム
1. 依存調停 (Dependency Mediation)
バージョン競合が発生した場合、Maven は次のルールで解決します:
- 最も近い定義が優先されます(依存ツリーでパスが最短のバージョンが選択されます)
- パスの長さが同じ場合は、先に宣言された依存関係が優先されます
2. 依存スコープの影響
スコープが異なると、推移性に影響します:
- compile スコープの依存関係は推移します
- provided と test スコープの依存関係は推移しません
- runtime スコープの依存関係は runtime スコープで推移します
異なるスコープの依存関係の最終的なパッケージング結果:
| Scope | パッケージング有無 | 典型的な用途 |
|---|---|---|
compile | である | コア依存 |
provided | 否 | コンテナ提供 |
runtime | である | 実行時に必要 |
test | 否 | ユニットテスト |
3. 任意依存 (Optional Dependencies)
optional とマークされた依存関係は推移しません:
例
<groupId>com.example</groupId>
<artifactId>optional-lib</artifactId>
<version>1.0</version>
<optional>true</optional>
</dependency>
依存関連コマンド
依存ツリーを表示:
mvn dependency:tree
依存関係の問題を分析:
mvn dependency:analyze
依存関係をディレクトリにダウンロード:
mvn dependency:copy-dependencies
Mavenリポジトリ (Repository)
1. リポジトリの種類
- ローカルリポジトリ: ユーザーのホームディレクトリにある
.m2/repositoryディレクトリ - 中央リポジトリ: Maven のデフォルトの公開リポジトリ
- リモートリポジトリ: 会社や組織が構築したプライベートリポジトリ
2. リポジトリ設定
で設定できますpom.xml 或 settings.xmlリポジトリを設定できます:
例
<repository>
<id>my-repo</id>
<url>http://repo.example.com/maven2</url>
</repository>
</repositories>
ベストプラクティス
- 依存バージョンを明示的に指定する: LATEST や RELEASE などの動的バージョンの使用を避ける
- 依存関係を定期的に更新する: を使用して
mvn versions:display-dependency-updates利用可能な更新を確認する - BOM を使用する: 大規模フレームワーク(Spring など)では、Bill of Materials を使用してバージョンを一元管理します
- 不要な依存関係をクリーンアップする: 定期的に実行して
mvn dependency:analyze未使用の依存関係を確認します