maven 配置篇 之pom.xml

Posted on

maven 配置篇 之pom.xml

maven 配置篇 之pom.xml(一)

说完了settings.xml配置,下来说一下maven2的主要配置pom.xml

什么是pom? pom作为项目对象模型。通过xml表示maven项目,使用pom.xml来实现。主要描述了项目:包括配置文件;开发者需要遵循的规则,缺陷管理系统,组织和licenses,项目的url,项目的依赖性,以及其他所有的项目相关因素。 快速察看: xml 代码

  1. 4.0.0modelVersion>
  2. ...groupId>
  3. ...artifactId>
  4. ...version>
  5. ...packaging>
  6. ...dependencies>
  7. ...parent>
  8. ...dependencyManagement>
  9. ...modules>
  10. ...properties>
  11. ...build>
  12. ...reporting>
  13. ...name>
  14. ...description>
  15. ...url>
  16. ...inceptionYear>
  17. ...licenses>
  18. ...organization>
  19. ...developers>
  20. ...contributors>
  21. ...issueManagement>
  22. ...ciManagement>
  23. ...mailingLists>
  24. ...scm>
  25. ...prerequisites>
  26. ...repositories>
  27. ...pluginRepositories>
  28. ...distributionManagement>
  29. ...profiles>
  30. 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: 分类 POM关系: 主要为依赖,继承,合成 依赖关系:

xml 代码

  1. junitgroupId>
  2. junitartifactId>
  3. 4.0version>
  4. jartype>
  5. testscope>
  6. trueoptional>
  7. dependency>
  8. ...
  9. 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 代码

  1. org.apache.mavengroupId>
  2. maven-embedderartifactId>
  3. 2.0version>
  4. org.apache.mavengroupId>
  5. maven-coreartifactId>
  6. exclusion>
  7. exclusions>
  8. dependency>
    表示项目maven-embedder需要项目maven-core,但我们不想引用maven-core 继承关系 另一个强大的变化,maven带来的是项目继承。主要的设置: 定义父项目 xml 代码
  1. 4.0.0modelVersion>
  2. org.codehaus.mojogroupId>
  3. my-parentartifactId>
  4. 2.0version>
  5. pompackaging>
  6. project>
    packaging 类型,需要pom用于parent和合成多个项目。我们需要增加相应的值给父pom,用于子项目继承。主要的元素如下:
  • 依赖型
  • 开发者和合作者
  • 插件列表
  • 报表列表
  • 插件执行使用相应的匹配ids
  • 插件配置
  • 子项目配置 xml 代码
  1. 4.0.0modelVersion>
  2. org.codehaus.mojogroupId>
  3. my-parentartifactId>
  4. 2.0version>
  5. ../my-parentrelativePath>
  6. parent>
  7. my-projectartifactId>
  8. project>
    relativePath可以不需要,但是用于指明parent的目录,用于快速查询。 dependencyManagement: 用于父项目配置共同的依赖关系,主要配置依赖包相同因素,如版本,scope。 合成(或者多个模块) 一个项目有多个模块,也叫做多重模块,或者合成项目。 如下的定义: xml 代码
  1. 4.0.0modelVersion>
  2. org.codehaus.mojogroupId>
  3. my-parentartifactId>
  4. 2.0version>
  5. my-project1
  6. my-project2
  7. modules>
  8. project>
    build 设置 主要用于编译设置,包括两个主要的元素,build和report build 主要分为两部分,基本元素和扩展元素集合 注意:包括项目build和profile build xml 代码
  1. ...build>
  2. ...build>
  3. profile>
  4. profiles>
  5. project>
    基本元素 xml 代码
  1. installdefaultGoal>
  2. ${basedir}/targetdirectory>
  3. ${artifactId}-${version}finalName>
  4. filters/filter1.propertiesfilter>
  5. filters>
  6. ...
  7. build>
  • defaultGoal: 定义默认的目标或者阶段。如install
  • directory: 编译输出的目录
  • finalName: 生成最后的文件的样式
  • filter: 定义过滤,用于替换相应的属性文件,使用maven定义的属性。设置所有placehold的值 资源(resources) 你项目中需要指定的资源。如spring配置文件,log4j.properties xml 代码
  1. ...
  2. META-INF/plexustargetPath>
  3. falsefiltering>
  4. ${basedir}/src/main/plexusdirectory>
  5. configuration.xmlinclude>
  6. includes>
  7. ////*.propertiesexclude>
  8. excludes>
  9. resource>
  10. resources>
  11. ...
  12. testResources>
  13. ...
  14. build>
  15. project>
  • resources: resource的列表,用于包括所有的资源
  • targetPath: 指定目标路径,用于放置资源,用于build
  • filtering: 是否替换资源中的属性placehold
  • directory: 资源所在的位置
  • includes: 样式,包括那些资源
  • excludes: 排除的资源
  • testResources: 测试资源列表 插件 在build时,执行的插件,比较有用的部分,如使用jdk 5.0编译等等 xml 代码
  1. ...
  2. org.apache.maven.pluginsgroupId>
  3. maven-jar-pluginartifactId>
  4. 2.0version>
  5. falseextensions>
  6. trueinherited>
  7. testclassifier>
  8. configuration>
  9. ...dependencies>
  10. ...executions>
  11. plugin>
  12. plugins>
  13. build>
  14. project>
  • extensions: true or false,是否装载插件扩展。默认false
  • inherited: true or false,是否此插件配置将会应用于poms,那些继承于此的项目
  • configuration: 指定插件配置
  • dependencies: 插件需要依赖的包
  • executions: 用于配置execution目标,一个插件可以有多个目标。 如下:

xml 代码

  1. maven-antrun-pluginartifactId>
  2. echodirid>
  3. rungoal>
  4. goals>
  5. verifyphase>
  6. falseinherited>
  7. Build Dir: ${project.build.directory}echo>
  8. tasks>
  9. configuration>
  10. execution>
  11. executions>
  12. plugin>
    说明:
  • id:规定execution 的唯一标志
  • goals: 表示目标
  • phase: 表示阶段,目标将会在什么阶段执行
  • inherited: 和上面的元素一样,设置false maven将会拒绝执行继承给子插件
  • configuration: 表示此执行的配置属性 插件管理 pluginManagement:插件管理以同样的方式包括插件元素,用于在特定的项目中配置。所有继承于此项目的子项目都能使用。主要定义插件的共同元素 扩展元素集合 主要包括以下的元素: Directories 用于设置各种目录结构,如下:

xml 代码

  1. ${basedir}/src/main/javasourceDirectory>
  2. ${basedir}/src/main/scriptsscriptSourceDirectory>
  3. ${basedir}/src/test/javatestSourceDirectory>
  4. ${basedir}/target/classesoutputDirectory>
  5. ${basedir}/target/test-classestestOutputDirectory>
  6. ...
  7. build>
    Extensions 表示需要扩展的插件,必须包括进相应的build路径。 xml 代码
  1. ...
  2. org.apache.maven.wagongroupId>
  3. wagon-ftpartifactId>
  4. 1.0-alpha-3version>
  5. extension>
  6. extensions>
  7. ...
  8. build>
  9. project>
    Reporting 用于在site阶段输出报表。特定的maven 插件能输出相应的定制和配置报表。

xml 代码

  1. ${basedir}/target/siteoutputDirectory>
  2. maven-project-info-reports-pluginartifactId>
  3. reportSet>
  4. reportSets>
  5. plugin>
  6. plugins>
  7. reporting>
    Report Sets 用于配置不同的目标,应用于不同的报表 xml 代码
  1. ...
  2. sunlinkid>
  3. javadocreport>
  4. reports>
  5. trueinherited>
  6. http://java.sun.com/j2se/1.5.0/docs/api/link>
  7. links>
  8. configuration>
  9. reportSet>
  10. reportSets>
  11. plugin>
  12. plugins>
  13. reporting>

maven 配置篇 之pom.xml(二) 更多的项目信息

  • name:项目除了artifactId外,可以定义多个名称
  • description: 项目描述
  • url: 项目url
  • inceptionYear:创始年份 Licenses xml 代码
  1. Apache 2name>
  2. http://www.apache.org/licenses/LICENSE-2.0.txturl>
  3. repodistribution>
  4. A business-friendly OSS licensecomments>
  5. license>
  6. licenses> Organization 配置组织信息

xml 代码

  1. Codehaus Mojoname>
  2. http://mojo.codehaus.orgurl>
  3. organization>
    Developers 配置开发者信息 xml 代码
  1. ericid>
  2. Ericname>
  3. eredmond@codehaus.orgemail>
  4. http://eric.propellors.neturl>
  5. Codehausorganization>
  6. http://mojo.codehaus.orgorganizationUrl>
  7. architectrole>
  8. developerrole>
  9. roles>
  10. -6timezone>
  11. http://tinyurl.com/prv4tpicUrl>
  12. properties>
  13. developer>
  14. developers>
    Contributors

xml 代码

  1. Noellename>
  2. some.name@gmail.comemail>
  3. http://noellemarie.comurl>
  4. Noelle Marieorganization>
  5. http://noellemarie.comorganizationUrl>
  6. testerrole>
  7. roles>
  8. -5timezone>
  9. some.name@gmail.comgtalk>
  10. properties>
  11. contributor>
  12. contributors>
    环境设置 Issue Management 定义相关的bug跟踪系统,如bugzilla,testtrack,clearQuest等

xml 代码

  1. Bugzillasystem>
  2. http://127.0.0.1/bugzillaurl>
  3. issueManagement>
    Continuous Integration Management 连续整合管理,基于triggers或者timings

xml 代码

  1. continuumsystem>
  2. http://127.0.0.1:8080/continuumurl>
  3. mailtype>
  4. truesendOnError>
  5. truesendOnFailure>
  6. falsesendOnSuccess>
  7. falsesendOnWarning>
  8. continuum@127.0.0.1address>configuration>
  9. notifier>
  10. notifiers>
  11. ciManagement>
    Mailing Lists

xml 代码

  1. User Listname>
  2. user-subscribe@127.0.0.1subscribe>
  3. user-unsubscribe@127.0.0.1unsubscribe>
  4. user@127.0.0.1post>
  5. http://127.0.0.1/user/archive>
  6. http://base.google.com/base/1/127.0.0.1otherArchive>
  7. otherArchives>
  8. mailingList>
  9. mailingLists>
    SCM 软件配置管理,如cvs 和svn

xml 代码

  1. scm:svn:http://127.0.0.1/svn/my-projectconnection>
  2. scm:svn:https://127.0.0.1/svn/my-projectdeveloperConnection>
  3. HEADtag>
  4. http://127.0.0.1/websvn/my-projecturl>
  5. scm>
    Repositories 配置同setting.xml中的开发库 Plugin Repositories 配置同 repositories Distribution Management 用于配置分发管理,配置相应的产品发布信息,主要用于发布,在执行mvn deploy后表示要发布的位置 1 配置到文件系统 xml 代码
  1. proficio-repositoryid>
  2. Proficio Repositoryname>
  3. file://${basedir}/target/deployurl>
  4. repository>
  5. distributionManagement>
    2 使用ssh2配置 xml 代码
  1. proficio-repositoryid>
  2. Proficio Repositoryname>
  3. scp://sshserver.yourcompany.com/deployurl>
  4. repository>
  5. distributionManagement>
    3 使用sftp配置 xml 代码
  1. proficio-repositoryid>
  2. Proficio Repositoryname>
  3. sftp://ftpserver.yourcompany.com/deployurl>
  4. repository>
  5. distributionManagement>
    4 使用外在的ssh配置 编译扩展用于指定使用wagon外在ssh提供,用于提供你的文件到相应的远程服务器。 xml 代码
  1. proficio-repositoryid>
  2. Proficio Repositoryname>
  3. scpexe://sshserver.yourcompany.com/deployurl>
  4. repository>
  5. distributionManagement>
  6. org.apache.maven.wagongroupId>
  7. wagon-ssh-externalartifactId>
  8. 1.0-alpha-6version>
  9. extension>
  10. extensions>
  11. build>
    5 使用ftp配置 xml 代码
  1. proficio-repositoryid>
  2. Proficio Repositoryname>
  3. ftp://ftpserver.yourcompany.com/deployurl>
  4. repository>
  5. distributionManagement>
  6. org.apache.maven.wagongroupId>
  7. wagon-ftpartifactId>
  8. 1.0-alpha-6version>
  9. extension>
  10. extensions>
  11. build>
    repository 对应于你的开发库,用户信息通过settings.xml中的server取得 Profiles 类似于settings.xml中的profiles,增加了几个元素,如下的样式:

xml 代码

  1. testid>
  2. ...activation>
  3. ...build>
  4. ...modules>
  5. ...repositories>
  6. ...pluginRepositories>
  7. ...dependencies>
  8. ...reporting>
  9. ...dependencyManagement>
  10. ...distributionManagement>
  11. profile>
  12. profiles>
希望本站内容对您有点用处,有什么疑问或建议请在后面留言评论
转载请注明作者(RobinChia)和出处 It so life ,请勿用于任何商业用途