pom 文件

2021-12-30/2021-12-30

参考文档:maven(二)pom文件详解

1. 什么是 POM 文件

POM( Project Object Model,项目对象模型 ) 是 Maven 工程的基本工作单元,是一个XML文件,包含了项目的基本信息,用于描述项目如何构建,声明项目依赖,等等。执行任务或目标时,Maven 会在当前目录中查找 POM。它读取 POM,获取所需的配置信息,然后执行目标。

POM 中可以指定以下配置:

  • 项目依赖
  • 插件
  • 执行目标
  • 项目构建 profile
  • 项目版本
  • 项目开发者列表
  • 相关邮件列表信息

2. POM 文件各常用属性含义

2.1 项目基本信息

 1<project xmlns = "http://maven.apache.org/POM/4.0.0"
 2    xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
 3    xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
 4    http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5
 6    <!--声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变,虽然如此,但它仍然是必不可少的,
 7    这是为了当Maven引入了新的特性或者其他模型变更的时候,确保稳定性。 -->
 8    <modelVersion>4.0.0</modelVersion>
 9
10    <groupId>com.jun.cloud</groupId>
11    <artifactId>cloud-parent</artifactId>
12    <version>0.0.1-SNAPSHOT</version>
13    <!--项目产生的构件类型,例如jar、war、ear、pom。插件可以创建他们自己的构件类型,所以前面列的不是全部构件类型 -->
14    <packaging>pom</packaging>
15
16    <!--项目的名称和详细描述, Maven产生的文档用,所以基本可以省略 -->
17    <name>cloud-parent</name>
18    <description>start project for Spring Boot</description>
19
20    <!--父项目的坐标,父 POM 包含了一些可以被继承的默认设置-->
21    <parent>
22        <groupId>org.springframework.cloud</groupId>
23        <artifactId>spring-cloud-starter-parent</artifactId>
24        <version>Dalston.RELEASE</version>
25        <!-- 父项目的pom.xml文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。Maven首先在构建当前项目的地方寻找父项
26           目的pom,其次在文件系统的这个位置(relativePath位置),然后在本地仓库,最后在远程仓库寻找父项目的pom。 -->
27        <relativePath/>
28        <!-- lookup parent from repository -->
29    </parent>
30
31    <!--包含的子模块-->
32    <modules>
33        <module>cloud-api</module>
34        <module>cloud-common</module>
35    </modules>
36</project>

2.2 build 项目构建属性介绍

2.2.1 resources 资源路径列表

 1<build>
 2    <!--这个元素描述了项目相关的所有资源路径列表,例如和项目相关的属性文件,这些资源被包含在最终的打包文件里。 -->
 3    <resources>
 4        <!--这个元素描述了项目相关或测试相关的所有资源路径,可以有多个 -->
 5        <resource>
 6            <!-- 描述了资源的目标路径。该路径相对target/classes目录(例如${project.build.outputDirectory})。举个例
 7                子,如果你想资源在特定的包里(org.apache.maven.messages),你就必须该元素设置为org/apache/maven /messages。
 8                然而,如果你只是想把资源放到源码目录结构里,就不需要该配置。 -->
 9            <!--<targetPath />-->
10
11            <!--是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性,文件在filters元素里列出。 -->
12            <filtering />
13
14            <!--描述存放资源的目录,该路径相对POM路径 -->
15            <directory>src/main/resources/</directory>
16            <!--排除的模式列表,例如**/*.xml -->
17            <excludes>
18                <exclude>dev/*</exclude>
19                <exclude>prod/*</exclude>
20                <exclude>test/*</exclude>
21            </excludes>
22            <!--包含的模式列表,例如**/*.xml. -->
23            <includes>
24                <!--如果有其他定义通用文件,需要包含进来-->
25                <!--<include>messages/*</include>-->
26            </includes>
27        </resource>
28        <resource>
29            <!--这里是关键! 根据不同的环境,把对应文件夹里的配置文件打包-->
30            <directory>src/main/resources/${profiles.active}</directory>
31        </resource>
32    </resources>
33
34    <!--这个元素描述了单元测试相关的所有资源路径,例如和单元测试相关的属性文件。 -->
35    <testResources>
36        <!--这个元素描述了测试相关的所有资源路径,参见上方build/resources/resource元素的说明 -->
37        <testResource>
38            <targetPath />
39            <filtering />
40            <directory />
41            <includes />
42            <excludes />
43        </testResource>
44    </testResources>
45</build>

2.2.2 plugins 插件列表

 1<build>
 2    <!--子项目可以引用的默认插件信息。该插件配置项直到被引用时才会被解析或绑定到生命周期。
 3        给定插件的任何本地配置都会覆盖这里的配置 -->
 4    <pluginManagement>
 5        <plugins>
 6            <!--同下方的插件描述-->
 7            <plugin>
 8
 9            </plugin>
10        </plugins>
11    </pluginManagement>
12
13
14    <!--使用的插件列表 。 -->
15    <plugins>
16        <!--plugin元素包含描述插件所需要的信息。 -->
17        <plugin>
18
19            <groupId>org.springframework.boot</groupId>
20            <artifactId>spring-boot-maven-plugin</artifactId>
21            <version />
22
23            <!--是否从该插件下载Maven扩展(例如打包和类型处理器),由于性能原因,只有在真需要下载时,该元素才被设置成enabled。 -->
24            <extensions />
25
26            <!--在构建生命周期中  执行  一组目标的配置。每个目标可能有不同的配置。 -->
27            <executions>
28                <!--execution元素包含了插件执行需要的信息 -->
29                <execution>
30                    <!--执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标 -->
31                    <!--<id />-->
32                    <!--绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段 -->
33                    <phase />
34                    <!--配置的执行目标 -->
35                    <goals>
36                        <goal>repackage</goal>
37                    </goals>
38                    <!--配置是否被传播到子POM -->
39                    <inherited>false</inherited>
40                    <!--作为DOM对象的配置 -->
41                    <configuration />
42                </execution>
43            </executions>
44
45            <!--项目引入插件所需要的额外依赖 -->
46            <dependencies>
47                <!--参见dependencies/dependency元素 -->
48                <!--<dependency>-->
49                <!--</dependency>-->
50            </dependencies>
51
52            <!--任何配置是否被传播到子项目 -->
53            <inherited />
54
55            <!--作为DOM对象的配置 -->
56            <configuration />
57        </plugin>
58    </plugins>
59</build>

2.2.3 其他

 1<!--构建项目需要的信息 -->
 2<build>
 3    <!--该元素设置了项目源码目录,当构建项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 -->
 4    <sourceDirectory />
 5
 6    <!--该元素设置了项目脚本源码目录,该目录和源码目录不同:绝大多数情况下,该目录下的内容 会被拷贝到输出目录(因为脚本是被解释的,而不是被编译的)。 -->
 7    <scriptSourceDirectory />
 8
 9    <!--该元素设置了项目单元测试使用的源码目录,当测试项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 -->
10    <testSourceDirectory />
11
12    <!--被编译过的应用程序class文件和配置文件存放的目录。 -->
13    <outputDirectory />
14
15    <!--被编译过的测试class文件存放的目录。 -->
16    <testOutputDirectory />
17
18    <!--构建产生的所有文件(即类似target下的所有文件)存放的目录 -->
19    <directory />
20
21    <!--产生的构件的文件名(即jar包的名称),默认值是${artifactId}-${version},如test-profiles-0.0.1-SNAPSHOT.jar。 -->
22    <finalName />
23
24    <!--使用来自该项目的一系列构建扩展 -->
25    <extensions>
26        <!--描述使用到的构建扩展。 -->
27        <extension>
28            <!--构建扩展的groupId -->
29            <groupId />
30            <!--构建扩展的artifactId -->
31            <artifactId />
32            <!--构建扩展的版本 -->
33            <version />
34        </extension>
35    </extensions>
36
37    <!--当项目没有规定目标(Maven2 叫做阶段)时的默认值 -->
38    <defaultGoal />
39
40    <!--当filtering开关打开时,使用到的过滤器属性文件列表 -->
41    <filters />
42</build>

2.3 profile 介绍

参考:maven profile

2.4 repositories

 1<!--发现依赖和扩展的远程仓库列表。 -->
 2<repositories>
 3    <!--包含需要连接到远程仓库的信息 -->
 4    <repository>
 5        <!--远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 -->
 6        <id>banseon-repository-proxy</id>
 7        <!--远程仓库名称 -->
 8        <name>banseon-repository-proxy</name>
 9        <!--远程仓库URL,按protocol://hostname/path形式 -->
10        <url>http://192.168.1.169:9999/repository/</url>
11
12        <!--如何处理远程仓库里发布版本的下载 -->
13        <releases>
14            <!--true或者false表示该仓库是否为下载某种类型构件(发布版,快照版)开启。 -->
15            <enabled />
16            <!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是:always(一直),daily(默认,每日),interval:X(这里X是以分钟为单位的时间间隔),或者never(从不)。 -->
17            <updatePolicy />
18            <!--当Maven验证构件校验文件失败时该怎么做:ignore(忽略),fail(失败),或者warn(警告)。 -->
19            <checksumPolicy />
20        </releases>
21
22        <!-- 如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置,POM就可以在每个单独的仓库中,为每种类型的构件采取不同的 
23                策略。例如,可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 -->
24        <snapshots>
25            <enabled />
26            <updatePolicy />
27            <checksumPolicy />
28        </snapshots>
29
30        <!-- 用于定位和排序构件的仓库布局类型-可以是default(默认)或者legacy(遗留)。Maven 2为其仓库提供了一个默认的布局;然 
31                而,Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default(默认)还是legacy(遗留)。 -->
32        <layout>default</layout>
33    </repository>
34</repositories>

实例如:

 1<repositories>
 2    <repository>
 3        <id>spring-snapshots</id>
 4        <name>Spring Snapshots</name>
 5        <url>https://repo.spring.io/snapshot</url>
 6        <snapshots>
 7            <enabled>true</enabled>
 8        </snapshots>
 9    </repository>
10    <repository>
11        <id>spring-milestones</id>
12        <name>Spring Milestones</name>
13        <url>https://repo.spring.io/milestone</url>
14        <snapshots>
15            <enabled>false</enabled>
16        </snapshots>
17    </repository>
18</repositories>

2.5 dependencies 依赖

 1<!--该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。 -->
 2<dependencies>
 3    <dependency>
 4
 5        <groupId>org.apache.maven</groupId>
 6        <artifactId>maven-artifact</artifactId>
 7        <!--依赖的版本号。 在Maven 2里, 也可以配置成版本号的范围。 -->
 8        <version>3.8.1</version>
 9
10        <!--依赖范围。在项目发布过程中,帮助决定哪些构件被包括进来。欲知详情请参考依赖机制。
11			- compile :默认范围,用于编译
12			- provided:类似于编译,但支持你期待jdk或者容器提供,类似于classpath
13            - runtime: 在执行时需要使用
14            - test: 用于test任务时使用
15            - optional: 当项目自身被依赖时,标注依赖是否传递。用于连续依赖时使用 -->
16        <scope>test</scope>
17
18
19        <!--当计算传递依赖时, 从依赖构件列表里,列出被排除的依赖构件集。
20			即告诉maven你只依赖指定的项目,不依赖项目的依赖。此元素主要用于解决版本冲突问题 -->
21        <exclusions>
22            <exclusion>
23                <artifactId>spring-core</artifactId>
24                <groupId>org.springframework</groupId>
25            </exclusion>
26        </exclusions>
27
28        <!--可选依赖,如果你在项目B中把C依赖声明为可选,你就需要在依赖于B的项目(例如项目A)中显式的引用对C的依赖。可选依赖阻断依赖的传递性。 -->
29        <optional>true</optional>
30    </dependency>
31</dependencies>
32
33
34
35<!-- 继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖(必须描述group ID和 artifact 
36        ID信息),如果group ID和artifact ID以外的一些信息没有描述,则通过group ID和artifact ID 匹配到这里的依赖,并使用这里的依赖信息。 -->
37<dependencyManagement>
38    <dependencies>
39        <!--参见dependencies/dependency元素 -->
40        <dependency>
41                ......
42        </dependency>
43    </dependencies>
44</dependencyManagement>

2.6 distributionManagement 发布

 1<!--项目分发信息,在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者把构件部署到远程仓库。 -->
 2<distributionManagement>
 3    <repository>
 4        <id>nexus-releases</id>
 5        <url>http://192.168.0.237:8081/nexus/content/repositories/releases</url>
 6    </repository>
 7
 8    <!--构件的快照部署到哪里?如果没有配置该元素,默认部署到repository元素配置的仓库 -->
 9    <snapshotRepository>
10        <id>nexus-snapshots</id>
11        <url>http://192.168.0.237:8081/nexus/content/repositories/snapshots</url>
12    </snapshotRepository>
13</distributionManagement>
评论
发表评论
       
       
取消