pom文件详解

亦凉 2023-10-09 16:09 44阅读 0赞

#### pom文件详解 ####

*  前言
 *  什么是POM文件？
 *  POM文件的基本结构
 *  POM文件的常用配置项
 *   *  1. 坐标信息
     *  2. 依赖项配置
     *  3.构建配置
     *  4. 插件配置
     *  5. 仓库配置
 *  父子pom
 *   *  父POM
     *  子POM
     *  父子POM的优点
     *  父子POM的使用
 *  总结

## 前言 ##

上文我们介绍了[maven的setting文件][maven_setting]。今天我们来总结一下，maven中另一个重要文件，pom文件。

## 什么是POM文件？ ##

POM（Project Object Model）文件是Maven项目的核心文件之一。它是一个XML文件，描述了项目的基本信息、依赖项、构建和发布等信息。POM文件是Maven的重要组成部分，可以帮助开发者管理和构建项目。在使用Maven进行项目构建时，需要根据项目的需要配置POM文件。

## POM文件的基本结构 ##

POM文件是一个XML文件，包含多个元素，每个元素代表一个特定的配置项。下面是一个POM文件的基本结构：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
             http://maven.apache.org/maven-v4_0_0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.example</groupId>
        <artifactId>example-project</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <dependencies>
            
        </dependencies>
    
        <build>
            
        </build>
    
        <repositories>
            
        </repositories>
    </project>

POM文件的根元素是·`<project>`，它包含了多个子元素。其中`<modelVersion>`元素指定了POM文件的版本，通常设置为4.0.0。`<groupId>`、`<artifactId>`和`<version>`元素是必需的，它们用于定义项目的坐标信息。`<dependencies>`、`<build>`和`<repositories>`元素用于配置依赖项、构建和仓库信息。

## POM文件的常用配置项 ##

### 1. 坐标信息 ###

坐标信息指的是`<groupId>、<artifactId>`和`<version>`元素。`<groupId>`定义了项目的组织ID，`<artifactId>`定义了项目的唯一标识符，`<version>`定义了项目的版本号。这些信息对于Maven的依赖管理和构建过程非常重要。

<groupId>com.example</groupId>
    <artifactId>example-project</artifactId>
    <version>1.0-SNAPSHOT</version>

### 2. 依赖项配置 ###

依赖项配置用于定义项目所依赖的外部库。Maven会自动下载并管理这些依赖项。依赖项配置包含在`<dependencies>`元素中，每个依赖项使用一个`<dependency>`元素进行描述。

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

### 3.构建配置 ###

构建配置用于定义项目的构建过程。它包含在`<build>`元素中，包括了多个子元素。其中比较常用的子元素有：

### 4. 插件配置 ###

插件是Maven的一个重要特性，它可以用于扩展Maven的功能。Maven自带了一些插件，比如maven-compiler-plugin、maven-jar-plugin等。插件配置包含在`<plugins>`元素中，每个插件使用一个`<plugin>`元素进行描述。

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

### 5. 仓库配置 ###

仓库配置用于定义Maven的依赖项下载地址。Maven默认使用中央仓库，但是也可以配置私有仓库或者本地仓库。仓库配置包含在`<repositories>`元素中，每个仓库使用一个`<repository>`元素进行描述。

<repositories>
        <repository>
            <id>central</id>
            <url>https://repo.maven.apache.org/maven2</url>
        </repository>
    </repositories>

## 父子pom ##

父子POM是Maven中一个重要的概念。在Maven项目中，我们通常会使用父子POM的方式来管理项目的依赖、构建和打包方式等。

### 父POM ###

父POM是指一个Maven项目中的顶层POM文件。父POM文件可以被多个子模块所继承，子模块可以继承父POM中的配置信息。在父POM中通常包含一些基本的配置信息，如项目的坐标、开发者信息、构建配置等。父POM文件通常被命名为pom.xml，并且不包含任何代码。

<project>
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.example.parent</groupId>
      <artifactId>parent</artifactId>
      <version>1.0.0</version>
      <packaging>pom</packaging>
    
      <modules>
        <module>child1</module>
        <module>child2</module>
      </modules>
    
      <dependencies>
        
      </dependencies>
    
      <build>
        
      </build>
    </project>

### 子POM ###

子POM是指一个Maven项目中的子模块POM文件。子模块可以继承父POM中的配置信息，同时也可以覆盖或者新增一些配置信息。子模块POM文件通常包含项目的代码、测试代码、资源文件等信息。子POM文件的命名通常是根据项目的名称来命名的，比如example-web、example-service等。

<project>
      <parent>
        <groupId>com.example.parent</groupId>
        <artifactId>parent</artifactId>
        <version>1.0.0</version>
      </parent>
    
      <modelVersion>4.0.0</modelVersion>
      <artifactId>child1</artifactId>
      <packaging>jar</packaging>
    
      <dependencies>
        
      </dependencies>
    
      <build>
        
      </build>
    </project>

### 父子POM的优点 ###

1.  继承：父POM中的配置信息可以被子模块所继承，这样可以避免重复配置，提高配置的可维护性。
2.  一致性：通过父POM可以统一管理子模块的依赖、构建和打包方式等，保证各个子模块之间的一致性。
3.  可扩展性：在父POM中定义一些通用的配置信息，可以为后续的新子模块提供一些默认配置，提高了可扩展性。

### 父子POM的使用 ###

在Maven项目中使用父子POM的方式很简单，只需要在子模块的POM文件中声明父POM即可。

在上面的例子中，子模块child1的POM文件中声明了父POM文件的信息，包括groupId、artifactId和version。  
在实际开发中，通常会将父POM文件和子模块的POM文件分开管理，并将父POM文件上传到Maven仓库中。  
这样其他开发者在开发新的子模块时就可以使用已有的父POM文件，避免重复配置，提高了开发效率。

## 总结 ##

POM文件是Maven项目的核心文件之一，它包含了Maven项目的所有配置信息。  
父子POM是Maven中一个重要的概念，使用父子POM的方式可以提高项目的可维护性、一致性和可扩展性。  
在实际开发中，我们可以将父POM文件上传到Maven仓库中，方便其他开发者使用。  
我们的项目里就使用了nexus和maven进行了父子控制，在子项目中指定父项目，父子项目分开管理。

[maven_setting]: https://blog.csdn.net/hlzdbk/article/details/129822239