用Maven来管理我们的项目.doc

用 Maven 来管理我们的项目 一个 Java 项目中最困难的地方就是如何着手启动它 在启动项目之前 我们必须配置好所有的逻辑 关系 比如 Java 源代码应该放在何处 单元测试应该在何处进行 依赖的 jar 包应该如何放置 如何构 建项目 如何形成文档 如何测试和部署项目 在这种情况下 开发人员不同的处理选择将会影响项目的 余下部分 Maven1 0 已经历了几年的时间 并且作为 Ant 的替代品已被广大的开发人员所接收 但它并没有在 很大程度使开发人员从 Ant 的 build xml 文件中解脱出来 Maven1 0 速度慢并且笨拙 使用起来的困难度 并不亚于使用 Ant 的项目 事实上 它的核心是基于 Ant 实现的 在经过了几乎彻底的重写后 Maven2 0 诞生了 本文分三个部分讲述了 Maven 的使用 第一部分是通过一个简单的例子介绍如何使用 Maven 快速的 启动一个项目 第二部分通过实际项目介绍 Maven 的项目继承和 pom xml 的配置方法 第三部分介绍如 何将一个 Maven 项目转换成 Eclipse 项目进行开发 一 一 熟悉熟悉 MAVENMAVEN 2 1 什么是 MAVEN 2 2 MAVEN 2 的优点 2 3 安装MAVEN 2 4 设置环境变量 2 5 开始一个项目 2 6 编译程序源代码 4 7 运行单元测试 4 8 生成JAR 文件 4 9 测试 4 10 生成ECLIPSE工程文件 4 二 二 用用 MAVENMAVEN 来管理来管理 ADMINADMIN 系统系统 5 1 标准的目录结构 5 2 ADMINCPC开发环境搭建 5 3 POM XML的配置 6 定义父项目 bizpom pom xml 6 定义子项目 Admincpc pom xml 7 4 编译源码并打包 10 5 MAVEN2 CONTINUUM 持续整合 10 6 生成站点 11 三 三 使用使用 ECLIPSEECLIPSE 开发开发 14 1 生成ECLIPSE工程文件 14 2 ECLIPSE 安装 MAVEN2 插件 15 3 配置 MAVEN 16 4 导入 ECLIPSE 工程 17 5 激活 MAVEN 插件 19 6 指定MAVEN的JAR库本机路径 20 7 项目变成 WEB项目 20 一 一 熟悉熟悉 MavenMaven 1 什么是 Maven Maven 本质上是一个项目管理和综合工具 提供了一个帮助管理的方式 Builds 构建 Documentation 文档 Reporting 报告 Dependencies 依赖 SCMs Releases 版本 Distribution 发布 2 Maven 2 的优点 标准的项目布局和项目结构生成器 标准的依赖管理机制 多项目支持 在开发者需要的时候及时地下载新的插件和功能部件 生成最新项目信息的网站 集成了源代码控制软件 CVS 和 Subversion 3 安装 maven http www apache org dyn closer cgi maven binaries apache maven 2 0 9 bin zip 解压到本地目录 如 d maven 4 设置环境变量 MAVEN HOME d maven PATH MAVEN HOME bin 运行 mvn version 如果显示如下信息 表示成功 5 开始一个项目 为了生成一个简单的 Maven 项目 从命令行执行下面的命令 D workspace mvn archetype create DgroupId com sogou DartifactId admin 生成的目录结构如下 打开 pom xml 文件内容如下 pom xml 包含了这个项目的项目对象模型 POM 是 Maven 工作的基本单位 因为 Maven 是本质上是以项目为中心的 在这一切都围绕着项目这一概念 简而 言之 POM 包含了你项目的每一个重要的信息段 理解 POM 概念是很重要的 这是一个简单的 POM 但是仍能显示每一个 POM 包含的关键元素 因此让 我们浏览每一个来让你熟悉 POM 的本质 project 所有 Maven pom xml 的最顶层元素 modelVersion 这个元素指名这个 POM 正在使用的对象模型的版本 模型版本很少改变 但是这个是强制的为了确保使用的稳定性 如果 Maven 开发者认为有必要改变模型 groupId 这个元素指明创建项目的组织或组的唯一标识符 groupId 是一个项目的关键的 标识符 典型地基于你的组织的权限定域名 举例来说 com sogou 为上个例子指定的 groupId artifactId 这个元素指明这个项目生成的主制品的惟一基名 一个项目的主要制品典型的 是一个 JAR 文件 packaging 这个元素指明这个制品的包类型 例如 JAR WAR EAR 等等 packaging 元素的默认值是 JAR 因此对于大多数项目你不用指定 version 这个元素指明项目生成的制品的版本 Maven 对你的版本管理大有帮助 你会经 常看到版本中的 SNAPSHOT 标识符 它指明了一个项目的开发状态 name 这个元素指明工程使用的显示名称 这个在 Maven 生成的文档中经常用到 url 这个元素指明项目的站点在那里可以找到 这个在 Maven 生成的文档中经常用到 description 这个元素提供了你的项目的基本描述 这个在 Maven 生成的文档中经常用 到 6 编译程序源代码 我们进入 D workspace admin 目录 执行下面命令 D workspace admin mvn compile 如果能看到 BUILD SUCCESSFUL 的提示信息 说明编译成功了 你第一次执行 这个命令的时 Maven 需要下载所有需要的完成这个命令的插件和相关的依赖 如果是一个新的 Maven 安装 这个可能需要一定的时间来下载 7 运行单元测试 执行如下命令 D workspace admin mvn test 在执行这个命令的时候 你会看到类似如下的输出 Results surefire Tests run 1 Failures 0 Errors 0 INFO INFO BUILD SUCCESSFUL INFO 说明 单元测试运行成功 8 生成 jar 文件 制作 JAR 文件是相当直接明了的 可以通过输入如下命令来完成 D workspace admin mvn package 提示信息如果包含 INFO BUILD SUCCESSFUL 说明打包成功 到 admin target 目录下 应该可以看到 admin 1 0 SNAPSHOT jar 这个文件 9 测试 你可以使用以下的命令来测试新编译和打包出来的 jar 包 java cp target admin 1 0 SNAPSHOT jar com sogou App 如果输出 Hello World 表示成功 10 生成 eclipse 工程文件 如果你采用的开发工具是 eclipse 那么用 maven 的 eclipse 参数生成 eclipse 工程 文件 输入如下命令 D workspace admin mvn eclipse eclipse 指令执行完毕后 发现多了两个文件 classpath 和 project 至此你已经过了一遍程序设置 构建 测试 打包 安装了一个典型的 Maven 项 目 更多的命令和信息我们在以后的实际应用中继续讲述 二 用用 mavenmaven 来管理来管理 AdminAdmin 系统系统 1 标准的目录结构 将 admincpc 的目录按照上一步生成的结构进行调整 调整后如下 2 Admincpc 开发环境搭建 建立工程目录如 d workspace admin 目录结构如下 Admincpc svn http 192 168 41 8 svn admincpc trunk Common svn http 192 168 41 8 svn common trunk java Bizpom svn http 192 168 41 8 svn common trunk bizpom 3 pom xml 的配置 为了减少几个工程中 pom xml 文件属性的重复定义 我们将 bizpom 定义为父项目 common admin p4p p4pagent 等项目继承 bizpom pom xml 中定义的依赖 插件 项目库等信息 定义父项目 bizpom pom xml 定义子项目 Admincpc pom xml 4 编译源码并打包 至此 环境已经搭建起来了 在命令行方式进入到 d workspace admin admincpc 目录 下执行如下命令 D workspace admin admincpc mvn package 输出内容如下 生成的 jar 文件存放在 d workspace admin admincpc release admincpc 4 0 1 jar 5 Maven2 Continuum 持续整合 持续整合自动 build 你的项目 通过一定的时间 包括所有的冲突在早期察觉 而不是 发布的时候 另外持续整合也是一种很好的开发方式 使团队成员能产生细微的 交互的 变动 能更有效的支持平行开发进程 可以使用 maven 的 continuum 作为持久整合的服务 在开发环境里登录 http 192 168 41 80 8090 continuum 以管理员身份登录 添加 pom xml 点击 Build Now 就可以让 continuum 运行 build 任务了 默认是 1 小时 build 一次 运行 maven 的 clean 和 install 目标 6 生成站点 团队交流是项目的一个基本部分 花费时间在查找项目的技术信息上可能是代价不菲 并且令人沮丧的 明显地 拥有自己专用的 web 站点对每个 IT 项目有利的 Maven 站点 生成器就是为此而生 以微小的努力 你就能有拥有一个专业水准 低维护成本 快速运 行的 web 站点 Maven 让你生成项目的一站式信息中心 包括 一般项目信息 诸如源码库 缺陷追踪 团队成员等 单元测试报告及测试覆盖率报告 使用 Checkstyle 和 PMD 对代码进行自动审查 配置和版本信息 依赖关系 Javadocs 源代码的 HTML 形式 建立索引和可交叉查考 更多 在命令行运行如下命令 D workspace admin admincpc mvn site 打开 d workspace admin admincpc target site index htm 文件 显示了该项目的详细信 息 具体如下 持续集成配置 三 使用使用 EclipseEclipse 开发开发 1 生成 eclipse 工程文件 分别输入如下命令 D workspace admin admincpc mvn eclipse eclipse D workspace admin common mvn eclipse eclipse 2 eclipse 安装 Maven2 插件 打开 Myeclipse 菜单 Help Software Updates Find and Install 打开 update 窗口 选择 Search for new features to install 点 next 继续 点击 New Remote Site 在弹出窗口做如下设置 URL http m2eclipse sonatype org update 点击 Finish 完成安装 3 配置 Maven 菜单 windows Preferences 打开的窗口中点 Maven Global Settings File 默认 MAVEN HOME conf settings xml User Settings File 默认 C Documents and Settings Administrator m2 settings xml Local Repository 默认 C Documents and Settings Administrator m2 repository 4 导入 Eclipse 工程 菜单 File Import 弹出窗口中 选择 General Maven P