POM文件结构解析

快来打我* 2023-07-24 14:43 150阅读 0赞

Maven的pom.xml文件简称POM (Project Object Model)，是Maven项目的配置和管理核心。

# 一个简单的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
    http://maven.apache.org/maven-v4_0_0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <groupId>org.apache</groupId>
        <artifactId>hello-world</artifactId>
        <version>1.0-SNAPSHOT</version>
        <name> MAVEN Hello World Project</name>
    </project>

代码的第一行是XML头，指定了xml文档的版本和编码格式。

**project**元素是所有pom.xml的根元素，它声明了一些POM相关的命名空间及xsd元素，虽然这些属性不是必须的，但使用这些属性可以让第三方工具（如IDE中的XML编辑器）帮助我们快速的编辑pom.

根元素下的第一个元素**modelVersion**指定了当前POM的版本，对于Maven 2 及 Maven 3来说，它只能是4.0.0。

**name**元素声明了一个对于用户更友好的项目名称，这不是必须的，声明名称，便于交流。

### maven坐标 ###

<groupId>org.apache</groupId>
    <artifactId>hello-world</artifactId>
    <version>1.0-SNAPSHOT</version>
    <package>jar</package>

**groupId**:定义当前Maven项目隶属的实际项目。  
**artifactId**：定义实际项目中的一个Maven项目（模块），推荐的做法是使用实际项目名称作为artifactId的前缀。  
**version**：定义Maven项目当前所处的版本。  
**packaging**：定义Maven项目的打包方式。

# 完整的POM结构 #

<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 "> 
     
         
        <parent> 
             
            <artifactId>xxx</artifactId>
            
            <groupId>xxx</groupId> 
             
            <version>xxx</version>
             
            <relativePath>xxx</relativePath> 
        </parent> 
     
     
         
        <modelVersion> 4.0.0 </modelVersion> 
         
        <groupId>xxx</groupId> 
         
        <artifactId>xxx</artifactId> 
         
        <packaging> jar </packaging> 
         
        <version> 1.0-SNAPSHOT </version> 
         
        <name> xxx-maven </name> 
         
        <url> http://maven.apache.org </url> 
         
        <description> A maven project to study maven. </description> 
          
        <inceptionYear /> 
     
    	
    	 
        <modules>
            
            <module></module>
        </modules>
    	
    	 
        <dependencyManagement> 
            ......
        </dependencyManagement> 
     
     
         
        <build> 
            ......
        </build> 
     
         
        <repositories> 
            ......
        </repositories>
     
         
        <profiles> 
            ......
        </profiles> 
     
         
        <pluginRepositories> 
            ......
        </pluginRepositories> 
     
         
        <dependencies> 
            ......
        </dependencies> 
     
         
        <reporting> 
            ......
        </reporting> 
     
         
        <distributionManagement> 
            ......
        </distributionManagement> 
     
         
        <properties>
            <name>value</name>
        </properties> 
    </project>

## 模块化-models ##

Maven Module也是一个maven 工程，但是却是一个子工程，必须有父工程存在并依赖，Maven Module不能抛弃父工程单独存在。

Maven Project可以理解为一个单独、独立的工程，在打包为jar或者war时，可以单独运行。如果在pom文件中添加了对父工程的依赖，此时作为父工程的子工程。

<modules>
        <module>microservicecloud-api</module>
        <module>microservicecloud-provider-dept-8001</module>
    </modules>

因为有该节点存在，所以在父工程使用命令`run as Maven install`将会把父工程与所有子工程都打包安装到本地仓库。

## 依赖的配置-dependency ##

*  groupId、artifactId和version：依赖的基本坐标
 *  type：依赖的类型，对应于项目坐标定义的packaging
 *  scope：依赖的范围:scope的取值有compile、runtime、test、provided、system和import。
 *  optional：标记依赖是否可选。  
    使用场景：可能B项目实现了两个特性，其中的特性一依赖与X，特性二依赖与Y，而这两个特性是互斥的，用户不可能同时使用两个特性。比如B是一个持久层隔离工具包，它支持多种数据库，包括MySQL、PostgreSQL等，在构建这个工具包的时候，需要这两种数据库的驱动程序，但在使用这个工具包的时候，只会依赖一种数据库。
 *  exclusions：用来排除传递性依赖。

### 依赖的管理-dependencyManagement ###

dependencyManagement主要有两个作用，一个是**集中管理项目的依赖项**，另一个就是**控制使用的依赖项的版本**。

# profiles #

在开发过程中，我们的项目会存在不同的运行环境，比如开发环境、测试环境、生产环境，而我们的项目在不同的环境中，有的配置可能会不一样，比如数据源配置、日志文件配置、以及一些软件运行过程中的基本配置，那每次我们将软件部署到不同的环境时，都需要修改相应的配置文件，这样来回修改，很容易出错，而且浪费劳动力。  
       在前面的文章profile之springboot，springboot为我们提供了一种解决方案，而maven也提供了一种更加灵活的解决方案，就是profile功能。

可以看到定义了多个profile，每个profile都有唯一的id，也包含properties属性。这里为每个profile都定义一个名为profiles.active的properties，每个环境的值不同。当我们打包项目时，激活不同的环境，profiles.active字段就会被赋予不同的值。  
       这个profiles.active字段可以应用到许多地方，及其灵活。可以在配置文件里被引用；也可以结合pom文件里的resource和filter属性，作为文件名的一部分或者文件夹名的一部分。

<build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <executions>
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                    <configuration>
                        <executable>true</executable>
                    </configuration>
                </plugin>
            </plugins>
    
            <resources>
                <resource>
                    <directory>src/main/resources/</directory>
                    
                    <excludes>
                        <exclude>dev/*</exclude>
                        <exclude>prod/*</exclude>
                        <exclude>test/*</exclude>
                    </excludes>
                    <includes>
                        
                        
                    </includes>
                </resource>
                <resource>
                    
                    <directory>src/main/resources/${profiles.active}</directory>
                </resource>
            </resources>
        </build>
    
        <profiles>
            <profile>
                
                <id>dev</id>
                <properties>
                    
                    <profiles.active>dev</profiles.active>
                </properties>
            </profile>
            <profile>
                <id>prod</id>
                <properties>
                    <profiles.active>prod</profiles.active>
                </properties>
                
                <activation>
                    
                    <activeByDefault>true</activeByDefault>
                </activation>
            </profile>
            <profile>
                <id>test</id>
                <properties>
                    <profiles.active>test</profiles.active>
                </properties>
            </profile>
        </profiles>

激活方式

*  通过maven命令参数：mvn clean package -Ptest
 *  通过pom文件里的activation属性
 *  settings.xml中使用activeProfiles指定

### 构建部分-build ###

pom中一大部分配置都包含在build标签中，这部分是在对项目进行构建时所需要的配置，当你对项目进行编译，测试，打包，发布的时候，这部分配置就会在对应的阶段起作用了。

build标签中可以包含很多插件，这些插件可以配置到项目的某些构建阶段，随着项目的构建进程发挥作用。

<project>
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.fox</groupId>
      <artifactId>demo</artifactId>
      <version>1.0</version>
     
      <dependencies>
        <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>3.8.1</version>
          <scope>test</scope>
        </dependency>
      </dependencies>
     
      <build>
        <plugins>  
            <plugin>  
                <artifactId>maven-compiler-plugin</artifactId>  
                <configuration>  
                    <source>1.6</source>  
                    <target>1.6</target>  
                </configuration>  
            </plugin>  
        </plugins>  
      </build>
    </project>

# 报表部分-reporting #

我们执行mvn site就可以为项目生成一系列可以用来描述项目信息的网页，maven2中的一大部分插件就是专门在这时候发挥效用的，它们可以根据项目的结构，源代码，测试，SCM信息等，生成各种特殊功能的报表，这要把这些插件配置在reporting标签中，它们就会在执行mvn site的同时起作用。

### 环境配置 ###

说明：  
issueManagement，给出defect tracking system及其访问URL

*  system
 *  url

ciManagement，给出Continuous Integration Management、其URL和notifier

*  system
 *  url
 *  notifiers，集成过程中发生事件，以某种方式（如mail）通知开发人员

scm，software configuration management

*  connection，用户使用的URI，能够只读地访问版本控制系统
 *  developerConnection，开发人员使用URI，能够读写地访问版本控制系统
 *  tag，项目当前的tag
 *  url，可通过Web浏览器访问的公共网址

distributionManagement，构件的发布管理  
prerequisites，POM执行的前提条件，目前只支持对Maven版本的要求

*  maven

mailingLists，开发人员或用户的邮件列表