Chinaunix首页 | 论坛 | 博客
  • 博客访问: 1170846
  • 博文数量: 312
  • 博客积分: 12522
  • 博客等级: 上将
  • 技术积分: 3376
  • 用 户 组: 普通用户
  • 注册时间: 2008-02-27 18:35
文章分类

全部博文(312)

文章存档

2016年(3)

2015年(1)

2013年(1)

2012年(28)

2011年(101)

2010年(72)

2009年(13)

2008年(93)

分类: 项目管理

2010-04-21 00:18:37

maven2完全使用手册
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: 最主要的
maven-proxy:用来代理repository,使用本地库代替maven2的远程库
           
continuum:一个不错的持续整合工具,用于自动build。支持ant,maven

svn:版本控制工具相信都已经配置了。
maven 用于eclipse的插件 ,在maven主站有下载,不错的插件。当然idea也有相应的插件
最后,http,服务器是必不可少的。用于内部开发使用。
可以使用apache ,或者jetty 

安装:
    安装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    
    不错的书,主要通过例子介绍。可惜都是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基本结构如下:
              xmlns:xsi=""
          xsi:schemaLocation="
                               ">
 
 
 
 
 
 
 
 
 
 

简单介绍一下几个主要的配置因素:
localRepository:表示本地库的保存位置,也就是maven2主要的jar保存位置,默认在${user.dir}/.m2/repository,如果需要另外设置,就换成其他的路径。
offline:如果不想每次编译,都去查找远程中心库,那就设置为true。当然前提是你已经下载了必须的依赖包。
Servers
   在POM中的 distributionManagement元素定义了开发库。然而,特定的username和pwd不能使用于pom.xml,所以通过此配置来保存server信息
 
   
      server001
      my_login
      my_password
      ${usr.home}/.ssh/id_dsa
      some_passphrase
      664
      775
     
   

 

id:server 的id,用于匹配distributionManagement库id,比较重要。
username, password:用于登陆此服务器的用户名和密码
privateKey, passphrase:设置private key,以及passphrase
filePermissions, directoryPermissions:当库文件或者目录创建后,需要使用权限进行访问。参照unix文件许可,如664和775
Mirrors
表示镜像库,指定库的镜像,用于增加其他库
 
   
      planetmirror.com
      PlanetMirror Australia
      maven2
      central
   

 

id,name:唯一的标志,用于区别镜像
url:镜像的url
mirrorOf:此镜像指向的服务id
Proxies
此设置,主要用于无法直接访问中心的库用户配置。
 
   
      myproxy
      true
      http
      proxy.somewhere.com
      8080
      proxyuser
      somepassword
      *.google.com|ibiblio.org
   

 

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 发布。
   
       
          repo-local
       Internal 开发库
      
         
            true
            never
            warn
         

         
            false
         

          default
       

     

     
   
    repo-local
    Internal 开发库
   
   
            true
            never
            warn
   

   
    false
   

    default
   

   

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
 
        false
        1.5
       
          Windows XP
          Windows
          x86
          5.1.2600
       

       
          mavenVersion
          2.0.3
       

       
          ${basedir}/file2.properties
          ${basedir}/file1.properties
       

     

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

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



--------------------------------------------------------------------------------



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

  4.0.0

 
  ...
  ...
  ...
  ...
  ...
  ...
  ...
  ...
  ...

 
  ...
  ...

 
  ...
  ...
  ...
  ...
  ...
  ...
  ...
  ...

 
  ...
  ...
  ...
  ...
  ...
  ...
  ...
  ...
  ...


基本内容:
    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关系:
主要为依赖,继承,合成
  依赖关系:
 
   
      junit
      junit
      4.0
      jar
      test
      true
   

    ...
 

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你只包括指定的项目,不包括相关的依赖。此因素主要用于解决版本冲突问题
 
   
      org.apache.maven
      maven-embedder
      2.0
     
       
          org.apache.maven
          maven-core
       

     

   

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

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

  4.0.0
  org.codehaus.mojo
  my-parent
  2.0
  pom

    packaging 类型,需要pom用于parent和合成多个项目。我们需要增加相应的值给父pom,用于子项目继承。主要的元素如下:
依赖型
开发者和合作者
插件列表
报表列表
插件执行使用相应的匹配ids
插件配置
子项目配置

  4.0.0
 
    org.codehaus.mojo
    my-parent
    2.0
    ../my-parent
 

  my-project

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

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

合成(或者多个模块)
    一个项目有多个模块,也叫做多重模块,或者合成项目。
如下的定义:

  4.0.0
  org.codehaus.mojo
  my-parent
  2.0
 
    my-project1
    my-project2
 



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

 
  ...
 
   
     
      ...
   

 



基本元素

  install
  ${basedir}/target
  ${artifactId}-${version}
 
    filters/filter1.properties
 

  ...

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

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

 
    ...
   
     
        META-INF/plexus
        false
        ${basedir}/src/main/plexus
       
          configuration.xml
       

       
          **/*.properties
       

     

   

   
      ...
   

    ...
 


resources: resource的列表,用于包括所有的资源
targetPath: 指定目标路径,用于放置资源,用于build
filtering: 是否替换资源中的属性placehold
directory: 资源所在的位置
includes: 样式,包括那些资源
excludes: 排除的资源
testResources: 测试资源列表
插件
  在build时,执行的插件,比较有用的部分,如使用jdk 5.0编译等等

 
    ...
   
     
        org.apache.maven.plugins
        maven-jar-plugin
        2.0
        false
        true
       
          test
       

        ...
        ...
     

   

 


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

       
         
            echodir
           
              run
           

            verify
            false
           
             
                Build Dir: ${project.build.directory}
             

           

         

       

     

  说明:
id:规定execution 的唯一标志
goals: 表示目标
phase: 表示阶段,目标将会在什么阶段执行
inherited: 和上面的元素一样,设置false maven将会拒绝执行继承给子插件
configuration: 表示此执行的配置属性

插件管理
    pluginManagement:插件管理以同样的方式包括插件元素,用于在特定的项目中配置。所有继承于此项目的子项目都能使用。主要定义插件的共同元素

扩展元素集合
主要包括以下的元素:
Directories
用于设置各种目录结构,如下:
 
    ${basedir}/src/main/java
    ${basedir}/src/main/scripts
    ${basedir}/src/test/java
    ${basedir}/target/classes
    ${basedir}/target/test-classes
    ...
 


Extensions

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


 
    ...
   
     
        org.apache.maven.wagon
        wagon-ftp
        1.0-alpha-3
     

   

    ...
 



Reporting
    用于在site阶段输出报表。特定的maven 插件能输出相应的定制和配置报表。
 
   
     
        ${basedir}/target/site
        maven-project-info-reports-plugin
       
         
       

     

   

 


Report Sets
    用于配置不同的目标,应用于不同的报表

   
     
        ...
       
         
            sunlink
           
              javadoc
           

            true
           
             
               
             

           

         

       

     

   

 


更多的项目信息
name:项目除了artifactId外,可以定义多个名称
description: 项目描述
url: 项目url
inceptionYear:创始年份

Licenses

 
    Apache 2
   
    repo
    A business-friendly OSS license
 



Organization
配置组织信息
 
    Codehaus Mojo
   
 


Developers
配置开发者信息

   
      eric
      Eric
      eredmond@codehaus.org
     
      Codehaus
     
     
        architect
        developer
     

      -6
     
       
     

   

 


Contributors
 
   
      Noelle
      some.name@gmail.com
     
      Noelle Marie
     
     
        tester
     

      -5
     
        some.name@gmail.com
     

   

 


环境设置

Issue Management
    定义相关的bug跟踪系统,如bugzilla,testtrack,clearQuest等
 
    Bugzilla
   
 

Continuous Integration Management
连续整合管理,基于triggers或者timings
 
    continuum
   
   
     
        mail
        true
        true
        false
        false
       
continuum@127.0.0.1

     

   

 


Mailing Lists
 
   
      User List
      user-subscribe@127.0.0.1
      user-unsubscribe@127.0.0.1
      user@127.0.0.1
     
     
       
     

   

 


SCM
  软件配置管理,如cvs 和svn
 
    scm:svn:
    scm:svn:https://127.0.0.1/svn/my-project
    HEAD
   
 


Repositories

配置同setting.xml中的开发库

Plugin Repositories
配置同 repositories

Distribution Management
用于配置分发管理,配置相应的产品发布信息,主要用于发布,在执行mvn deploy后表示要发布的位置
1 配置到文件系统


proficio-repository
Proficio Repository
file://${basedir}/target/deploy


2 使用ssh2配置


proficio-repository
Proficio Repository
scp://sshserver.yourcompany.com/deploy


3 使用sftp配置


proficio-repository
Proficio Repository
sftp://ftpserver.yourcompany.com/deploy


4 使用外在的ssh配置
    编译扩展用于指定使用wagon外在ssh提供,用于提供你的文件到相应的远程服务器。


proficio-repository
Proficio Repository
scpexe://sshserver.yourcompany.com/deploy





org.apache.maven.wagon
wagon-ssh-external
1.0-alpha-6




5 使用ftp配置


proficio-repository
Proficio Repository
ftp://ftpserver.yourcompany.com/deploy





org.apache.maven.wagon
wagon-ftp
1.0-alpha-6




repository 对应于你的开发库,用户信息通过settings.xml中的server取得

Profiles
类似于settings.xml中的profiles,增加了几个元素,如下的样式:
 
   
      test
      ...
      ...
      ...
      ...
      ...
      ...
      ...
      ...
      ...
   

 



--------------------------------------------------------------------------------



使用maven2 进行团队配置
    对于团队来说,建立统一的开发环境是必须的,而maven能很好帮助建立统一的环境。下面就介绍如何更有效的进行统一的配置。
准备工作:
   下载必须的软件:
maven2: 最主要的
maven-proxy:用来代理repository,使用代理来访问多个远程库
           
continuum:一个不错的持续整合工具,用于自动build。支持ant,maven

svn:版本控制工具

创建一致的开发环境
  
    在共享的开发环境中,更好的建议是保持maven的两个不同的配置文件分别管理,包括共享和用户自定义设置。共同的配置包括在安装目录中,而单独的开发设置保存在用户本地目录。
   
    全局的配置文件settings.xml


       //公司内部库,所有的release版本,serverid对应于repository id,用于在deploy时,访问使用,主要保存用户名和密码

internal
${website.username}
${website.pwd}
664
775

//目前的开发库,用于snapshot库

snapshot
${website.username}
${website.pwd}
664
775






central-repo


central
Internal Repository





central
Internal Repository







internal-repo


internal
Internal Repository


true
never
warn





internal
Internal Plugin Repository


true
never
warn






snapshot-repo


snapshot
Internal Repository


true
interval:60
warn





snapshot
Internal Plugin Repository


true
interval:60
warn







central-repo
internal-repo
snapshot-repo



com.mycompany.plugins


包括了以下的共享因素:
服务器设置典型是共同的,只有用户名需要在用户环境中设置。使用一致的定义来配置共同的设置
profile定义了共同的因素,内部开发库,包括指定的组织或者部门发布的产品。这些库独立于核心开发库。
激活的profiles列表,用于激活相应的profile
plugin 组只有当你的组织中有自己定义的插件,用于命令行运行在pom中定义。
对于单独的用户来说,设置如下:




property-overrides

myuser
test






创建共享开发库
    大多数组织将会创建自己的内部开发库,用于配置,而中心开发库用于连接maven
    设置内部开发库是简单的,使用http协议,可以使用存在的http 服务器。或者创建新的服务,使用apache,或者jetty
    假设服务器地址192.168.0.2 ,端口8080
   
    设置另外一个开发库,用于设置项目的snapshot库
    中心镜像库,使用maven-proxy创建,当然也可以创建自己的镜像。用于下载本地库中没有的artifact


maven-proxy 设置
    从网上直接下载maven-proxy-standalone-0.2-app.jar和 proxy.properties
    在命令行中,直接运行java -jar maven-proxy-standalone-0.2-app.jar  proxy.properties
主要的配置:
设置repo.list 中增加相应的库就可以,如下定义:
repo.list=repo1.maven.org,...
#maven 的中心库
repo.repo1.maven.org.url=maven2
repo.repo1.maven.org.description=maven.org
repo.repo1.maven.org.proxy=one
repo.repo1.maven.org.hardfail=false
repo.repo1.maven.org.cache.period=360000
repo.repo1.maven.org.cache.failures=true
以后所有的远程库,都通过此方式增加。顺便说一下,不要忘了注释原来的example,那是没有办法访问的。

其他配置如
端口号 port=9999
保存的位置 repo.local.store=target/repo
serverName=

创建标准的组织pom
定义共同的内容,包括公司的结构,如组织,部门以及团队。
察看一下maven 的自身,可以作为很好的参考。
如scm
 



4.0.0

org.apache.maven
maven-parent
1

org.apache.maven.scm
maven-scm

...

maven-scm-api
maven-scm-providers
...

    


在maven父项目中可以看到如下定义:




4.0.0

org.apache
apache
1

org.apache.maven
maven-parent
5

...


Maven Announcements List
announce@maven.apache.org
...




...


    

maven 父pom包括了共享的元素,如声明邮件列表,开发者。并且大多数项目继承apache组织:


4.0.0
org.apache
apache
1

Apache Software Foundation



...


apache.snapshots
Apache Snapshot Repository


false



...


...


...


    



对于项目自身来说,父pom很少更新。所以,最后的方式保存父pom文件在单独的版本控制区域,它们能够check out,更改和配置.

使用Continuum持久整合

    持续整合自动build你的项目,通过一定的时间,包括所有的冲突在早期察觉,而不是发布的时候。另外持续整合也是一种很好的开发方式,使团队成员能产生细微的,交互的变动,能更有效的支持平行开发进程。
    可以使用maven的continuum作为持久整合的服务。
    安装continuum,比较简,使用以下的命令:
    C:\mvnbook\continuum-1.0.3> bin\win32\run
    可以通过来验证
    为了支持continuum 发送e-mail提醒,你需要相应的smtp服务用于发送信息。默认使用localhost:25,如果你没有设置,编辑上面的文件改变smtp-host设置。
    下一步,设置svn目录:
    svn co file://localhost/C:/mvnbook/svn/proficio/trunk proficio
    编辑pom.xml用于正确相应得e-mail地址。



...

continuum



mail

youremail@yourdomain.com





...


scm:svn:file://localhost/c:/mvnbook/svn/proficio/trunk


scm:svn:file://localhost/c:/mvnbook/svn/proficio/trunk


...


website

file://localhost/c:/mvnbook/repository/sites/proficio
/reference/${project.version}


   



提交相应的pom,然后执行mvn install

如果你返回,你会看到相应的项目列表。

一旦你登录后,你可以选择mavan 2.0项目用于增加相应的项目。你可以增加你的url或者提交你的本地内容。

你可以使用本地pom url,如下file://localhost/c:mvnbook/proficio/pom.xml

在提交了此url后,continuum将会返回相应的成功信息。
以下的原则用于更好的帮助持续整合:
早提交,经常提交:当用户经常提交时,持续整合是最有效的。这并不意味着,提交不正确的代码。
经常运行build:用于最快检测失败
尽快修正失败:当失败发生时,应该马上修正失败
建议一个有效的版本
运行clean build
运行复杂的综合测试
build所有的项目结构分支
持续运行项目的拷
阅读(1296) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~