maven的POM结构

类别:Java 点击:0 评论:0 推荐:


几个英文词汇的翻译对照,有误请指正

repository 资源库
project 项目
artifact 构件(可以理解为jar文件去掉版本号和.jar的文件名)

看看我们在《maven安装使用》中创建的project,里面有一个project.xml文件和project.properties文件。project.xml文件被称作maven管理项目的核心,并起了个名字Project Object Model (POM),该 XML 文件格式由位于 Maven 安装目录中的 XML 模式(maven-project.xsd)定义。

下面我们看看POM的框架示例:(以jetspeed-1为示例)

******主 project.xml 框架:******
<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- 根元素-->
<project>
  <!-- POM版本 -->
  <pomVersion>3</pomVersion>

  <!-- project标志. 和版本号在build中生成文件目录名。例如JAR文件遵从<id>-<version>约定 . -->
  <id>jetspeed</id>

  <!-- project名,用于生成Javadoc时的Title-->
  <name>jakarta-jetspeed</name>

  <!-- 版本号 -->
  <currentVersion>1.5</currentVersion>

  <!---------------------------------------------------- -->
  <!-- 项目管理部分                                                   -->
  <!---------------------------------------------------- -->

  <!---------------------------------------------------- -->
  <!-- 项目相关性部分                                                -->
  <!---------------------------------------------------- -->

  <!---------------------------------------------------- -->
  <!-- 项目build和reports部分                                       -->
  <!---------------------------------------------------- -->
</project>


******项目管理部分******
  <!---------------------------------------------------- -->
  <!-- 项目管理部分                                                   -->
  <!---------------------------------------------------- -->

  <!-- 管理project的组织,只需名字,可以有多个组织的attributes -->
  <organization>
  <name>Apache Software Foundation</name>
  <logo>images/apache-portals.gif</logo>
  <url>http://www.apache.org/</url>
  </organization>

  <!-- (OPTIONAL) 起始年份,四位数字,在生成copyright信息时引用 -->
  <inceptionYear>2000</inceptionYear>

  <!-- (OPTIONAL) 项目主package -->
  <package>org.apache.jetspeed</package>

  <!-- (OPTIONAL) 项目logo位置 (可以使用URL) -->
  <logo>/images/logo.gif</logo>

  <!-- (OPTIONAL) GUMP 资源库id. 只在使用GUMP时有用. -->
  <gumpRepositoryId>jakarta</gumpRepositoryId>

  <!-- (OPTIONAL) Project 描述,用于生成站点主页,在项目中使用maven --usage可以查看这个描述,其中至可以使用HTML标签,但是主页最好还是使用xdocs/index.xml -->
  <description>...</description>

  <!-- (OPTIONAL) project 描述,仅限一行  -->
  <shortDescription>...</shortDescription>

  <!-- (OPTIONAL) Project站点URL -->
  <url>http://portals.apache.org/jetspeed-1/</url>

  <!-- (OPTIONAL) 问题跟踪系统URL -->
  <issueTrackingUrl>http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10493</issueTrackingUrl>

  <!-- (OPTIONAL) Project站点地址. -->
  <siteAddress>portals.apache.org</siteAddress>

  <!-- (OPTIONAL) Project-site部署目录(physical location) -->
  <siteDirectory>/www/portals.apache.org/jetspeed-1/</siteDirectory>

  <!-- (OPTIONAL) 项目source-repository信息 -->
  <repository>
    <connection>scm:cvs:pserver:[email protected]:/home/cvspublic:jakarta-jetspeed</connection>
    <url>http://cvs.apache.org/viewcvs/jakarta-jetspeed/</url>
  </repository>

  <!-- (OPTIONAL) Mailing list信息 -->
  <mailingLists>
    <mailingList>
 <name>Jetspeed User List</name>
 <subscribe>[email protected]</subscribe>
 <unsubscribe>[email protected]</unsubscribe>
 <archive>http://nagoya.apache.org:8080/eyebrowse/[email protected]</archive>
    </mailingList>
    ......
 </mailingLists>

  <!-- 参加开发的人员 -->
  <developers>
    <developer>
 <name>Dave Blackett (Jetspeed logos)</name>
 <id/>
 <email>[email protected]</email>
 <organization/>
    </developer>
    ......
  </developers>

******项目相关性部分******与一个中央构件资源库一起使用,将消除几个常见的构建问题

  <!---------------------------------------------------- -->
  <!-- 项目相关性部分                                                -->
  <!---------------------------------------------------- -->

  <!--build过程中maven依据之建立classpath,并且maven会到remote repository自动下载这些dependencies ,如type是jar,下载的文件就是<artifactId>-<version>.jar-->
  <dependencies>

    <!-- 项目依赖JAR文件 "activation-1.0.1.jar",文件在Maven repository
   的activation/jars子目录,并且如果资源库中找不到,maven会在自动从maven.repo.remote下载(《maven安装使用》中提到的修改是因为maven的缺省设置远程资源库无法连接上)-->
  <dependency>
   <id>activation</id>
   <version>1.0.1</version>
   <properties>
    <war.bundle.jar>true</war.bundle.jar>
   </properties>
  </dependency>
  </dependencies>


groupId 告诉 Maven 资源库内哪个子目录中包含相关性文件。
artifactId 告诉 Maven 该构件的唯一标识。如果是jar文件,可以理解为去掉后缀和版本号的文件名 。
version 表示相关性的版本号。
jar  (可选的)表示相关性的 JAR 文件。在绝大多数情况下,可以从相关性的 <artifactId> 和 <version> 构造 JAR 文件的名称。
type  (可选的)相关性的类型;如 jar 和分发版等。缺省值是 jar。
url  可选的)相关性项目的 URL,在相关性是在因特网上找到的第三方库时非常有用。
properties dependency还有properties可以设定,具体要参照各自引用的plugin


******项目构建部分******
  <!---------------------------------------------------- -->
  <!-- 项目build和reports部分                                       -->
  <!---------------------------------------------------- -->

  <build>
    <!-- (OPTIONAL) 定义源文件位置. -->
    <sourceDirectory>src/java</sourceDirectory>

    <!-- (OPTIONAL) 定义单元测试源文件位置. -->
    <unitTestSourceDirectory>test/java</unitTestSourceDirectory>

    <!-- (OPTIONAL) 单元测试用例文件模式. -->
    <unitTest>
 <!-- 排除测试 -->
       <excludes>
          <exclude>org/apache/jetspeed/services/registry/TestRegistryCategories.java</exclude>
   ......
       </excludes>
       <!-- 包含测试 -->
 <includes>
    <include>**/Test*.java</include>
  </includes>
  <!-- 单元测试使用的资源 -->
  <resources>
      <resource>
          <!-- 资源位置,project.xml的相对路径 -->
   <directory>${basedir}/src/java</directory>
   <!-- 排除文件 -->
   <excludes>
    <exclude>**/*.java</exclude>
   </excludes>
   <!-- 包含文件 -->
   <includes>
    <include>org/apache/jetspeed/modules/localization/JetspeedLocalization_*.properties</include>
   </includes>
       </resource>   
       .......
  </resources>
   </unitTest>

   <!-- 项目使用的资源,结构与单元测试使用的资源结构相同 -->
 <resources>
     <resource>
 ......
      </resource>   
      .......
 </resources>

  <!-- (OPTIONAL) 使用maven site生成站点的时候被引用,并以指定的顺序排列在导航条内,report指定生成报告的plugin -->
  <reports>
    <report>
 <report>maven-tasklist-plugin</report>
 <report>maven-changelog-plugin</report>
 <report>maven-javadoc-plugin</report>
    </report>
  </reports>
</build>

这里只是对project.xml文件大致的说明,POM的详细说明在
http://maven.apache.org/reference/project-descriptor.html#resources
如果有兴趣,可以仔细观摩

本文地址:http://com.8s8s.com/it/it13532.htm