Maven pom.xml配置详解

不念不忘少年蓝@ 2022-06-16 10:17 288阅读 0赞

基础设置

1.Parent

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

2.modelVersion

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

3.groupId

  1. <!-- 项目的全球唯一标识符,通常使用全限定的包名区分该项目和其他项目。并且构建时生成的路径也是由此生成, 如com.mycompany.app生成的相对路径为:/com/mycompany/app -->
  2. <groupId> asia.banseon </groupId>

4.artifactId

  1. <!-- 构件的标识符,它和group ID一起唯一标识一个构件。换句话说,你不能有两个不同的项目拥有同样的artifact ID和groupID;在某个特定的group ID下,artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西,Maven为项目产生的构件包括:JARs,源码,二进制发布和WARs等。 -->
  2. <artifactId> banseon-maven2 </artifactId>

5.packaging

  1. <!-- 项目产生的构件类型,例如jar、war、ear、pom。插件可以创建他们自己的构件类型,所以前面列的不是全部构件类型 -->
  2. <packaging> jar </packaging>

6.version

  1. <!-- 项目当前版本,格式为:主版本.次版本.增量版本-限定版本号 -->
  2. <version> 1.0-SNAPSHOT </version>

7.name

  1. <!-- 项目的名称, Maven产生的文档用 -->
  2. <name> banseon-maven </name>

8.url

  1. <!-- 项目主页的URL, Maven产生的文档用 -->
  2. <url> http://www.baidu.com/banseon </url>

9.description

  1. <!-- 项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时(例如,CDATA中的文本会被解析器忽略,就可以包含HTML标签), 不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面,你应该修改你自己的索引页文件,而不是调整这里的文档。 -->
  2. <description> A maven project to study maven. </description>

10.dependencies

  1. <!-- 项目引入插件所需要的额外依赖 -->
  2. <dependencies>
  3. <!-- 参见dependencies/dependency元素 -->
  4. <dependency>
  5. </dependency>
  6. </dependencies>

11.dependencyManagement

  1. <!-- 继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖(必须描述group ID和artifact ID信息),如果group ID和artifact ID以外的一些信息没有描述,则通过group ID和artifact ID匹配到这里的依赖,并使用这里的依赖信息。 -->
  2. <dependencyManagement>
  3. <dependencies>
  4. <!-- 参见dependencies/dependency元素 -->
  5. <dependency>

12.module

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

13.properties

  1. <!-- 项目开发者属性,如即时消息如何处理等 -->
  2. <properties>
  3. <dept> No </dept>
  4. </properties>

构建配置

1.build

  1. <!-- 构建项目所需要的信息。参见build元素 --> <build> <!-- 当项目没有规定目标(Maven2 叫做阶段)时的默认值 --> <defaultGoal> <!-- 这个元素描述了项目相关的所有资源路径列表,例如和项目相关的属性文件,这些资源被包含在最终的打包文件里。 --> <resources> <!-- 这个元素描述了项目相关或测试相关的所有资源路径 --> <resource> <!-- 描述了资源的目标路径。该路径相对target/classes目录(例如${project.build.outputDirectory})。举个例子,如果你想资源在特定的包里(org.apache.maven.messages),你就必须该元素设置为org/apache/maven/messages。然而,如果你只是想把资源放到源码目录结构里,就不需要该配置。 --> <targetPath</targetPath> <!-- 是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性,文件在filters元素里列出。 --> <filtering /> <!-- 描述存放资源的目录,该路径相对POM路径 --> <directory /> <!-- 包含的模式列表,例如**/*.xml. --> <includes /> <!-- 排除的模式列表,例如**/*.xml --> <excludes /> </resource> </resources> <!-- 这个元素描述了单元测试相关的所有资源路径,例如和单元测试相关的属性文件。 --> <testResources> <testResource> <targetPath /> <filtering /> <directory /> <includes /> <excludes /> </testResource> </testResources> <!-- 构建产生的所有文件存放的目录 --> <directory /> <!-- 产生的构件的文件名,默认值是${artifactId}-${version}。 --> <finalName /> <!-- 当filtering开关打开时,使用到的过滤器属性文件列表 --> <filters /> <!-- 子项目可以引用的默认插件信息。该插件配置项直到被引用时才会被解析或绑定到生命周期。给定插件的任何本地配置都会覆盖这里的配置 --> <pluginManagement> <!-- 使用的插件列表 。 --> <plugins> <!-- plugin元素包含描述插件所需要的信息。 --> <plugin> <!-- 插件在仓库里的group ID --> <groupId /> <!-- 插件在仓库里的artifact ID --> <artifactId /> <!-- 被使用的插件的版本(或版本范围) --> <version /> <!-- 是否从该插件下载Maven扩展(例如打包和类型处理器),由于性能原因,只有在真需要下载时,该元素才被设置成enabled。 --> <extensions /> <!-- 在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 --> <executions> <!-- execution元素包含了插件执行需要的信息 --> <execution> <!-- 执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标 --> <id /> <!-- 绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段 --> <phase /> <!-- 配置的执行目标 --> <goals /> <!-- 配置是否被传播到子POM --> <inherited /> <!-- 作为DOM对象的配置 --> <configuration /> </execution> </executions> <dependencies> <dependency></dependency> </dependencies> <goals /> <inherited /> <configuration /> </plugin> </plugins> </pluginManagement> <plugins> <plugin> <groupId /> <artifactId /> <version /> <extensions /> <executions> <execution> <id /> <phase /> <goals /> <inherited /> <configuration /> </execution> </executions> <dependencies> <dependency></dependency> </dependencies> <goals /> <inherited /> <configuration /> </plugin> </plugins> </build>

2.reporting

  1. <!-- 该元素包括使用报表插件产生报表的规范。当用户执行“mvn site”,这些报表就会运行。 在页面导航栏能看到所有报表的链接。参见reporting元素 -->
  2. <reporting></reporting>

更多项目信息

1.inceptionYear

  1. <!-- 项目创建年份,4位数字。当产生版权信息时需要使用这个值。 -->
  2. <inceptionYear />

2.licenses

  1. <!-- 该元素描述了项目所有License列表。 应该只列出该项目的license列表,不要列出依赖项目的 license列表。如果列出多个license,用户可以选择它们中的一个而不是接受所有license。 -->
  2. <licenses>
  3. <!-- 描述了项目的license,用于生成项目的web站点的license页面,其他一些报表和validation也会用到该元素。 -->
  4. <license>

3.organization

  1. <!-- 项目开发者所属组织 -->
  2. <organization> demo </organization>

4.organizationUrl

  1. <!-- 项目开发者所属组织的URL -->
  2. <organizationUrl> http://hi.baidu.com/banseon </organizationUrl>

5.developers

  1. <!-- 项目开发者列表 -->
  2. <developers>
  3. <!-- 某个项目开发者的信息 -->
  4. <developer>

6.contributors

  1. <!-- 项目的其他贡献者列表 -->
  2. <contributors>
  3. <!-- 项目的其他贡献者。参见developers/developer元素 -->
  4. <contributor>
  5. <name />
  6. <email />
  7. <url />
  8. <organization />
  9. <organizationUrl />
  10. <roles />
  11. <timezone / ><properties />
  12. </contributor>
  13. </contributors>

环境配置

1.issueManagement

  1. <!-- 项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL,本例为 jira -->
  2. <issueManagement>
  3. <!-- 问题管理系统(例如jira)的名字, -->
  4. <system> jira </system>
  5. <!-- 该项目使用的问题管理系统的URL -->
  6. <url> http://jira.baidu.com/banseon </url>
  7. </issueManagement>

2.ciManagement

  1. <ciManagement>
  2. <!-- 持续集成系统的名字,例如continuum -->
  3. <system />
  4. <!-- 该项目使用的持续集成系统的URL(如果持续集成系统有web接口的话)。 -->
  5. <url />
  6. <!-- 构建完成时,需要通知的开发者/用户的配置项。包括被通知者信息和通知条件(错误,失败,成功,警告) -->
  7. <notifiers>
  8. <!-- 配置一种方式,当构建中断时,以该方式通知用户/开发者 -->
  9. <notifier>
  10. <!-- 传送通知的途径 -->
  11. <type />
  12. <!-- 发生错误时是否通知 -->
  13. <sendOnError />
  14. <!-- 构建失败时是否通知 -->
  15. <sendOnFailure />
  16. <!-- 构建成功时是否通知 -->
  17. <sendOnSuccess />
  18. <!-- 发生警告时是否通知 -->
  19. <sendOnWarning />
  20. <!-- 不赞成使用。通知发送到哪里 -->
  21. <address />
  22. <!-- 扩展配置项 -->
  23. <configuration />
  24. </notifier>
  25. </notifiers>
  26. </ciManagement>

3.mailingLists

  1. <!-- 项目相关邮件列表信息 -->
  2. <mailingLists>
  3. <!-- 该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 -->
  4. <mailingList>

4.scm

  1. <!-- SCM(Source Control Management)标签允许你配置你的代码库,供Maven web站点和其它插件使用。 -->
  2. <scm>
  3. <!-- SCM的URL,该URL描述了版本库和如何连接到版本库。欲知详情,请看SCMs提供的URL格式和列表。该连接只读。 -->
  4. <connection>
  5. scm:svn:http://svn.baidu.com/banseon/maven/banseon/banseon-maven2-trunk(dao-trunk)
  6. </connection>
  7. <!-- 给开发者使用的,类似connection元素。即该连接不仅仅只读 -->
  8. <developerConnection>
  9. scm:svn:http://svn.baidu.com/banseon/maven/banseon/dao-trunk
  10. </developerConnection>
  11. <!-- 当前代码的标签,在开发阶段默认为HEAD -->
  12. <tag />
  13. <!-- 指向项目的可浏览SCM库(例如ViewVC或者Fisheye)的URL。 -->
  14. <url> http://svn.baidu.com/banseon </url>
  15. </scm>

4.prerequisites

  1. <!-- 描述了这个项目构建环境中的前提条件。 -->
  2. <prerequisites>
  3. <!-- 构建该项目或使用该插件所需要的Maven的最低版本 -->
  4. <maven />
  5. </prerequisites>

5.repositories

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

6.pluginRepositories

  1. <!-- 发现插件的远程仓库列表,这些插件用于构建和报表 -->
  2. <pluginRepositories>
  3. <!-- 包含需要连接到远程插件仓库的信息.参见repositories/repository元素 -->
  4. <pluginRepository></pluginRepository>
  5. </pluginRepositories>

7.distributionManagement

  1. <!-- 项目分发信息,在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者把构件部署到远程仓库。 -->
  2. <distributionManagement>
  3. <!-- 部署项目产生的构件到远程仓库需要的信息 -->
  4. <repository>
  5. <!-- 是分配给快照一个唯一的版本号(由时间戳和构建流水号)?还是每次都使用相同的版本号?参见repositories/repository元素 -->
  6. <uniqueVersion />
  7. <id> banseon-maven2 </id>
  8. <name> banseon maven2 </name>
  9. <url> file://${basedir}/target/deploy </url>
  10. <layout />
  11. </repository>
  12. <!-- 构件的快照部署到哪里?如果没有配置该元素,默认部署到repository元素配置的仓库,参见distributionManagement/repository元素 -->
  13. <snapshotRepository>
  14. <uniqueVersion />
  15. <id> banseon-maven2 </id>
  16. <name> Banseon-maven2 Snapshot Repository </name>
  17. <url> scp://svn.baidu.com/banseon:/usr/local/maven-snapshot </url>
  18. <layout />
  19. </snapshotRepository>
  20. <!-- 部署项目的网站需要的信息 -->
  21. <site>
  22. <!-- 部署位置的唯一标识符,用来匹配站点和settings.xml文件里的配置 -->
  23. <id> banseon-site </id>
  24. <!-- 部署位置的名称 -->
  25. <name> business api website </name>
  26. <!-- 部署位置的URL,按protocol://hostname/path形式 -->
  27. <url>
  28. scp://svn.baidu.com/banseon:/var/www/localhost/banseon-web
  29. </url>
  30. </site>
  31. <!-- 项目下载页面的URL。如果没有该元素,用户应该参考主页。使用该元素的原因是:帮助定位那些不在仓库里的构件(由于license限制)。 --> <downloadUrl />
  32. <!-- 如果构件有了新的group ID和artifact ID(构件移到了新的位置),这里列出构件的重定位信息。 -->
  33. <relocation>
  34. <!-- 构件新的group ID -->
  35. <groupId />
  36. <!-- 构件新的artifact ID -->
  37. <artifactId />
  38. <!-- 构件新的版本号 -->
  39. <version />
  40. <!-- 显示给用户的,关于移动的额外信息,例如原因。 -->
  41. <message />
  42. </relocation>
  43. <!-- 给出该构件在远程仓库的状态。不得在本地项目中设置该元素,因为这是工具自动更新的。有效的值有:none(默认),converted(仓库管理员从Maven 1 POM转换过来),partner(直接从伙伴Maven 2仓库同步过来),deployed(从Maven 2实例部署),verified(被核实时正确的和最终的)。 -->
  44. <status />
  45. </distributionManagement>

8.profiles

  1. <!-- 在列的项目构建profile,如果被激活,会修改构建处理 -->
  2. <profiles>
  3. <!-- 根据环境参数或命令行参数激活某个构建处理 -->
  4. <profile>

发表评论

表情:
评论列表 (有 0 条评论,288人围观)

还没有评论,来说两句吧...

相关阅读

    相关 Maven配置详解

    *1.去Maven官网http://maven.apache.org/download.cgi\下载安装包(根据自己的系统去安装相应的版本)** ![在这里插入图片描...

    相关 maven pom.xml配置详解

    setting.xml主要用于配置maven的运行环境等一系列通用的属性,是全局级别的配置文件;而pom.xml主要描述了项目的maven坐标,依赖关系,开发者需要遵循的规则,

    相关 Maven配置详解

    最近在阅读《Maven实战》这本书,分享阅读后对POM学习的心得。 由于本人学习搭建maven项目使用的IDE是idea,因此对于idea的mavenProject中Lif