简介:
什么是POM?
POM是项目对象模型(Project Object Model)的简称,它是Maven项目中的文件,使用XML表示,名称叫做pom.xml。在Maven中,当谈到Project的时候,不仅仅是一堆包含代码的文件。一个Project往往包含一个配置文件,包括了与开发者有关的,缺陷跟踪系统,组织与许可,项目的URL,项目依赖,以及其他。它包含了所有与这个项目相关的东西。事实上,在Maven世界中,project可以什么都没有,甚至没有代码,但是必须包含pom.xml文件。
概览
下面是一个POM项目中的pom.xml文件中包含的元素。注意,其中的modelVersion是4.0.0,这是当前仅有的可以被Maven2&3同时支持的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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<!-- 基本设置 -->
<groupId>...</groupId>
<artifactId>...</artifactId>
<version>...</version>
<packaging>...</packaging>
<dependencies>...</dependencies>
<parent>...</parent>
<dependencyManagement>...</dependencyManagement>
<modules>...</modules>
<properties>...</properties>
<!-- 构建过程的设置 -->
<build>...</build>
<reporting>...</reporting>
<!-- 项目信息设置 -->
<name>...</name>
<description>...</description>
<url>...</url>
<inceptionYear>...</inceptionYear>
<licenses>...</licenses>
<organization>...</organization>
<developers>...</developers>
<contributors>...</contributors>
<!-- 环境设置 -->
<issueManagement>...</issueManagement>
<ciManagement>...</ciManagement>
<mailingLists>...</mailingLists>
<scm>...</scm>
<prerequisites>...</prerequisites>
<repositories>...</repositories>
<pluginRepositories>...</pluginRepositories>
<distributionManagement>...</distributionManagement>
<profiles>...</profiles>
</project>
基本内容:
POM包括了所有的项目信息。
maven 相关:
pom定义了最小的maven2元素,允许groupId,artifactId,version。所有需要的元素
- groupId:项目或者组织的唯一标志,并且配置时生成的路径也是由此生成,如org.codehaus.mojo生成的相对路径为:/org/codehaus/mojo
- artifactId: 项目的通用名称
- version:项目的版本
- packaging: 打包的机制,如pom, jar, maven-plugin, ejb, war, ear, rar, par
- classifier: 分类
主要为依赖,继承,合成
依赖关系:
xml 代码
- <dependencies>
- <dependency>
- <groupId>junitgroupId>
- <artifactId>junitartifactId>
- <version>4.0version>
- <type>jartype>
- <scope>testscope>
- <optional>trueoptional>
- dependency>
- …
- dependencies>
- groupId, artifactId, version:描述了依赖的项目唯一标志
可以通过以下方式进行安装:
- 使用以下的命令安装:
- mvn install:install-file –Dfile=non-maven-proj.jar –DgroupId=some.group –DartifactId=non-maven-proj –Dversion=1
- 创建自己的库,并配置,使用deploy:deploy-file
- 设置此依赖范围为system,定义一个系统路径。不提倡。
- type:相应的依赖产品包形式,如jar,war
- scope:用于限制相应的依赖范围,包括以下的几种变量:
- compile :默认范围,用于编译
- provided:类似于编译,但支持你期待jdk或者容器提供,类似于classpath
- runtime:在执行时,需要使用
- test:用于test任务时使用
- system:需要外在提供相应得元素。通过systemPath来取得
- systemPath: 仅用于范围为system。提供相应的路径
- optional: 标注可选,当项目自身也是依赖时。用于连续依赖时使用
外在告诉maven你只包括指定的项目,不包括相关的依赖。此因素主要用于解决版本冲突问题
xml 代码
- <dependencies>
- <dependency>
- <groupId>org.apache.mavengroupId>
- <artifactId>maven-embedderartifactId>
- <version>2.0version>
- <exclusions>
- <exclusion>
- <groupId>org.apache.mavengroupId>
- <artifactId>maven-coreartifactId>
- exclusion>
- exclusions>
- dependency>
表示项目maven-embedder需要项目maven-core,但我们不想引用maven-core
继承关系
另一个强大的变化,maven带来的是项目继承。主要的设置:
定义父项目
xml 代码
- <project>
- <modelVersion>4.0.0modelVersion>
- <groupId>org.codehaus.mojogroupId>
- <artifactId>my-parentartifactId>
- <version>2.0version>
- <packaging>pompackaging>
- project>
packaging 类型,需要pom用于parent和合成多个项目。我们需要增加相应的值给父pom,用于子项目继承。主要的元素如下:
- 依赖型
- 开发者和合作者
- 插件列表
- 报表列表
- 插件执行使用相应的匹配ids
- 插件配置
- 子项目配置
xml 代码
- <project>
- <modelVersion>4.0.0modelVersion>
- <parent>
- <groupId>org.codehaus.mojogroupId>
- <artifactId>my-parentartifactId>
- <version>2.0version>
- <relativePath>../my-parentrelativePath>
- parent>
- <artifactId>my-projectartifactId>
- project>
relativePath可以不需要,但是用于指明parent的目录,用于快速查询。
dependencyManagement:
用于父项目配置共同的依赖关系,主要配置依赖包相同因素,如版本,scope。
合成(或者多个模块)
一个项目有多个模块,也叫做多重模块,或者合成项目。
如下的定义:
xml 代码
- <project>
- <modelVersion>4.0.0modelVersion>
- <groupId>org.codehaus.mojogroupId>
- <artifactId>my-parentartifactId>
- <version>2.0version>
- <modules>
- <module>my-project1<module>
- <module>my-project2<module>
- modules>
- project>
build 设置
主要用于编译设置,包括两个主要的元素,build和report
build
主要分为两部分,基本元素和扩展元素集合
注意:包括项目build和profile build
xml 代码
基本元素
xml 代码
- <build>
- <defaultGoal>installdefaultGoal>
- <directory>{basedir}/target<span class="tag"><span class="tag-name">directory</span><span class="tag">></span> </span></li><li> <span class="tag"><</span><span class="tag-name">finalName</span><span class="tag">></span>{artifactId}-${version}finalName>
- <filters>
- <filter>filters/filter1.propertiesfilter>
- filters>
- …
- build>
- defaultGoal: 定义默认的目标或者阶段。如install
- directory: 编译输出的目录
- finalName: 生成最后的文件的样式
- filter: 定义过滤,用于替换相应的属性文件,使用maven定义的属性。设置所有placehold的值
资源(resources)
你项目中需要指定的资源。如spring配置文件,log4j.properties
xml 代码
- <project>
- <build>
- …
- <resources>
- <resource>
- <targetPath>META-INF/plexustargetPath>
- <filtering>falsefiltering>
- <directory>${basedir}/src/main/plexusdirectory>
- <includes>
- <include>configuration.xmlinclude>
- includes>
- <excludes>
- <exclude>**/*.propertiesexclude>
- excludes>
- resource>
- resources>
- <testResources>
- …
- testResources>
- …
- build>
- project>
- resources: resource的列表,用于包括所有的资源
- targetPath: 指定目标路径,用于放置资源,用于build
- filtering: 是否替换资源中的属性placehold
- directory: 资源所在的位置
- includes: 样式,包括那些资源
- excludes: 排除的资源
- testResources: 测试资源列表
在build时,执行的插件,比较有用的部分,如使用jdk 5.0编译等等
xml 代码
- <project>
- <build>
- …
- <plugins>
- <plugin>
- <groupId>org.apache.maven.pluginsgroupId>
- <artifactId>maven-jar-pluginartifactId>
- <version>2.0version>
- <extensions>falseextensions>
- <inherited>trueinherited>
- <configuration>
- <classifier>testclassifier>
- configuration>
- <dependencies>…dependencies>
- <executions>…executions>
- plugin>
- plugins>
- build>
- project>
- extensions: true or false,是否装载插件扩展。默认false
- inherited: true or false,是否此插件配置将会应用于poms,那些继承于此的项目
- configuration: 指定插件配置
- dependencies: 插件需要依赖的包
- executions: 用于配置execution目标,一个插件可以有多个目标。
xml 代码
- <plugin>
- <artifactId>maven-antrun-pluginartifactId>
- <executions>
- <execution>
- <id>echodirid>
- <goals>
- <goal>rungoal>
- goals>
- <phase>verifyphase>
- <inherited>falseinherited>
- <configuration>
- <tasks>
- <echo>Build Dir: ${project.build.directory}echo>
- tasks>
- configuration>
- execution>
- executions>
- plugin>
说明:
- id:规定execution 的唯一标志
- goals: 表示目标
- phase: 表示阶段,目标将会在什么阶段执行
- inherited: 和上面的元素一样,设置false maven将会拒绝执行继承给子插件
- configuration: 表示此执行的配置属性
插件管理
pluginManagement:插件管理以同样的方式包括插件元素,用于在特定的项目中配置。所有继承于此项目的子项目都能使用。主要定义插件的共同元素
扩展元素集合
主要包括以下的元素:
Directories
用于设置各种目录结构,如下:
xml 代码
- <build>
- <sourceDirectory>{basedir}/src/main/java<span class="tag"><span class="tag-name">sourceDirectory</span><span class="tag">></span> </span></li><li class="alt"> <span class="tag"><</span><span class="tag-name">scriptSourceDirectory</span><span class="tag">></span>{basedir}/src/main/scriptsscriptSourceDirectory>
- <testSourceDirectory>{basedir}/src/test/java<span class="tag"><span class="tag-name">testSourceDirectory</span><span class="tag">></span> </span></li><li class="alt"> <span class="tag"><</span><span class="tag-name">outputDirectory</span><span class="tag">></span>{basedir}/target/classesoutputDirectory>
- <testOutputDirectory>${basedir}/target/test-classestestOutputDirectory>
- …
- build>
Extensions
表示需要扩展的插件,必须包括进相应的build路径。
xml 代码
- <project>
- <build>
- …
- <extensions>
- <extension>
- <groupId>org.apache.maven.wagongroupId>
- <artifactId>wagon-ftpartifactId>
- <version>1.0-alpha-3version>
- extension>
- extensions>
- …
- build>
- project>
Reporting
用于在site阶段输出报表。特定的maven 插件能输出相应的定制和配置报表。
xml 代码
- <reporting>
- <plugins>
- <plugin>
- <outputDirectory>${basedir}/target/siteoutputDirectory>
- <artifactId>maven-project-info-reports-pluginartifactId>
- <reportSets>
- <reportSet>reportSet>
- reportSets>
- plugin>
- plugins>
- reporting>
Report Sets
用于配置不同的目标,应用于不同的报表
xml 代码