Mécanisme de dépendances Maven

Le mécanisme de dépendance Maven est l'une des fonctionnalités principales de l'outil de build Apache Maven. Il peut télécharger et gérer automatiquement les bibliothèques externes (fichiers JAR) requises par le projet et leurs dépendances.

Le mécanisme de dépendance Maven simplifie grandement le processus de build des projets Java, permettant aux développeurs d'éviter de télécharger et gérer manuellement diverses bibliothèques tierces.

Maven stocke des millions de bibliothèques open source via le dépôt central Maven. Lorsque vous déclarez une dépendance dans votre projet, Maven télécharge automatiquement cette bibliothèque et toutes ses dépendances depuis le dépôt.

Déclaration de dépendance

Déclarez-la dans pom.xml en utilisant la balise <dependency> :

<dependencies>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
</dependencies>

Concepts de base des dépendances Maven

1. Système de coordonnées (Coordonnées)

Maven utilise trois coordonnées de base pour identifier de manière unique une dépendance :

  • groupId: Définit l'organisation ou l'entreprise à laquelle le projet appartient (par ex.,org.apache)
  • artifactId: Définit le nom du projet (par ex.,commons-lang3)
  • version: Définit la version du projet (par ex.,3.12.0)

Ensemble, ces trois éléments forment l'identifiant unique d'une dépendance Maven.

2. Portée des dépendances

Maven définit différentes portées de dépendance, qui déterminent dans quelles phases une dépendance est disponible :

  • compile(par défaut) : Disponible à la compilation, aux tests et à l'exécution
  • provided: Disponible à la compilation et aux tests, mais fourni par le JDK ou le conteneur à l'exécution
  • runtime: Nécessaire uniquement lors des tests et de l'exécution
  • test: Nécessaire uniquement pendant la compilation et l'exécution des tests
  • system: Semblable à provided, mais nécessite un chemin JAR explicite

3. Dépendances transitives

Lorsque le projet A dépend du projet B, et que le projet B dépend du projet C, Maven introduit automatiquement le projet C comme dépendance du projet A. Cette fonctionnalité de gestion automatique des dépendances est appelée dépendances transitives.

Les règles de transitivité dépendent du Scope :

Scope de dépendance actuel \ Scope de dépendance transitivecompileprovidedruntimetest
compilecompile-runtime-
providedprovidedprovidedprovided-
runtimeruntime-runtime-
test----

Comment utiliser les dépendances Maven dans les projets

1. Ajout de dépendances dans pom.xml

Dans le projet Mavenpom.xmlfichier,<dependencies>la section est utilisée pour déclarer les dépendances du projet :

Exemple

<dependencies>
    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-lang3</artifactId>
        <version>3.12.0</version>
    </dependency>
</dependencies>

2. Exclusions de dépendances

Parfois, vous pouvez avoir besoin d'exclure une dépendance transitive ; vous pouvez utiliser<exclusions>balise :

Exemple

<dependency>
    <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. Gestion des dépendances

Dans les projets multi-modules, vous pouvez utiliser dans le POM parent<dependencyManagement>pour gérer uniformément les versions des dépendances :

Exemple

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>5.3.20</version>
        </dependency>
    </dependencies>
</dependencyManagement>

Lorsque les modules enfants référencent des dépendances, ils n'ont besoin que de déclarer groupId et artifactId, sans spécifier la version.


Fonctionnalités avancées de la gestion des dépendances

Gestion des versions des dépendances

UtilisezdependencyManagementpour gérer uniformément les versions :

<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>

Import de BOM

Gérer les versions d'un ensemble de dépendances liées :

<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>

Dépendances facultatives

Marquer les dépendances comme optionnelles et non transitives :

<dependency>
    <groupId>com.example</groupId>
    <artifactId>optional-lib</artifactId>
    <version>1.0</version>
    <optional>true</optional>
</dependency>

Mécanisme de résolution des dépendances Maven

1. Médiation des dépendances

Lorsque des conflits de version surviennent, Maven les résout à l'aide des règles suivantes :

  1. La définition la plus proche l'emporte (la version dont le chemin est le plus court dans l'arbre des dépendances est sélectionnée)
  2. Si la longueur du chemin est identique, la dépendance déclarée en premier est prioritaire.

2. Impact de la portée des dépendances

Les dépendances ayant différentes portées affectent la transitivité :

  • les dépendances de portée compile sont transitives
  • les dépendances de portée provided et test ne sont pas transitives
  • les dépendances de portée runtime sont transitives avec la portée runtime

Résultats finaux d'empaquetage des dépendances ayant différentes portées :

PortéeS'il est empaquetéUtilisation typique
compileOuiDépendances principales
providednonFournies par le conteneur
runtimeOuiNécessaires à l'exécution
testnonTests unitaires

3. Dépendances facultatives

Les dépendances marquées comme facultatives ne sont pas transitives :

Exemple

<dependency>
    <groupId>com.example</groupId>
    <artifactId>optional-lib</artifactId>
    <version>1.0</version>
    <optional>true</optional>
</dependency>

Commandes liées aux dépendances

Afficher l'arbre des dépendances :

mvn dependency:tree

Analyser les problèmes de dépendances :

mvn dependency:analyze

Télécharger les dépendances dans le répertoire :

mvn dependency:copy-dependencies

Dépôt Maven

1. Types de dépôts

  • Dépôt local: Situé dans le répertoire personnel de l'utilisateur sous.m2/repositoryrépertoire
  • Dépôt central: Dépôt public par défaut de Maven
  • Dépôt distant: Un dépôt privé créé par une entreprise ou une organisation

2. Configuration des dépôts

Vous pouvez configurer danspom.xmlousettings.xmlconfigurer le dépôt :

Exemple

<repositories>
    <repository>
        <id>my-repo</id>
        <url>http://repo.example.com/maven2</url>
    </repository>
</repositories>

Bonnes pratiques

  1. Spécifiez explicitement les versions des dépendances: évitez d’utiliser des versions dynamiques telles que LATEST ou RELEASE
  2. Mettez régulièrement à jour les dépendances: Utilisezmvn versions:display-dependency-updatespour vérifier les mises à jour disponibles
  3. Utilisez un BOM: pour les frameworks volumineux (par ex. Spring), utilisez une nomenclature (Bill of Materials) pour gérer uniformément les versions
  4. Nettoyez les dépendances inutilisées: exécutez régulièrementmvn dependency:analyzepour vérifier les dépendances inutilisées
Autres extensions