# 常用的 pom.xml 文件解析

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

<!-- 父项目的坐标。如果项目中没有规定某个元素的值,那么父项目中的对应值即为项目的默认值。
     坐标包括group ID,artifact ID和 version。 -->
<parent>
    <!-- 被继承的父项目的构件标识符 -->
    <artifactId>xxx</artifactId>
    <!-- 被继承的父项目的全球唯一标识符 -->
    <groupId>xxx</groupId>
    <!-- 被继承的父项目的版本 -->
    <version>xxx</version>
    <!-- 父项目的pom.xml文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。
         Maven首先在构建当前项目的地方寻找父项目的pom,其次在文件系统的这个位置(relativePath位置),
         然后在本地仓库,最后在远程仓库寻找父项目的pom。 -->
    <relativePath>xxx</relativePath>
</parent>

<!-- 声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变,虽然如此,但它仍然是必不可少的,
     这是为了当Maven引入了新的特性或者其他模型变更的时候,确保稳定性。 -->
<modelVersion> 4.0.0 </modelVersion>

<!-- 项目的全球唯一标识符,通常使用全限定的包名区分该项目和其他项目。并且构建时生成的路径也是由此生成,
     如com.mycompany.app生成的相对路径为:/com/mycompany/app -->
<groupId>xxx</groupId>
<!-- 构件的标识符,它和group ID一起唯一标识一个构件。换句话说,你不能有两个不同的项目拥有同样的artifact ID
     和groupID;在某个特定的group ID下,artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西,Maven
     为项目产生的构件包括:JARs,源码,二进制发布和WARs等。 -->
<artifactId>xxx</artifactId>

<!-- 项目产生的构件类型,例如jar、war、ear、pom。插件可以创建他们自己的构件类型,所以前面列的不是全部构件类型 -->
<packaging> jar </packaging>
<!-- 项目当前版本,格式为:主版本.次版本.增量版本-限定版本号 -->
<version> 1.0-SNAPSHOT </version>
<!-- 项目的名称, Maven产生的文档用 -->
<name> xxx-maven </name>
<!-- 项目主页的URL, Maven产生的文档用 -->
<url> http://maven.apache.org </url>
<!-- 项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时(例如,CDATA中的文本会被解析器忽略,
     就可以包含HTML标签), 不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面,你应该修改你自己的
     索引页文件,而不是调整这里的文档。 -->
<description> A maven project to study maven. </description>

   <!-- 模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 -->
    <modules>
       <!--子项目相对路径:子项目的文件名称-->
       <module></module>
    </modules>

    <!-- 以值替代名称,Properties可以在整个POM中使用,也可以作为触发条件(见settings.xml配置文件里activation元素的说明)。格式是<name>value</name>-->
<properties>
    <name>value</name>
</properties>

  <!-- 发现依赖和扩展的远程仓库列表。 -->
<repositories>
    <!-- 包含需要连接到远程仓库的信息 -->
    <repository>
        <!-- 如何处理远程仓库里发布版本的下载 -->
        <releases>
            <!-- true或者false表示该仓库是否为下载某种类型构件(发布版,快照版)开启。 -->
            <enabled><enabled>
        </releases>

        <!-- 如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置,POM就可以在每个单独的仓库中,为每种类型的构件采取不同的策略。例如,可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 -->
        <snapshots>
            <enabled><enabled>
        </snapshots>

        <!-- 远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 -->
        <id> banseon-repository-proxy </id>

        <!-- 远程仓库名称 -->
        <name> banseon-repository-proxy </name>

        <!-- 远程仓库URL,按protocol://hostname/path形式 -->
        <url> http://192.168.1.169:9999/repository/ </url>

        <!-- 用于定位和排序构件的仓库布局类型-可以是default(默认)或者legacy(遗留)。Maven 2为其仓库提供了一个默认的布局;然而,Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default(默认)还是legacy(遗留) -->
        <layout> default </layout>
    </repository>
</repositories>

<!-- 该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。要获取更多信息,请看项目依赖机制。 -->
<dependencies>
    <dependency>
        <!-- 依赖的group ID -->
        <groupId> org.apache.maven </groupId>

        <!-- 依赖的artifact ID -->
        <artifactId> maven-artifact </artifactId>

        <!-- 依赖的版本号。 在Maven 2里, 也可以配置成版本号的范围。 -->
        <version> 3.8.1 </version>

        <!-- 依赖类型,默认类型是jar。它通常表示依赖的文件的扩展名,但也有例外。一个类型可以被映射成另外一个扩展
             名或分类器。类型经常和使用的打包方式对应,尽管这也有例外。一些类型的例子:jar,war,ejb-client和test-jar。
             如果设置extensions为 true,就可以在plugin里定义新的类型。所以前面的类型的例子不完整。 -->
        <type> jar </type>

        <!-- 依赖范围。在项目发布过程中,帮助决定哪些构件被包括进来。欲知详情请参考依赖机制。
            - compile :默认范围,用于编译
            - provided:类似于编译,但支持你期待jdk或者容器提供,类似于classpath
            - runtime: 在执行时需要使用
            - test: 用于test任务时使用
            - system: 需要外在提供相应的元素。通过systemPath来取得
            - systemPath: 仅用于范围为system。提供相应的路径
            - optional: 当项目自身被依赖时,标注依赖是否传递。用于连续依赖时使用 -->
        <scope> test </scope>

        <!-- 仅供system范围使用。注意,不鼓励使用这个元素,并且在新的版本中该元素可能被覆盖掉。该元素为依赖规定了文件
             系统上的路径。需要绝对路径而不是相对路径。推荐使用属性匹配绝对路径,例如${java.home}。 -->
        <systemPath></systemPath>

       <!-- 当计算传递依赖时, 从依赖构件列表里,列出被排除的依赖构件集。即告诉maven你只依赖指定的项目,不依赖项目的依赖。此元素主要用于解决版本冲突问题 -->
        <exclusions>
            <exclusion>
                <artifactId> spring-core </artifactId>
                <groupId> org.springframework </groupId>
            </exclusion>
        </exclusions>
        <!-- 可选依赖,如果你在项目B中把C依赖声明为可选,你就需要在依赖于B的项目(例如项目A)中显式的引用对C的依赖。可选依赖阻断依赖的传递性。 -->
        <optional> true </optional>
    </dependency>
</dependencies>

  <!-- 在列的项目构建profile,如果被激活,会修改构建处理 -->
<profiles>
    <!-- 根据环境参数或命令行参数激活某个构建处理 -->
    <profile>
        <!-- 构建配置的唯一标识符。即用于命令行激活,也用于在继承时合并具有相同标识符的profile。 -->
        <id></id>
    </profile>
</profiles>


<!-- 构建项目需要的信息 -->
<build>
    <!-- 该元素设置了项目源码目录,当构建项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 -->
    <sourceDirectory></sourceDirectory>

    <!-- 该元素设置了项目单元测试使用的源码目录,当测试项目的时候,构建系统会编译目录里的源码。
         该路径是相对于pom.xml的相对路径。 -->
    <testSourceDirectory></testSourceDirectory>

    <!-- 被编译过的应用程序class文件存放的目录。 -->
    <outputDirectory></outputDirectory>

    <!-- 被编译过的测试class文件存放的目录。 -->
    <testOutputDirectory></testOutputDirectory>

    <!-- 这个元素描述了项目相关的所有资源路径列表,例如和项目相关的属性文件,这些资源被包含在
         最终的打包文件里。 -->
    <resources>
        <!-- 这个元素描述了项目相关或测试相关的所有资源路径 -->
        <resource>
            <!-- 描述存放资源的目录,该路径相对POM路径 -->
            <directory></directory>

            <!-- 包含的模式列表,例如**/*.xml. -->
            <includes>
                <include></include>
            </includes>

            <!-- 排除的模式列表,例如**/*.xml -->
            <excludes>
                <exclude></exclude>
            </excludes>
        </resource>
    </resources>
       <!-- 子项目可以引用的默认插件信息。该插件配置项直到被引用时才会被解析或绑定到生命周期。给定插件的任何本
         地配置都会覆盖这里的配置 -->
    <pluginManagement>
        <!-- 使用的插件列表 。 -->
        <plugins>
            <!-- plugin元素包含描述插件所需要的信息。 -->
            <plugin>
                <!-- 插件在仓库里的group ID -->
                <groupId></groupId>

                <!-- 插件在仓库里的artifact ID -->
                <artifactId></artifactId>

                <!-- 被使用的插件的版本(或版本范围) -->
                <version></version>

                <!-- 是否从该插件下载Maven扩展(例如打包和类型处理器),由于性能原因,只有在真需要下载时,该
                     元素才被设置成enabled。 -->
                <extensions>true/false</extensions>

                <!-- 在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 -->
                <executions>
                    <!-- execution元素包含了插件执行需要的信息 -->
                    <execution>
                       <!-- 执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标 -->
                        <id></id>

                        <!-- 绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段 -->
                        <phase></phase>
                    </execution>
                </executions>
                <!-- 作为DOM对象的配置 -->
                <configuration></configuration>
            </plugin>
        </plugins>
    </pluginManagement>

    <!-- 该项目使用的插件列表 。 -->
    <plugins>
        <!-- plugin元素包含描述插件所需要的信息。 -->
        <plugin>
            <!-- 插件在仓库里的group ID -->
            <groupId></groupId>

            <!-- 插件在仓库里的artifact ID -->
            <artifactId></artifactId>

            <!-- 被使用的插件的版本(或版本范围) -->
            <version></version>
            <!-- 作为DOM对象的配置 -->
            <configuration></configuration>
        </plugin>
    </plugins>
</build>

</project>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227