Maven2完全使用手册 -

pan33

浏览: 26462 次
性别:
来自: 杭州

最近访客更多访客>>

jyxyyzq

gavenQin

小戴伤不起

衣清贰佰

博主相关

博客

微博

相册

留言

关于我

文章分类

社区版块

存档分类

Maven2完全使用手册

maven 配置管理 XML Ant Eclipse

Maven2完全使用手册

(本文引用自 http://blog.csdn.net/wind5shy/archive/2007/10/18/1830826.aspx)

maven2 起步

    相信maven1 大家都已经很熟悉了，具体maven能做什么，就不详细说了。个人觉得maven在开源项目中用的还是比较多的，公司内部，就不太清楚了。我以前的公司用过一段时间，不过后来就没有下文了。
    与maven1 相比，maven2可算是几乎重写了，不过从速度来说应该更快。
    主要的几个新特性包括：（详细参考http://www.ibm.com/developerworks/cn/opensource/os-maven2/index.html）
    1．更快、更简单
        速度方面可以比上ant了
    2．更少的配置文件
        现在的配置文件只剩下了settings.xml和pom.xml了。
    3. Plugin语言更换
      语言开始支持java,BeanShell和ant
    4. 提供了预定义的模版
        这点是最有帮助的，用户可以自己定义自己的项目模版了，就像用appfuse一样生成项目结构
    5．生命周期的引入
         在Maven2中有了明确的生命周期概念，而且都提供与之对应的命令，使得项目构建更加清晰明了。
    6. 新增Dependency Scope
         这点也比较重要，有些用于test范围的包，可以不用加入依赖了
    7. 传递依赖，简化依赖管理
        这是最为方便的，可以省了很多配置。如a 依赖 b,b 依赖c 默认 a也会依赖 c。但是也会带来隐患，如版本冲突。不过maven 也已经考虑到了，可以使用exclusions来排除相应的重复依赖

介绍了那么多，现在切入正题，开始maven2 之旅：
首些下载需要的工具：
maven2: http://maven.apache.org/download.html 最主要的
maven-proxy：用来代理repository，使用本地库代替maven2的远程库
            http://maven-proxy.codehaus.org/
continuum：一个不错的持续整合工具，用于自动build。支持ant,maven
http://maven.apache.org/continuum/
svn:版本控制工具相信都已经配置了。
maven 用于eclipse的插件 ,在maven主站有下载，不错的插件。当然idea也有相应的插件
最后，http，服务器是必不可少的。用于内部开发使用。
可以使用apache ，或者jetty http://www.mortbay.org/

安装：
    安装maven2很简单，把下载来的maven包解开就行了。（目前我的配置都在win2003上，还没有应用于linux，所有所有的配置都针对 windows).增加相应的环境变量m2_home=maven2的安装目录，不要忘了设置java_home的目录。另外在path中增加% m2_home%\bin;可以直接在命令行下面使用mvn。
其他工具的安装在后续的文章会介绍。

开始第一个mvean2项目：
mvn archetype:create -DgroupId=com.mycompany.app \
                   -DartifactId=my-app
简单介绍一下 groupId相当于你的组织，如同org.springframework，会转化为相应得本地路径 artifactId，你主要的jar包名称，也就是你要打成的jar 名称。
编译应用资源
    mvn compile
        编译相应的jave 文件
编译测试类以及运行测试类
    mvn test
       运行测试类
如果只想编译test，执行
    mvn test-compile
打包和安装你的本地库
打包：
    mvn package
安装：
    mvn install
创建web site
    mvn site
清除所有输出
    mvn clean
创建相关的ide文件
    mvn idea:idea        或者    mvn eclipse:eclipse

    顺便说一下，maven2 是有生命周期这一概念的，也就是说如果你执行package，相应的以前步骤，如compile,test等都会自动执行。
刚开始执行会比较慢，需要从maven2远程库中下载所有的文件到本地。如果你的本地没有相应的依赖包，则每次maven都会去远程下载，所以配置一个镜像库就比较重要了。
    另外介绍一下主要的参考资料：
    mavn2 主站：主要的pom和settings.xml参考资料
    Better Builds with Maven     http://www.mergere.com/m2book_download.jsp
    不错的书，主要通过例子介绍。可惜都是E文的，花点时间还是值得的。
    下一个主题，会说一下maven2的主要配置。

maven 配置篇之 settings.xml

    maven2 比起maven1 来说，需要配置的文件少多了，主要集中在pom.xml和settings.xml中。
    先来说说settings.xml，settings.xml对于maven来说相当于全局性的配置，用于所有的项目。在maven2中存在两个 settings.xml，一个位于maven2的安装目录conf下面，作为全局性配置。对于团队设置，保持一致的定义是关键，所以 maven2/conf下面的settings.xml就作为团队共同的配置文件。保证所有的团队成员都拥有相同的配置。当然对于每个成员，都需要特殊的自定义设置，如用户信息，所以另外一个settings.xml就作为本地配置。默认的位置为：${user.dir} /.m2/settings.xml目录中（${user.dir} 指windows 中的用户目录）。
    settings.xml基本结构如下：
    <settings 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/settings-1.0.0.xsd">
<localRepository/>
<interactiveMode/>
<usePluginRegistry/>
<offline/>
<pluginGroups/>
<servers/>
<mirrors/>
<proxies/>
<profiles/>
<activeProfiles/>
</settings>
简单介绍一下几个主要的配置因素：
localRepository：表示本地库的保存位置，也就是maven2主要的jar保存位置，默认在${user.dir}/.m2/repository，如果需要另外设置，就换成其他的路径。
offline：如果不想每次编译，都去查找远程中心库，那就设置为true。当然前提是你已经下载了必须的依赖包。
Servers
   在POM中的 distributionManagement元素定义了开发库。然而，特定的username和pwd不能使用于pom.xml，所以通过此配置来保存server信息
<servers>
    <server>
      <id>server001</id>
      <username>my_login</username>
      <password>my_password</password>
      <privateKey>${usr.home}/.ssh/id_dsa</privateKey>
      <passphrase>some_passphrase</passphrase>
      <filePermissions>664</filePermissions>
      <directoryPermissions>775</directoryPermissions>
      <configuration></configuration>
    </server>
</servers>

id:server 的id,用于匹配distributionManagement库id，比较重要。
username, password:用于登陆此服务器的用户名和密码
privateKey, passphrase：设置private key，以及passphrase
filePermissions, directoryPermissions：当库文件或者目录创建后，需要使用权限进行访问。参照unix文件许可，如664和775

Mirrors
表示镜像库，指定库的镜像，用于增加其他库
<mirrors>
    <mirror>
      <id>planetmirror.com</id>
      <name>PlanetMirror Australia</name>
      <url>http://downloads.planetmirror.com/pub/maven2</url>
      <mirrorOf>central</mirrorOf>
    </mirror>
</mirrors>

id,name:唯一的标志，用于区别镜像
url:镜像的url
mirrorOf：此镜像指向的服务id

Proxies
此设置，主要用于无法直接访问中心的库用户配置。
<proxies>
    <proxy>
      <id>myproxy</id>
      <active>true</active>
      <protocol>http</protocol>
      <host>proxy.somewhere.com</host>
      <port>8080</port>
      <username>proxyuser</username>
      <password>somepassword</password>
      <nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts>
    </proxy>
</proxies>

id:代理的标志
active：是否激活代理
protocol, host, port:protocol://host:port 代理
username, password：用户名和密码
nonProxyHosts: 不需要代理的host

Profiles
类似于pom.xml中的profile元素，主要包括activation,repositories,pluginRepositories 和properties元素
刚开始接触的时候，可能会比较迷惑，其实这是maven2中比较强大的功能。从字面上来说，就是个性配置。
单独定义profile后，并不会生效，需要通过满足条件来激活。
repositories 和pluginRepositories
定义其他开发库和插件开发库。对于团队来说，肯定有自己的开发库。可以通过此配置来定义。
如下的配置，定义了本地开发库，用于release 发布。
   <repositories>
        <repository>
          <id>repo-local</id>
       <name>Internal 开发库</name>
       <url>http://192.168.0.2:8082/repo-local</url>
          <releases>
            <enabled>true</enabled>
            <updatePolicy>never</updatePolicy>
            <checksumPolicy>warn</checksumPolicy>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
          <layout>default</layout>
        </repository>
      </repositories>
      <pluginRepositories>
   <pluginRepository>
   <id>repo-local</id>
   <name>Internal 开发库</name>
   <url>http://192.168.0.2:8082/repo-local</url>
   <releases>
            <enabled>true</enabled>
            <updatePolicy>never</updatePolicy>
            <checksumPolicy>warn</checksumPolicy>
    </releases>
    <snapshots>
   <enabled>false</enabled>
   </snapshots>
   <layout>default</layout>
   </pluginRepository>
   </pluginRepositories>
releases, snapshots:每个产品的版本的Release或者snapshot(注：release和snapshot的区别，release一般是比较稳定的版本，而snapshot基本上不稳定，只是作为快照）

properties
maven 的properties作为placeholder值，如ant的properties。
包括以下的5种类型值：

1. env.X，返回当前的环境变量

2. project.x:返回pom中定义的元素值，如project.version

3. settings.x：返回settings.xml中定义的元素

4. java 系统属性：所有经过java.lang.System.getProperties()返回的值

5. x：用户自己设定的值

Activation
用于激活此profile
<activation>
        <activeByDefault>false</activeByDefault>
        <jdk>1.5</jdk>
        <os>
          <name>Windows XP</name>
          <family>Windows</family>
          <arch>x86</arch>
          <version>5.1.2600</version>
        </os>
        <property>
          <name>mavenVersion</name>
          <value>2.0.3</value>
        </property>
        <file>
          <exists>${basedir}/file2.properties</exists>
          <missing>${basedir}/file1.properties</missing>
        </file>
      </activation>

jdk:如果匹配指定的jdk版本，将会激活
os:操作系统
property：如果maven能检测到相应的属性
file: 用于判断文件是否存在或者不存在

除了使用activation来激活profile，同样可以通过activeProfiles来激活
Active Profiles
表示激活的profile,通过profile id来指定。
<activeProfiles>
<activeProfile>env-test</activeProfile> 指定的profile id
</activeProfiles>

maven 配置篇之pom.xml

说完了settings.xml配置，下来说一下maven2的主要配置pom.xml
什么是pom?
    pom作为项目对象模型。通过xml表示maven项目，使用pom.xml来实现。主要描述了项目：包括配置文件；开发者需要遵循的规则，缺陷管理系统，组织和licenses，项目的url，项目的依赖性，以及其他所有的项目相关因素。
快速察看：
<project>
<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: 分类

POM关系：
主要为依赖，继承，合成
依赖关系：
<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你只包括指定的项目，不包括相关的依赖。此因素主要用于解决版本冲突问题
<dependencies>
    <dependency>
      <groupId>org.apache.maven</groupId>
      <artifactId>maven-embedder</artifactId>
      <version>2.0</version>

分享到：