maven2术语及POM简介

【转自：http://axl-224.iteye.com/blog/712595】

maven2术语

【转自：http://blog.csdn.net/totogogo/archive/2007/12/13/1933718.aspx】

Repository：仓库用于存放artifact，它可以是本地仓库，也可以是远程仓库。Maven有一个默认的远程仓库--central，可以从http://www.ibiblio.org/maven/下载其中的artifact。在Windows平台上，本地仓库的默认地址是C:\Documents and Settings\USER_NAME\.m2\repository。
Project：任何您想build的事物，Maven都可以认为它们是工程。这些工程被定义为工程对象模型(POM，Poject Object Model)。一个工程可以依赖其它的工程；一个工程也可以由多个子工程构成。

POM：POM(pom.xml)是Maven的核心文件，它是指示Maven如何工作的元数据文件，类似于Ant中的build.xml文件。POM文件位于每个工程的根目录中。    
Artifact：你的project通过maven生成的东东叫作artifact（project生成的jar就是一个典型的artifact）。需要被使用(依赖)的artifact都要放在仓库(见Repository)中，否则Maven无法找到 (识别)它们。

Dependency：为了能够build或运行，一个典型的Java工程会依赖其它的包。在Maven中，这些被依赖的包就被称为dependency。dependency一般是其它工程的artifact。
Plug-in：Maven是由插件组织的，它的每一个功能都是由插件提供的。插件提供goal(类似于Ant中的target)，并根据在POM中找到的元数据去完成工作。主要的Maven插件要是由Java写成的，但它也支持用Beanshell或Ant脚本写成的插件。    
Snapshot：工程中可以(也应该)有一个特殊版本，它的版本号包括SNAPSHOT字样。该版本可以告诉Maven，该工程正处于开发阶段，会经常更新(但还未发布)。当其它工程使用此类型版本的artifact时，Maven会在仓库中寻找该artifact的最新版本，并自动下载、使用该最新版。

POM简介

【转自：http://www.blogjava.net/zyl/archive/2006/12/30/91055.html】

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

 

Xml代码

1. <project>  
2.   <modelVersion>4.0.0</modelVersion>  

<project>
  <modelVersion>4.0.0</modelVersion>
  <!-- The Basics -->
  <groupId>...</groupId>
  <artifactId>...</artifactId>
  <version>...</version>
  <packaging>...</packaging>
  <dependencies>...</dependencies>
  <parent>...</parent>
  <dependencyManagement>...</dependencyManagement>
  <modules>...</modules>
  <properties>...</properties>

  <!-- Build Settings -->
  <build>...</build>
  <reporting>...</reporting>

  <!-- More Project Information -->
  <name>...</name>
  <description>...</description>
  <url>...</url>
  <inceptionYear>...</inceptionYear>
  <licenses>...</licenses>
  <organization>...</organization>
  <developers>...</developers>
  <contributors>...</contributors>

  <!-- Environment Settings -->
  <issueManagement>...</issueManagement>
  <ciManagement>...</ciManagement>
  <mailingLists>...</mailingLists> 
  <scm>...</scm>
  <prerequisites>...</prerequisites>
  <repositories>...</repositories>
  <pluginRepositories>...</pluginRepositories>
  <distributionManagement>...</distributionManagement>
  <profiles>...</profiles>
</project>

 

 

Xml代码

1.   

基本内容：
POM包括了所有的项目信息。
project：这是所有pom.xml文件中的最顶级元素，意即根元素。

modelVersion：此必需的元素说明了本POM所使用的模型版本。模型本身的版本很少改变，虽然如此，但它仍然是必不可少的，以当Maven引入了新的特性或者其他模型变更的时候，确保稳定性。

Maven2关系：pom定义了最小的maven2元素，允许groupId,artifactId,version所有需要的元素

groupId:项目或者组织的唯一标志，并且配置时生成的路径也是由此生成，   

 org.codehaus.mojo生成的相对路径为：/org/codehaus/mojo
artifactId: 项目的通用名称，一个典型的由Maven生成的项目名称将会是如下的格式：<artifactId>-<version>.<extension>（例如：myapp-1.0.jar），其他部分诸如源包也使用artifactId作为它们名称的一部分。 
version:项目的版本，Maven对于你的版本管理大有帮助，你会经常看到一个版本的SNAPSHOT（快照），指示项目在开发中的不同状态。 
packaging: 打包的机制，如pom, jar, maven-plugin, ejb, war, ear, rar, par ，本元素的默认值是jar，因此在大多数情况下，你不需要去特别指定。
classifier: 分类
POM关系：主要为依赖，继承，合成
依赖关系：

Xml代码

1. <dependencies>  
2.    <dependency>  
3.      <groupId>junit</groupId>  
4.      <artifactId>junit</artifactId>  
5.      <version>4.0</version>  
6.      <type>jar</type>  
7.      <scope>test</scope>  
8.      <optional>true</optional>  
9.    </dependency>  
10.    ...   
11.  </dependencies>  

 <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.0</version>
      <type>jar</type>
      <scope>test</scope>
      <optional>true</optional>
    </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代码

1. <dependencies>  
2.   <dependency>  
3.     <groupId>org.apache.maven</groupId>  
4.     <artifactId>maven-embedder</artifactId>  
5.     <version>2.0</version>  
6.     <exclusions>  
7.       <exclusion>  
8.         <groupId>org.apache.maven</groupId>  
9.         <artifactId>maven-core</artifactId>  
10.       </exclusion>  
11.     </exclusions>  
12.   </dependency>  

  <dependencies>
    <dependency>
      <groupId>org.apache.maven</groupId>
      <artifactId>maven-embedder</artifactId>
      <version>2.0</version>
      <exclusions>
        <exclusion>
          <groupId>org.apache.maven</groupId>
          <artifactId>maven-core</artifactId>
        </exclusion>
      </exclusions>
    </dependency>

 

表示项目maven-embedder需要项目maven-core，但我们不想引用maven-core

继承关系
    另一个强大的变化,maven带来的是项目继承。主要的设置：
定义父项目

Xml代码

1. <project>  
2.   <modelVersion>4.0.0</modelVersion>  
3.   <groupId>org.codehaus.mojo</groupId>  
4.   <artifactId>my-parent</artifactId>  
5.   <version>2.0</version>  
6.   <packaging>pom</packaging>  
7. </project>  

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>my-parent</artifactId>
  <version>2.0</version>
  <packaging>pom</packaging>
</project>

 

    packaging 类型，需要pom用于parent和合成多个项目。我们需要增加相应的值给父pom，用于子项目继承。主要的元素如下：

依赖型
开发者和合作者
插件列表
报表列表
插件执行使用相应的匹配ids
插件配置
子项目配置

Xml代码

1. <project>  
2.   <modelVersion>4.0.0</modelVersion>  
3.   <parent>  
4.     <groupId>org.codehaus.mojo</groupId>  
5.     <artifactId>my-parent</artifactId>  
6.     <version>2.0</version>  
7.     <relativePath>../my-parent</relativePath>  
8.   </parent>  
9.   <artifactId>my-project</artifactId>  
10. </project>  

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>my-parent</artifactId>
    <version>2.0</version>
    <relativePath>../my-parent</relativePath>
  </parent>
  <artifactId>my-project</artifactId>
</project>

 

relativePath可以不需要，但是用于指明parent的目录，用于快速查询。

dependencyManagement：用于父项目配置共同的依赖关系，主要配置依赖包相同因素，如版本，scope。

合成（或者多个模块）
    一个项目有多个模块，也叫做多重模块，或者合成项目。
如下的定义：

Xml代码

1. <project>  
2.   <modelVersion>4.0.0</modelVersion>  
3.   <groupId>org.codehaus.mojo</groupId>  
4.   <artifactId>my-parent</artifactId>  
5.   <version>2.0</version>  
6.   <modules>  
7.     <module>my-project1<module>  
8.     <module>my-project2<module>  
9.   </modules>  
10. </project>   

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>my-parent</artifactId>
  <version>2.0</version>
  <modules>
    <module>my-project1<module>
    <module>my-project2<module>
  </modules>
</project> 

build 设置： 主要用于编译设置，包括两个主要的元素，build和report
build主要分为两部分，基本元素和扩展元素集合
注意：包括项目build和profile build

Xml代码

1. <project>  
2.   <!-- "Project Build" contains more elements than just the BaseBuild set -->  
3.   <build>...</build>  
4.   <profiles>  
5.     <profile>  
6.       <!-- "Profile Build" contains a subset of "Project Build"s elements -->  
7.       <build>...</build>  
8.     </profile>  
9.   </profiles>  
10. </project>  

<project>
  <!-- "Project Build" contains more elements than just the BaseBuild set -->
  <build>...</build>
  <profiles>
    <profile>
      <!-- "Profile Build" contains a subset of "Project Build"s elements -->
      <build>...</build>
    </profile>
  </profiles>
</project>

 

基本元素

Xml代码

1. <build>  
2.   <defaultGoal>install</defaultGoal>  
3.   <directory>${basedir}/target</directory>  
4.   <finalName>${artifactId}-${version}</finalName>  
5.   <filters>  
6.     <filter>filters/filter1.properties</filter>  
7.   </filters>  
8.   ...   
9. </build>  

<build>
  <defaultGoal>install</defaultGoal>
  <directory>${basedir}/target</directory>
  <finalName>${artifactId}-${version}</finalName>
  <filters>
    <filter>filters/filter1.properties</filter>
  </filters>
  ...
</build>

 

defaultGoal: 定义默认的目标或者阶段。如install
directory: 编译输出的目录
finalName: 生成最后的文件的样式
filter: 定义过滤，用于替换相应的属性文件，使用maven定义的属性。设置所有placehold的值

资源(resources)： 你项目中需要指定的资源。如spring配置文件,log4j.properties

Xml代码

1. <project>  
2.   <build>  
3.     ...   
4.     <resources>  
5.       <resource>  
6.         <targetPath>META-INF/plexus</targetPath>  
7.         <filtering>false</filtering>  
8.         <directory>${basedir}/src/main/plexus</directory>  
9.         <includes>  
10.           <include>configuration.xml</include>  
11.         </includes>  
12.         <excludes>  
13.           <exclude>**/*.properties</exclude>  
14.         </excludes>  
15.       </resource>  
16.     </resources>  
17.     <testResources>  
18.       ...   
19.     </testResources>  
20.     ...   
21.   </build>  
22. </project>   

<project>
  <build>
    ...
    <resources>
      <resource>
        <targetPath>META-INF/plexus</targetPath>
        <filtering>false</filtering>
        <directory>${basedir}/src/main/plexus</directory>
        <includes>
          <include>configuration.xml</include>
        </includes>
        <excludes>
          <exclude>**/*.properties</exclude>
        </excludes>
      </resource>
    </resources>
    <testResources>
      ...
    </testResources>
    ...
  </build>
</project> 

 

resources: resource的列表，用于包括所有的资源
targetPath: 指定目标路径，用于放置资源，用于build
filtering: 是否替换资源中的属性placehold
directory: 资源所在的位置
includes: 样式，包括那些资源
excludes: 排除的资源
testResources: 测试资源列表

插件：在build时，执行的插件，比较有用的部分，如使用jdk 5.0编译等等

Xml代码

1. <project>  
2.   <build>  
3.     ...   
4.     <plugins>  
5.       <plugin>  
6.         <groupId>org.apache.maven.plugins</groupId>  
7.         <artifactId>maven-jar-plugin</artifactId>  
8.         <version>2.0</version>  
9.         <extensions>false</extensions>  
10.         <inherited>true</inherited>  
11.         <configuration>  
12.           <classifier>test</classifier>  
13.         </configuration>  
14.         <dependencies>...</dependencies>  
15.         <executions>...</executions>  
16.       </plugin>  
17.     </plugins>  
18.   </build>  
19. </project>  

<project>
  <build>
    ...
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <version>2.0</version>
        <extensions>false</extensions>
        <inherited>true</inherited>
        <configuration>
          <classifier>test</classifier>
        </configuration>
        <dependencies>...</dependencies>
        <executions>...</executions>
      </plugin>
    </plugins>
  </build>
</project>

 
extensions: true or false，是否装载插件扩展。默认false
inherited: true or false，是否此插件配置将会应用于poms，那些继承于此的项目
configuration: 指定插件配置
dependencies: 插件需要依赖的包
executions: 用于配置execution目标，一个插件可以有多个目标。
如下：

Xml代码

1. <plugin>  
2.     <artifactId>maven-antrun-plugin</artifactId>  
3.     <executions>  
4.       <execution>  
5.         <id>echodir</id>  
6.         <goals>  
7.           <goal>run</goal>  
8.         </goals>  
9.         <phase>verify</phase>  
10.         <inherited>false</inherited>  
11.         <configuration>  
12.           <tasks>  
13.             <echo>Build Dir: ${project.build.directory}</echo>  
14.           </tasks>  
15.         </configuration>  
16.       </execution>  
17.     </executions>  
18.   </plugin>  

    <plugin>
        <artifactId>maven-antrun-plugin</artifactId>
        <executions>
          <execution>
            <id>echodir</id>
            <goals>
              <goal>run</goal>
            </goals>
            <phase>verify</phase>
            <inherited>false</inherited>
            <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代码

1. <build>  
2.    <sourceDirectory>${basedir}/src/main/java</sourceDirectory>  
3.    <scriptSourceDirectory>${basedir}/src/main/scripts</scriptSourceDirectory>  
4.    <testSourceDirectory>${basedir}/src/test/java</testSourceDirectory>  
5.    <outputDirectory>${basedir}/target/classes</outputDirectory>  
6.    <testOutputDirectory>${basedir}/target/test-classes</testOutputDirectory>  
7.    ...   
8.  </build>  

 <build>
    <sourceDirectory>${basedir}/src/main/java</sourceDirectory>
    <scriptSourceDirectory>${basedir}/src/main/scripts</scriptSourceDirectory>
    <testSourceDirectory>${basedir}/src/test/java</testSourceDirectory>
    <outputDirectory>${basedir}/target/classes</outputDirectory>
    <testOutputDirectory>${basedir}/target/test-classes</testOutputDirectory>
    ...
  </build>

Extensions表示需要扩展的插件，必须包括进相应的build路径。

Xml代码

1. <project>  
2.   <build>  
3.     ...   
4.     <extensions>  
5.       <extension>  
6.         <groupId>org.apache.maven.wagon</groupId>  
7.         <artifactId>wagon-ftp</artifactId>  
8.         <version>1.0-alpha-3</version>  
9.       </extension>  
10.     </extensions>  
11.     ...   
12.   </build>  
13. </project>   

<project>
  <build>
    ...
    <extensions>
      <extension>
        <groupId>org.apache.maven.wagon</groupId>
        <artifactId>wagon-ftp</artifactId>
        <version>1.0-alpha-3</version>
      </extension>
    </extensions>
    ...
  </build>
</project> 

Reporting用于在site阶段输出报表。特定的maven 插件能输出相应的定制和配置报表。

Xml代码

1. <reporting>  
2.    <plugins>  
3.      <plugin>  
4.        <outputDirectory>${basedir}/target/site</outputDirectory>  
5.        <artifactId>maven-project-info-reports-plugin</artifactId>  
6.        <reportSets>  
7.          <reportSet&g