Maven-POM
POM (Project Object Model) ist die zentrale Konfigurationsdatei von Maven im XML-Format, mit dem Standardnamenpom.xml。
POM ist die grundlegende Arbeitseinheit in einem Maven-Projekt. Es ist eine XML-Datei, die die grundlegenden Informationen des Projekts enthält und verwendet wird, um zu beschreiben, wie das Projekt erstellt wird, Projektabhängigkeiten zu deklarieren und so weiter.
Wenn Maven eine Aufgabe oder ein Ziel ausführt, sucht es im aktuellen Verzeichnis nach der POM, ruft die erforderlichen Konfigurationsinformationen ab und führt dann das Ziel aus.
In der POM können die folgenden Konfigurationen angegeben werden:
- Projektabhängigkeiten
- Plugins
- Ausführungsziele
- Projekt-Build-Profile
- Projektversion
- Liste der Projektentwickler
- Informationen zu den zugehörigen Mailinglisten
Bevor wir eine POM erstellen, müssen wir zuerst die Projektgruppe (groupId) beschreiben, die eindeutige ID des Projekts.
Alle POM-Dateien erfordern das project-Element und drei erforderliche Felder: groupId, artifactId und version.
| Knoten | Beschreibung |
|---|---|
| project | Das Wurzel-Tag des Projekts. |
| modelVersion | Die Modellversion muss auf 4.0 gesetzt werden. |
| groupId | Dies ist die Kennung der Projektgruppe. Sie ist normalerweise innerhalb einer Organisation oder eines Projekts eindeutig. Zum Beispiel besitzt eine Bankorganisation com.companyname.project-group alle bankbezogenen Projekte. |
| artifactId | Dies ist die Kennung des Projekts. Sie ist normalerweise der Name des Projekts. Zum Beispiel Consumer Banking. groupId und artifactId definieren zusammen den Speicherort des Artefakts im Repository. |
| version |
Dies ist die Versionsnummer des Projekts. Im Artefakt-Repository wird sie verwendet, um verschiedene Versionen zu unterscheiden. Zum Beispiel: com.company.bank:consumer-banking:1.0 com.company.bank:consumer-banking:1.1 |
Grundstruktur einer POM-Datei:
Beispiel
<!-- 1. Basisinformationen-->
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>my-app</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<!-- 2. Metainformationen-->
<name>Meine Anwendung</name>
<description>Ein Demo-Projekt</description>
<url>https://example.com</url>
<!-- 3. Abhängigkeitsverwaltung-->
<Abhängigkeiten>...</Abhängigkeiten>
<!-- 4. Build-Konfiguration-->
<Build>...</Build>
<!-- 5. Umgebungskonfiguration-->
<Eigenschaften>...</Eigenschaften>
<Repositories>...</Repositories>
</project>
Projektkoordinaten (erforderlich):
| Element | Beschreibung | Beispiel |
|---|---|---|
modelVersion | POM-Modellversion (fest4.0.0) | <modelVersion>4.0.0</modelVersion> |
groupId | Organisations-/Unternehmensbezeichner (umgekehrter Domainname) | <groupId>com.example</groupId> |
artifactId | Projekt | <artifactId>my-app</artifactId> |
version | Projektversion | <version>1.0.0</version> |
packaging | Packaging-Typ (jar/war/pom) | <packaging>jar</packaging> |
Metainformationen (optional):
| Element | Beschreibung |
|---|---|
name | Projektname (zur Anzeige) |
description | Projektbeschreibung |
url | Projekt-Homepage |
licenses | Lizenzinformationen |
organization | Organisationsinformationen |
Beispiel
<description>Ein Demo-Projekt für das Erlernen von Maven</description>
<url>https://github.com/example/my-app</url>
Abhängigkeitsverwaltung
Abhängigkeiten des Projekts können in der POM-Datei definiert werden:
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>| Element | Beschreibung |
|---|---|
groupId | Der Organisationsbezeichner der Abhängigkeit |
artifactId | Der Projektname der Abhängigkeit |
version | Die Version der Abhängigkeit |
scope | Abhängigkeitsbereich (compile/test/provided/runtime) |
optional | Ob es sich um eine optionale Abhängigkeit handelt (Standardfalse) |
Plugin-Verwaltung
Plugins, die während des Build-Prozesses verwendet werden, können ebenfalls in der POM-Datei definiert werden:
<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>Gängige Plugins:
maven-compiler-plugin: Java-Version angebenmaven-surefire-plugin: Testausführung steuernmaven-jar-plugin: JAR-Paket anpassen
Weitere häufige Elemente
properties: Definieren Sie einige Eigenschaftsvariablen im Projekt.
Wird verwendet, um Variablen zu definieren und Duplizierung zu vermeiden:
<properties>
<java.version>11</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>Referenz in Abhängigkeiten:
<version>${java.version}</version>
repositories: Repository-Konfiguration.
Remote-Repository angeben:
<repositories>
<repository>
<id>aliyun</id>
<url>https://maven.aliyun.com/repository/public</url>
</repository>
</repositories>
dependencyManagement: Wird verwendet, um Abhängigkeitsversionen zu verwalten, insbesondere in Multi-Modul-Projekten.
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>5.3.9</version>
</dependency>
</dependencies>
</dependencyManagement>profiles: Wird verwendet, um verschiedene Build-Konfigurationen zu definieren, sodass Builds entsprechend unterschiedlichen Umgebungen ausgeführt werden können.
<profiles>
<profile>
<id>development</id>
<properties>
<environment>dev</environment>
</properties>
</profile>
<profile>
<id>production</id>
<properties>
<environment>prod</environment>
</properties>
</profile>
</profiles>
Vererbung und Aggregation
Vererbung:Durch das parent-Element kann eine POM-Datei die Konfiguration einer anderen POM-Datei erben:
<parent>
<groupId>com.example</groupId>
<artifactId>parent-project</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>Aggregation:Über das modules-Element kann eine POM-Datei mehrere Submodule verwalten:
<modules>
<module>module1</module>
<module>module2</module>
</modules>Vollständiges Beispiel
Ein einfaches Beispiel für ein vollständiges POM:
Beispiel
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>my-app</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<name>Meine Anwendung</name>
<description>Ein Demo-Projekt</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>
Parent-(Super-)POM
Das Parent-(Super-)POM ist das Standard-POM von Maven. Alle POMs erben von einem Parent-POM (unabhängig davon, ob dieses Parent-POM explizit definiert ist). Das Parent-POM enthält Standardeinstellungen, die geerbt werden können. Wenn Maven daher feststellt, dass es eine Abhängigkeit im POM herunterladen muss, lädt es sie aus dem im Super-POM konfigurierten Standard-Repository http://repo1.maven.org/maven2 herunter.
Maven verwendet das effektive POM (das Super-POM plus die eigene Konfiguration des Projekts), um zugehörige Ziele auszuführen. Es hilft Entwicklern, so wenige Konfigurationen wie möglich in pom.xml vorzunehmen, aber natürlich können diese Konfigurationen überschrieben werden.
Verwenden Sie den folgenden Befehl, um die Standardkonfiguration des Super-POM anzuzeigen:
mvn help:effective-pom
Als Nächstes erstellen wir das Verzeichnis MVN/project und legen darin pom.xml mit folgendem Inhalt an:
Wechseln Sie in der Befehlskonsole in das Verzeichnis MVN/project und führen Sie den folgenden Befehl aus:
C:\MVN\project>mvn help:effective-pom
Maven wird mit der Verarbeitung beginnen und die effective-pom anzeigen.
[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] ------------------------------------------------------------------------
Die resultierende effektive POM ist wie in der Konsole dargestellt; nach Vererbung und Interpolation wird die Konfiguration wirksam.
In der obigen pom.xml können Sie die Standard-Projektquellverzeichnisstruktur, das Ausgabeverzeichnis, die erforderlichen Plugins, Repositories und Berichtsverzeichnisse sehen, die Maven beim Ausführen von Zielen benötigt.
Die pom.xml-Datei von Maven muss nicht manuell geschrieben werden.
Maven bietet eine große Anzahl von Archetyp-Plugins zum Erstellen von Projekten, einschließlich der Projektstruktur und pom.xml.
Detaillierte Erklärung der POM-Tags
Das Folgende ist eine kategorisierte Erklärung aller wichtigen Tags in pom.xml, die Kerninhalte wie Projektinformationen, Abhängigkeitsverwaltung, Build-Konfiguration und Umgebungseinstellungen abdeckt.
Tags, die alle POM-Dateien enthalten müssen:modelVersion, groupId, artifactId und version。
| Tag | Kategorie | Beschreibung | Beispiel/optionale Werte | Ob erforderlich |
|---|---|---|---|---|
| Basisinformationen | ||||
<modelVersion> |
Projektstruktur | POM-Modellversion | 4.0.0 |
Ja |
<groupId> |
Koordinaten | Organisationskennung (umgekehrter Domänenname) | com.example |
Ja |
<artifactId> |
Koordinaten | Projekt | my-project |
Ja |
<version> |
Koordinaten | Projektversion | 1.0.0-SNAPSHOT |
Ja |
<packaging> |
Projekttyp | Packaging-Format | jar/war/pom |
Nein (standardmäßig jar) |
<name> |
Metainformationen | Anzeigename des Projekts | My Application |
nein |
<description> |
Metainformationen | Projektbeschreibung | A demo project |
nein |
<url> |
Metainformationen | Projekt-Homepage-URL | https://example.com |
nein |
| Abhängigkeitsverwaltung | ||||
<dependencies> |
Abhängigkeit | Abhängigkeitslisten-Container | Enthält mehrere<dependency> |
nein |
<dependency> |
Abhängigkeit | Einzelne Abhängigkeitsdefinition | EnthältgroupIdund andere Unter-Tags |
Optional |
<scope> |
Abhängigkeit | Abhängigkeitsbereich | compile/test/provided/runtime |
Nein (Standard: compile) |
<optional> |
Abhängigkeit | Ob optionale Abhängigkeit | true/false |
Nein (Standard: false) |
<exclusions> |
Abhängigkeit | Transitive Abhängigkeiten ausschließen | Enthält<exclusion>Liste |
nein |
| Build-Konfiguration | ||||
<build> |
Build | Build-Konfigurationscontainer | Enthält Plugin-/Ressourcenkonfigurationen usw. | nein |
<plugins> |
Build | Plugin-Listencontainer | Enthält mehrere<plugin> |
nein |
<plugin> |
Build | Einzelne Plugin-Definition | Muss angegeben werdengroupIdundartifactId |
Optional |
<resources> |
Build | Ressourcendatei-Konfiguration | Definition<resource>Pfad |
nein |
<testResources> |
Build | Testressourcendatei-Konfiguration | Ähnlich<resources> |
nein |
<finalName> |
Build | Name der endgültigen Paketdatei | my-app |
nein |
| Umgebungskonfiguration | ||||
<properties> |
Konfiguration | Container für benutzerdefinierte Variablen | Definiert Schlüssel-Wert-Paare | nein |
<java.version> |
Eigenschaften | Java-Version-Variable | 11/17warten |
nein |
<repositories> |
Repositorys | Liste benutzerdefinierter Remote-Repositorys | Enthält<repository> |
nein |
<pluginRepositories> |
Repository | Benutzerdefiniertes Plugin-Repository | Ähnlich<repositories> |
nein |
| Multi-Modul-Verwaltung | ||||
<modules> |
Module | Submodul-Liste | Enthält mehrere<module> |
Erforderlich für Aggregator-Projekte |
<parent> |
Vererben | Parent-POM-Referenz | Muss die Koordinaten des Parent-Projekts angeben | Erforderlich für geerbte Projekte |
<dependencyManagement> |
Abhängigkeiten | Abhängigkeitsversionen zentral verwalten | Definiert Versionen, führt sie aber nicht ein | nein |
<profiles> |
Konfiguration | Umgebungsprofil-Container | Definiert verschiedene Umgebungskonfigurationen | nein |
| Weitere Informationen | ||||
<licenses> |
Rechtliches | Lizenzinformationen | Enthält<license> |
nein |
<developers> |
Personen | Entwicklerliste | Enthält<developer> |
nein |
<contributors> |
Personen | Mitwirkendenliste | Ähnlich<developers> |
nein |
<issueManagement> |
Management | Issue-Tracking-System | Definiert die URL des Issue-Systems | nein |