Maven POM
POM (Project Object Model, Modelo de Objetos de Proyecto) es el archivo de configuración central de Maven, en formato XML, con el nombre predeterminadopom.xml。
El POM es la unidad básica de trabajo del proyecto Maven. Es un archivo XML que contiene la información básica del proyecto, se utiliza para describir cómo se construye el proyecto, declarar dependencias del proyecto, etc.
Al ejecutar tareas u objetivos, Maven busca el POM en el directorio actual, obtiene la información de configuración necesaria y luego ejecuta el objetivo.
En el POM se pueden especificar las siguientes configuraciones:
- Dependencias del proyecto
- Plugins
- Objetivos de ejecución
- Perfiles de compilación del proyecto
- Versión del proyecto
- Lista de desarrolladores del proyecto
- Información de listas de correo relacionadas
Antes de crear el POM, primero necesitamos describir el grupo del proyecto (groupId), el identificador único del proyecto.
Todos los archivos POM requieren el elemento project y tres campos obligatorios: groupId, artifactId y version.
| Nodo | Descripción |
|---|---|
| project | Etiqueta raíz del proyecto. |
| modelVersion | La versión del modelo debe establecerse en 4.0. |
| groupId | Es el identificador del grupo del proyecto. Suele ser único dentro de una organización o proyecto. Por ejemplo, una organización bancaria com.companyname.project-group tiene todos los proyectos relacionados con la banca. |
| artifactId | Es el identificador del proyecto. Suele ser el nombre del proyecto. Por ejemplo, banco de consumo. groupId y artifactId juntos definen la ubicación del artefacto en el repositorio. |
| version |
Es el número de versión del proyecto. En el repositorio de artefactos, se utiliza para distinguir diferentes versiones. Por ejemplo: com.company.bank:consumer-banking:1.0 com.company.bank:consumer-banking:1.1 |
Estructura básica del archivo POM:
Ejemplo
<!-- 1. Información básica-->
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>my-app</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<!-- 2. Metainformación-->
<name>My Application</name>
<description>A demo project</description>
<url>https://example.com</url>
<!-- 3. Gestión de dependencias-->
<dependencies>...</dependencies>
<!-- 4. Configuración de compilación-->
<build>...</build>
<!-- 5. Configuración del entorno-->
<properties>...</properties>
<repositories>...</repositories>
</project>
Coordenadas del proyecto (obligatorio):
| Elemento | Descripción | Ejemplo |
|---|---|---|
modelVersion | Versión del modelo POM (fija4.0.0) | <modelVersion>4.0.0</modelVersion> |
groupId | Identificador de organización/empresa (dominio inverso) | <groupId>com.example</groupId> |
artifactId | Nombre del proyecto | <artifactId>my-app</artifactId> |
version | Versión del proyecto | <version>1.0.0</version> |
packaging | Tipo de empaquetado (jar/war/pom) | <packaging>jar</packaging> |
Metainformación (opcional):
| Elemento | Descripción |
|---|---|
name | Nombre del proyecto (para mostrar) |
description | Descripción del proyecto |
url | Página principal del proyecto |
licenses | Información de la licencia |
organization | Información de la organización |
Ejemplo
<description>A demo project for learning Maven</description>
<url>https://github.com/example/my-app</url>
Gestión de dependencias
En el archivo POM se pueden definir las dependencias del proyecto:
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>| Elemento | Descripción |
|---|---|
groupId | Identificador de la organización de la dependencia |
artifactId | Nombre del proyecto de la dependencia |
version | Versión de la dependencia |
scope | Alcance de la dependencia (compile/test/provided/runtime) |
optional | Si es dependencia opcional (por defectofalse) |
Gestión de plugins
En el archivo POM también se pueden definir plugins para el proceso de compilación:
<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 comunes:
maven-compiler-plugin: especifica la versión de Javamaven-surefire-plugin: controla la ejecución de pruebasmaven-jar-plugin: personaliza el paquete JAR
Otros elementos comunes
properties: define algunas variables de propiedades en el proyecto.
Se utiliza para definir variables y evitar repeticiones:
<properties>
<java.version>11</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>Referenciar en las dependencias:
<version>${java.version}</version>
repositories: Configuración de repositorio.
Especificar repositorio remoto:
<repositories>
<repository>
<id>aliyun</id>
<url>https://maven.aliyun.com/repository/public</url>
</repository>
</repositories>
dependencyManagement: se utiliza para gestionar las versiones de las dependencias, especialmente en proyectos multimódulo.
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>5.3.9</version>
</dependency>
</dependencies>
</dependencyManagement>profiles: se utiliza para definir diferentes configuraciones de compilación, permitiendo compilar según distintos entornos.
<profiles>
<profile>
<id>development</id>
<properties>
<environment>dev</environment>
</properties>
</profile>
<profile>
<id>production</id>
<properties>
<environment>prod</environment>
</properties>
</profile>
</profiles>
Herencia y agregación
Herencia:Mediante el elemento parent, un archivo POM puede heredar la configuración de otro archivo POM:
<parent>
<groupId>com.example</groupId>
<artifactId>parent-project</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>Agregación:Mediante el elemento modules, un archivo POM puede gestionar varios submódulos:
<modules>
<module>module1</module>
<module>module2</module>
</modules>Ejemplo completo
Ejemplo sencillo de un POM completo:
Ejemplo
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>my-app</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<name>My Application</name>
<description>A demo project</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 padre (Super POM)
El POM padre (Super POM) es el POM predeterminado de Maven. Todos los POM heredan de un POM padre (esté o no definido explícitamente). El POM padre contiene algunos ajustes predeterminados que pueden heredarse. Por lo tanto, cuando Maven detecta que necesita descargar dependencias del POM, va al repositorio predeterminado configurado en el Super POM, http://repo1.maven.org/maven2, para descargarlas.
Maven utiliza el POM efectivo (Super POM más la configuración propia del proyecto) para ejecutar los objetivos correspondientes. Esto ayuda a los desarrolladores a realizar la menor configuración posible en pom.xml; por supuesto, estas configuraciones pueden sobrescribirse.
Utilice el siguiente comando para ver la configuración predeterminada del Super POM:
mvn help:effective-pom
A continuación creamos el directorio MVN/project, y en ese directorio creamos pom.xml con el siguiente contenido:
En la consola de comandos, entre al directorio MVN/project y ejecute el siguiente comando:
C:\MVN\project>mvn help:effective-pom
Maven comenzará a procesar y mostrará el 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] ------------------------------------------------------------------------
El resultado del Effective POM, tal como se muestra en la consola, hace efectiva la configuración después de la herencia e interpolación.
En el pom.xml anterior, puede ver la estructura de directorios de código fuente del proyecto predeterminada, los directorios de salida, los plugins necesarios, los repositorios y los directorios de informes que Maven necesita al ejecutar objetivos.
El archivo pom.xml de Maven tampoco necesita escribirse manualmente.
Maven proporciona una gran cantidad de plugins de arquetipo para crear proyectos, incluyendo la estructura del proyecto y pom.xml.
Referencia completa de etiquetas del POM
A continuación se presenta una explicación clasificada de todas las etiquetas importantes en pom.xml, que cubre contenido central como información del proyecto, gestión de dependencias, configuración de compilación, configuración del entorno, etc.
Etiquetas que todos los archivos POM deben contener:modelVersion, groupId, artifactId y version。
| Etiqueta | Categoría | Descripción | Ejemplo/Valores opcionales | ¿Es obligatorio? |
|---|---|---|---|---|
| Información básica | ||||
<modelVersion> |
Estructura del proyecto | Versión del modelo POM | 4.0.0 |
Sí |
<groupId> |
Coordenadas | Identificador de organización (dominio inverso) | com.example |
Sí |
<artifactId> |
Coordenadas | Nombre del proyecto | my-project |
Sí |
<version> |
Coordenadas | Versión del proyecto | 1.0.0-SNAPSHOT |
Sí |
<packaging> |
Tipo de proyecto | Formato de empaquetado | jar/war/pom |
No (por defecto jar) |
<name> |
Metainformación | Nombre para mostrar del proyecto | My Application |
no |
<description> |
Metainformación | Descripción del proyecto | A demo project |
no |
<url> |
Metainformación | URL de la página principal del proyecto | https://example.com |
no |
| Gestión de dependencias | ||||
<dependencies> |
Dependencias | Contenedor de lista de dependencias | Contiene múltiples<dependency> |
no |
<dependency> |
dependencias | Definición de una dependencia individual | ContienegroupIdsubetiquetas como |
Opcional |
<scope> |
Dependencia | Alcance de la dependencia | compile/test/provided/runtime |
No (por defecto compile) |
<optional> |
Dependencia | Si es dependencia opcional | true/false |
No (por defecto false) |
<exclusions> |
Dependencia | Excluir dependencias transitivas | Contiene<exclusion>Lista |
no |
| Configuración de construcción | ||||
<build> |
Construcción | Contenedor de configuración de construcción | Contiene configuración de complementos/recursos, etc. | no |
<plugins> |
Construcción | Contenedor de lista de complementos | Contiene varios<plugin> |
no |
<plugin> |
Construcción | Definición de un complemento individual | Debe especificarsegroupIdyartifactId |
Opcional |
<resources> |
Construcción | Configuración de archivos de recursos | Definición<resource>Ruta |
no |
<testResources> |
Construcción | Configuración de archivos de recursos de prueba | Similar<resources> |
no |
<finalName> |
Construcción | Nombre final del archivo empaquetado | my-app |
no |
| Configuración de entorno | ||||
<properties> |
Configuración | Contenedor de variables personalizadas | Define pares clave-valor | no |
<java.version> |
Propiedades | Variable de versión de Java | 11/17esperar |
no |
<repositories> |
Repositorio | Lista de repositorios remotos personalizados | Contiene<repository> |
no |
<pluginRepositories> |
Repositorio | Repositorio de complementos personalizado | Similar<repositories> |
no |
| Gestión de múltiples módulos | ||||
<modules> |
Módulo | Lista de submódulos | Contiene varios<module> |
Necesario para proyectos agregadores |
<parent> |
Herencia | Referencia al POM padre | Debe especificar las coordenadas del proyecto padre | Necesario para proyectos que heredan |
<dependencyManagement> |
Dependencias | Gestionar versiones de dependencias de forma unificada | Define versiones pero no las introduce | no |
<profiles> |
Configuración | Contenedor de perfiles de entorno | Define configuraciones para diferentes entornos | no |
| Otra información | ||||
<licenses> |
Legal | Información de licencia | Contiene<license> |
no |
<developers> |
Personas | Lista de desarrolladores | Contiene<developer> |
no |
<contributors> |
Personas | Lista de contribuyentes | Similar<developers> |
no |
<issueManagement> |
Gestión | Sistema de seguimiento de incidencias | Define la URL del sistema de incidencias | no |