POM Maven
POM (modèle d'objet de projet) est le fichier de configuration central de Maven, au format XML, dont le nom par défaut estpom.xml。
POM est l'unité de travail de base d'un projet Maven. C'est un fichier XML qui contient les informations de base du projet, utilisé pour décrire comment le projet est construit, déclarer les dépendances du projet, etc.
Lors de l'exécution d'une tâche ou d'un objectif, Maven recherche le POM dans le répertoire courant, obtient les informations de configuration requises, puis exécute l'objectif.
Les configurations suivantes peuvent être spécifiées dans le POM :
- Dépendances du projet
- Plugins
- Objectifs d'exécution
- Profils de construction du projet
- Version du projet
- Liste des développeurs du projet
- Informations relatives à la liste de diffusion
Avant de créer un POM, nous devons d'abord décrire le groupe de projet (groupId), l'identifiant unique du projet.
Tous les fichiers POM exigent l'élément project et trois champs obligatoires : groupId, artifactId et version.
| Nœud | Description |
|---|---|
| project | La balise racine du projet. |
| modelVersion | La version du modèle doit être définie sur 4.0. |
| groupId | Il s'agit de l'identifiant du groupe de projets. Il est généralement unique au sein d'une organisation ou d'un projet. Par exemple, une organisation bancaire com.companyname.project-group possède tous les projets liés aux activités bancaires. |
| artifactId | Il s'agit de l'identifiant du projet. Il s'agit généralement du nom du projet. Par exemple, Consumer Banking. groupId et artifactId définissent ensemble l'emplacement de l'artefact dans le dépôt. |
| version |
Il s'agit du numéro de version du projet. Dans le dépôt d'artefacts, il sert à distinguer les différentes versions. Par exemple : com.company.bank:consumer-banking:1.0 com.company.bank:consumer-banking:1.1 |
Structure de base d'un fichier POM :
Exemple
<!-- 1. Informations de base-->
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>my-app</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<!-- 2. Méta-informations-->
<name>Mon application</name>
<description>Un projet de démonstration</description>
<url>https://example.com</url>
<!-- 3. Gestion des dépendances-->
<dépendances>...</dépendances>
<!-- 4. Configuration de build-->
<build>...</build>
<!-- 5. Configuration de l'environnement-->
<propriétés>...</propriétés>
<dépôts>...</dépôts>
</project>
Coordonnées du projet (obligatoire):
| Élément | Description | Exemple |
|---|---|---|
modelVersion | Version du modèle POM (fixe4.0.0) | <modelVersion>4.0.0</modelVersion> |
groupId | Identifiant de l'organisation/de l'entreprise (nom de domaine inversé) | <groupId>com.example</groupId> |
artifactId | Nom du projet | <artifactId>my-app</artifactId> |
version | Version du projet | <version>1.0.0</version> |
packaging | Type de packaging (jar/war/pom) | <packaging>jar</packaging> |
Méta-informations (facultatif):
| Élément | Description |
|---|---|
name | Nom du projet (pour l'affichage) |
description | Description du projet |
url | Page d'accueil du projet |
licenses | Informations sur la licence |
organization | Informations sur l'organisation |
Exemple
<description>Un projet de démonstration pour apprendre Maven</description>
<url>https://github.com/example/my-app</url>
Gestion des dépendances
Les dépendances du projet peuvent être définies dans le fichier POM :
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>| Élément | Description |
|---|---|
groupId | L'identifiant d'organisation de la dépendance |
artifactId | Le nom du projet de la dépendance |
version | La version de la dépendance |
scope | Portée de la dépendance (compile/test/provided/runtime) |
optional | S'il s'agit d'une dépendance optionnelle (par défautfalse) |
Gestion des plugins
Les plugins utilisés pendant le processus de build peuvent également être définis dans le fichier POM :
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
</plugins>
</build>Plugins courants :
maven-compiler-plugin: Spécifier la version de Javamaven-surefire-plugin: Contrôler l'exécution des testsmaven-jar-plugin: Personnaliser le paquet JAR
Autres éléments courants
properties: Définir des variables de propriété dans le projet.
Utilisé pour définir des variables et éviter la duplication :
<properties>
<java.version>11</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>Référence dans les dépendances :
<version>${java.version}</version>
repositories: Configuration du dépôt.
Spécifier le dépôt distant :
<repositories>
<repository>
<id>aliyun</id>
<url>https://maven.aliyun.com/repository/public</url>
</repository>
</repositories>
dependencyManagement: Utilisé pour gérer les versions des dépendances, en particulier dans les projets multi-modules.
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>5.3.9</version>
</dependency>
</dependencies>
</dependencyManagement>profiles: Utilisé pour définir différentes configurations de build, permettant d'effectuer des builds en fonction de différents environnements.
<profiles>
<profile>
<id>development</id>
<properties>
<environment>dev</environment>
</properties>
</profile>
<profile>
<id>production</id>
<properties>
<environment>prod</environment>
</properties>
</profile>
</profiles>
Héritage et agrégation
Héritage :Grâce à l'élément parent, un fichier POM peut hériter de la configuration d'un autre fichier POM :
<parent>
<groupId>com.example</groupId>
<artifactId>parent-project</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>Agrégation :Grâce à l'élément modules, un fichier POM peut gérer plusieurs sous-modules :
<modules>
<module>module1</module>
<module>module2</module>
</modules>Exemple complet
Un exemple simple d'un POM complet :
Exemple
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>my-app</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<name>Mon application</name>
<description>Un projet de démonstration</description>
<properties>
<java.version>11</java.version>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
</configuration>
</plugin>
</plugins>
</build>
</project>
POM parent (Super POM)
Le POM parent (Super POM) est le POM par défaut de Maven. Tous les POM héritent d'un POM parent (que ce POM parent soit explicitement défini ou non). Le POM parent contient des paramètres par défaut qui peuvent être hérités. Par conséquent, lorsque Maven constate qu'il doit télécharger une dépendance dans le POM, il la téléchargera depuis le dépôt par défaut http://repo1.maven.org/maven2 configuré dans le Super POM.
Maven utilise le POM effectif (le Super POM plus la configuration propre du projet) pour exécuter les objectifs associés. Cela aide les développeurs à faire le moins de configurations possible dans pom.xml, mais bien sûr ces configurations peuvent être surchargées.
Utilisez la commande suivante pour afficher la configuration par défaut du Super POM :
mvn help:effective-pom
Ensuite, nous créons le répertoire MVN/project, et créons pom.xml dans ce répertoire, avec le contenu suivant :
Dans la console de commandes, placez-vous dans le répertoire MVN/project et exécutez la commande suivante :
C:\MVN\project>mvn help:effective-pom
Maven commencera le traitement et affichera effective-pom.
[INFO] Scanning for projects... Downloading: https://repo.maven.apache.org/maven2/org/apache/maven/plugins/maven-clean-plugin/2.5/maven-clean-plugin-2.5.pom ... [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 01:36 min [INFO] Finished at: 2018-09-05T11:31:28+08:00 [INFO] Final Memory: 15M/149M [INFO] ------------------------------------------------------------------------
Le POM effectif résultant est tel qu'affiché dans la console ; après héritage et interpolation, la configuration prend effet.
Dans le pom.xml ci-dessus, vous pouvez voir la structure par défaut des répertoires sources du projet, le répertoire de sortie, les plugins requis, les dépôts et les répertoires de rapports dont Maven a besoin lors de l'exécution des objectifs.
Le fichier pom.xml de Maven n'a pas besoin d'être écrit manuellement.
Maven fournit un grand nombre de plugins d'archétypes pour créer des projets, y compris la structure du projet et le pom.xml.
Explication détaillée des balises POM
Ce qui suit est une explication catégorisée de toutes les balises importantes dans pom.xml, couvrant le contenu principal tel que les informations du projet, la gestion des dépendances, la configuration de build et les paramètres d'environnement.
Balises que tous les fichiers POM doivent contenir :modelVersion, groupId, artifactId, et version。
| Balise | Catégorie | Description | Exemples/Valeurs facultatives | Obligatoire ou non |
|---|---|---|---|---|
| Informations de base | ||||
<modelVersion> |
Structure du projet | Version du modèle POM | 4.0.0 |
Oui |
<groupId> |
Coordonnées | Identifiant de l'organisation (nom de domaine inversé) | com.example |
Oui |
<artifactId> |
Coordonnées | Nom du projet | my-project |
Oui |
<version> |
Coordonnées | Version du projet | 1.0.0-SNAPSHOT |
Oui |
<packaging> |
Type de projet | Format de packaging | jar/war/pom |
Non (jar par défaut) |
<name> |
Méta-informations | Nom d'affichage du projet | My Application |
non |
<description> |
Méta-informations | Description du projet | A demo project |
non |
<url> |
Méta-informations | URL de la page d'accueil du projet | https://example.com |
non |
| Gestion des dépendances | ||||
<dependencies> |
Dépendance | Conteneur de la liste de dépendances | Contient plusieurs<dependency> |
non |
<dependency> |
Dépendance | Définition d'une seule dépendance | ContientgroupIdet autres sous-balises |
Optional |
<scope> |
Dépendance | Portée de dépendance | compile/test/provided/runtime |
Non (compile par défaut) |
<optional> |
Dépendance | Indique si la dépendance est facultative | true/false |
Non (false par défaut) |
<exclusions> |
Dépendance | Exclure les dépendances transitives | Contient<exclusion>Liste |
non |
| Configuration de build | ||||
<build> |
Construction | Conteneur de configuration de build | Contient les configurations de plugin/ressource, etc. | non |
<plugins> |
Construction | Conteneur de liste de plugins | Contient plusieurs<plugin> |
non |
<plugin> |
Construction | Définition d'un plugin unique | Doit spécifiergroupIdetartifactId |
Optional |
<resources> |
Construction | Configuration du fichier de ressources | Définition<resource>Chemin |
non |
<testResources> |
Construction | Configuration du fichier de ressources de test | Similaire<resources> |
non |
<finalName> |
Construction | Nom du fichier de packaging final | my-app |
non |
| Configuration de l'environnement | ||||
<properties> |
Configuration | Conteneur de variables personnalisées | Définit des paires clé-valeur | non |
<java.version> |
Propriétés | Variable de version Java | 11/17wait |
non |
<repositories> |
Dépôts | Liste des dépôts distants personnalisés | Contient<repository> |
non |
<pluginRepositories> |
Dépôt | Dépôt de plugins personnalisé | Similaire<repositories> |
non |
| Gestion multi-module | ||||
<modules> |
Modules | Liste des sous-modules | Contient plusieurs<module> |
Requis pour les projets agrégateurs |
<parent> |
Hériter | Référence du POM parent | Doit spécifier les coordonnées du projet parent | Requis pour les projets hérités |
<dependencyManagement> |
Dépendances | Gérer centralement les versions des dépendances | Définit les versions mais ne les introduit pas | non |
<profiles> |
Configuration | Conteneur de profils d'environnement | Définit différentes configurations d'environnement | non |
| Autres informations | ||||
<licenses> |
Juridique | Informations sur la licence | Contient<license> |
non |
<developers> |
Personnes | Liste des développeurs | Contient<developer> |
non |
<contributors> |
Personnes | Liste des contributeurs | Similaire<developers> |
non |
<issueManagement> |
Gestion | Système de suivi des problèmes | Définit l'URL du système de suivi des problèmes | non |