maven 零基础入门

以下文章部分摘自OSC博客:http://my.oschina.net/huangyong/blog/194583 (Maven那点事儿)

另附上给用 IDEA 开发的筒子们的福利:http://my.oschina.net/lujianing/blog/266172 (Intellij IDEA创建Maven Web项目)

0. Maven简介

Maven要做的两件事:

  1. 统一开发规范与(插件)开发工具
  2. 统一管理项目依赖的jar包

因为 Java 项目的目录结构都没有一个统一标准,配置文件到处都是,单元测试代码到底应该放在哪里,没有一个权威的规范。很有必要来弥补统一规范这个方面。

若用Ant 做为项目构建工具,它可以自动化地完成编译、测试、打包等任务,确实为我们省了不少事儿,但编写 Ant 的 XML 脚本绝非是一件轻松的事情。

Maven不仅希望每个 Java 开发者都能使用他定义的规范,还要我们都从他家里去获取 jar 包(他家就是 Maven 中央仓库),我们只需告诉他,我们想要的 jar 包具体在什么位置即可(这个位置就是 Maven 坐标)。

1. 安装 Maven

我们可以从 http://maven.apache.org/ 下载 Maven 开发包,其实就是个压缩包,下载完毕后,解压一下,配置一下环境变量就可以用了。

有两个环境变量可以配置:

  • M2_HOME               也就是Maven压缩包解压的位置,例如:D:\dev\maven
  • MAVEN_OPTS         -Xms128m -Xmx512m

M2_HOME 是必须要配置的,相当于配JAVA_HOME是为了查找java、javac等可执行文件一样,我认为这方便OS查找mvn.bat可执行文件。

如果想让 Maven 跑得更快点,可以根据自己的情况来设置 MAVEN_OPTS。

现在我们可以打开 cmd,输入:

mvn -v

我想您一定会看到一些信息,恭喜您,Maven 安装成功!

2. 了解 Maven 仓库

Maven 给我们带来的最直接的帮助,就是 jar 包得到了统一管理,那么这些 jar 包存放在哪里呢?它们就在您的 本地仓库 中,默认在 C:\Users\用户名\.m2\settings.xml 中配置,当然,默认仓库路径可以在%M2_HOME%\conf\settings.xml覆盖用户配置。

  • 用户配置:用户目录\.m2\settings.xml
  • 全局配置:%M2_HOME%\conf\settings.xml

<settings>

<localRepository>自定义本地仓库路径</localRepository>

</settings>

直接下载刘婷峰传的同名配置覆盖即可。

我们可将本地仓库理解为“缓存”,因为项目首先会从本地仓库中获取 jar 包,当无法获取指定 jar 包的时候,本地仓库会从 远程仓库(或 中央仓库) 中下载 jar 包,并放入本地仓库中以备后用。这个远程仓库是 Maven 官方提供的,可通过 http://search.maven.org/ 来访问。

这样一来,本地仓库会随着项目的积累越来越大。通过下面这张图可以清晰地表达项目、本地仓库、远程仓库之间的关系。

这个结构是否与 Git 的本地仓库、远程仓库有异曲同工之妙呢?

既然 Maven 安装了,那么本地仓库也就有了,下面我们就一起来创建一个 Maven 项目吧。

3. 创建 Maven 项目

我们手工创建了三个目录:

  1. src/main/java

  2. src/test/java

  3. src/test/resources

最终的目录结构看起来是这样的:

  • main 目录下放项目的主要代码,test 目录下存放测试相关的代码。

  • 编译输出后的代码会放在target 目录下(该目录与 src 目录在同一级别下,这里没有显示出来)。

  • java 目录下存放 Java 代码,resources 目录下存放配置文件。

  • webapp 目录下存放 Web 应用相关代码。

  • pom.xml 是 Maven 项目的配置文件。

其中 pom.xml 称为 Project Object Model(项目对象模型),它用于描述整个 Maven 项目,所以也称为 Maven 描述文件。

可见 pom.xml 才是理解 Maven 的关键点,很有必要看看它到底长什么样。

4. 理解 pom.xml

先声明一点,pom.xml说白了也是xml文件,也可以用标准的xml声明方式来配置。
<modelVersion>4.0.0</modelVersion>
    <groupId>com.smart</groupId>
    <artifactId>smart-demo</artifactId>
    <version>1.0</version>
    <packaging>war</packaging>

    <name>smart-demo Maven Webapp</name>
    <url>http://maven.apache.org</url>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <finalName>smart-demo</finalName>
    </build>

从上往下简要说明一下:

  • modelVersion:这个是 POM 的版本号,现在都是 4.0.0 的。 

  • groupId、artifactId、version:分别表示 Maven 项目的组织名(groupId)、构件名(artifactId)、版本号(version),它们三个合起来就是 Maven 坐标,根据这个坐标可以在 Maven 仓库中找到唯一对应的 Maven 构件。

  • packaging:表示该项目的打包方式,war 表示打包为 war 文件,默认是 jar。

  • name、url:表示该项目的名称与 URL 地址,意义不大,可以省略。

  • dependencies:定义该项目的依赖关系,其中每一个 dependency 对应一个 Maven 项目,可见 Maven 坐标再次出现,还多了一个 scope,表示作用域(下面会描述)。

  • build:表示与构建相关的配置,这里的 finalName 表示最终构建后的名称 smart-demo.war,这里的 finalName 还可以使用另一种方式来定义,就是引用方式,和%JAVA_HOME%类似,在这里就是用${JAVA_HOME}。

 

如果用树形图来表达 pom.xml,那么会更加清晰:

可见,pom.xml 除了项目的基本信息(Maven 坐标、打包方式等)以外,每个都应该包括:

  1. Lifecycle(生命周期)

  2. Plugins(插件)

  3. Dependencies(依赖)

Lifecycle 是项目构建的生命周期,它包括 9 个 Phase(阶段)。

 

 

大家知道,Maven 是一个核心(core)加上多个插件(plugin)的架构,而这些插件提供了一系列非常重要的功能,这些插件会在许多阶段里发挥重要作用。

阶段

插件名

作用

cleanclean清理自动生成的输出,也就是 target 目录
validate由 Maven 核心负责验证 Maven 描述文件是否有效
compilecompiler、resources编译 Java 源码
testcompiler、surefire、resources运行测试代码
packagewar项目打包,就是生成构件包,也就是打 war 包
verify由 Maven 核心负责验证构件包是否有效
installinstall将构件包安装到本地仓库
sitesite生成项目站点,就是一堆静态网页文件,包括 Javadoc
deploydeploy将构件包部署到远程仓库

以上表格中出现的插件名实际上是插件的别名。

比如:compiler 实际上是 org.apache.maven.plugins:maven-compiler-plugin:2.3.2,这个才是 Maven 插件的全称。

每个插件又包括了一系列的 Goal(目标),以 compiler 插件为例,它包括以下目标:

  • compiler:compile:       用于编译 main 目录下的 Java 代码。

  • compiler:testCompile: 用于编译 test 目录下的 Java 代码。

  • compiler:help:             用于显示 compiler 插件的使用帮助。

可见,插件目标才是具体干活的人,一个插件包括了一或多个目标,一个阶段可由零个或多个插件来提供支持。

我们可以在 pom.xml 中定义一些列的项目依赖(dependency),每个项目依赖会有一个 Scope(作用域),它表示该构件包在什么时候起作用,包括以下五种:

  1. compile:  默认作用域,在编译、测试、运行时有效。
  2. test:        对于测试时有效。
  3. runtime:  对于测试、运行时有效。
  4. provided:对于编译、测试时有效,但在运行时无效。
  5. system:   与 provided 类似,但依赖于系统资源。

可用一张表格来表示:

作用域编译时有效测试时有效运行时有效示例
compile  smart-framework.jar
test   junit.jar
runtime   mysql-connector-java.jar
provided   servlet-api.jar
system   JDK 的 rt.jar

pom.xml文件结构请看这里:pom.xml

pom.xml 大致解释一下:

  • 我们可使用 properties 来定义一些配置属性,例如:project.build.sourceEncoding(项目构建源码编码方式),可设置为 UTF-8,可防止中文乱码。也可定义相关构件包版本号,例如:smart.version,便于日后统一升级。
  • 建议使用最新版本的 JUnit,通过 Archetype 自动生成的 JUnit 太老了(3.8.1),可改为最新版(4.11)。
  • 因为没必要使用 MySQL 客户端的 API,它仅仅在运行时有效,所以我们将 MySQL 构件包的作用域设置为 runtime。
  • 因为我们只想在代码中使用 Servlet API,而不想将它所对应的 jar 包放入 WEB-INF 的 lib 目录下,所以我们可设置 Servlet 构件包的作用域为 provided。
  • 为了保证在 JDK 1.6 运行,我们可配置 maven-compiler-plugin 插件,设置输入源码为 1.6,编译输出的字节码也为 1.6。
  • 如果想跳过测试,可配置 maven-surefire-plugin 插件,将 skipTests 设置为 true。
  • 如果想配置生成的 war 包为 artifactId,可修改 maven-war-plugin 插件,将 warName 修改为 ${project.artifactId},这样就无需再配置 finalName 了。
  • 如果想通过 Maven 将应用部署到 Tomcat 中,可使用 tomcat7-maven-plugin 插件,可使用 mvn tomcat7:run-war 命令来运行 war 包。

5. 使用 Maven 命令

方式一:mvn <插件>:<目标> [参数]

方式二:mvn <阶段>

我们日常中使用最频繁的,例如:

  • mvn clean:     清空输出目录(即 target 目录)
  • mvn compile: 编译源代码
  • mvn package:生成构件包(一般为 jar 包或 war 包)
  • mvn install:    将构件包安装到本地仓库
  • mvn deploy:   将构件包部署到远程仓库

需要注意的是:必须在 Maven 项目的根目录处执行Maven命令,也就是当前目录下一定存在一个名为 pom.xml 的文件。

6. 后记

Maven 使 Java 开发更加规范化与自动化,其实 Maven 那点事远远不止这些,如果您掌握了以上这些基础知识,再去学习 Maven 的高级特性,我想一定会是一件非常轻松的事情。

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值