使用 Maven 构建 Java 项目

Maven 是基于项目对象模型「POM」,可以通过一小段描述信息来管理项目的构建、报告和文档的软件项目管理工具。本文总结了 Maven 的基本用法。

1. Maven 基本配置

1.1 环境变量

环境变量中添加「M2_HOME」为 maven 主目录

在 path 中添加「;%M2_HOME%\bin」

1.2 使用 Maven 阿里云中央仓库

修改 Maven 根目录下 conf 文件夹中的 setting.xml 文件,内容如下:

<mirrors>
  <mirror>
    <id>alimaven</id>
    <name>aliyun maven</name>
    <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
    <mirrorOf>central</mirrorOf>
  </mirror>
</mirrors>

2. 创建基于 Maven 的 Java 项目

2.1 使用命令行创建

Maven 使用原型「archetype」插件创建工程。要创建一个简单的 Java 应用,我们将使用 maven-archetype-quickstart 插件。

Maven 创建目录有两种方式:「archetype 可自动创建目录骨架」

  • 在 cmd 中直接执行「mvn archetype:generate」按照提示进行选择,选择如下 Archetype:
943: remote -> org.apache.maven.archetypes:maven-archetype-quickstart (An archetype which contains a sample Maven project.)
  • 使用单行命令创建项目,命令格式如下:
mvn archetype:generate 
 -DgourpId = 组织名,公司网址的反写 + 项目名称
 -DartifactId=项目名-模块名
 -Dversion=版本号
 -Dpackage=代码所在的包名

示例如下:

mvn archetype:generate
 -DgroupId=cc.bitky.demo
 -DartifactId=demo-module
 -Dversion=1.0.0-SNAPSHOT
 -Dpackage=cc.bitky.demo.module

2.2 使用InteliJ IDEA 创建

  • 在 InteliJ IDEA 中创建基础的示例 Maven 项目,依旧选择:
org.apache.maven.archetypes:maven-archetype-quickstart

如图所示:

Maven Quickstart Archetype

3. 目录结构

3.1 Maven 项目的目录结构

在 Maven 项目的根目录下,有如下必要的目录结构:

  • src
    • main
      • resources「存放一些资源文件」
      • java
        • package「自定义的包」
    • test
      • resources「存放一些资源文件」
      • java
        • package
  • pom.xml

如下图所示:

Maven 项目的目录结构

3.2 项目根目录下「pom.xml」的典型结构:

<project 
  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/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>     <!-->maven版本</-->
  <groupId>cc.bitky.demo</groupId>       <!-->项目的包名</-->
  <artifactId>demo-module</artifactId>   <!-->模块名</-->
  <version>1.0.0-SNAPSHOT</version>      <!-->版本</-->
  <packaging>jar</packaging>
  <name>demo-module</name>
  <url>http://maven.apache.org</url>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <!-- 依赖项 -->
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
      <!-- 排除依赖传递列表 -->
      <exclusions>
        <exclusion></exclusion>
      </exclusions>
    </dependency>
  </dependencies>
  <!-- 依赖的管理,一般定义在父模块中,由子模块去继承 -->
  <dependencyManagement>
    <dependencies>
      <dependency></dependency>
    </dependencies>
  </dependencyManagement>
  <!-- 对构建行为提供相应的支持 -->
  <build>
    <!-- 插件列表 -->
    <plugins>
      <plugin>
        <!-- 指定坐标 -->
        <groupId></groupId>
        <artifactId></artifactId>
        <version></version>
      </plugin>
    </plugins>
  </build>
  <!-- 一般在子模块中指定所继承的父模块 -->
  <parent></parent>
  <!-- 模块列表 -->
  <modules>
    <module></module>
  </modules>
</project>

4. Maven 操作

4.1 构建命令

  • mvn -v 版本。
  • mvn compile 编译。
  • mvn test 测试。
  • mvn package 打包。
  • mvn clean 清除maven生成的target目录。
  • mvn install 将生成的jar安装到本地仓库中。
  • mvn compile: 编译主程序源代码,不会编译test目录的源代码。第一次运行时,会下载相关的依赖包,可能会比较费时
  • mvn test: 运行应用程序中的单元测试,会生成 target 文件夹:
    • 主程序编译的字节码文件在 classes 下面
    • 测试程序放在 test-classes 下
    • 所生成的测试报告放在 surefire-reports 文件夹下
  • mvn package 会在target目录下生成 Jar 包,如「maven01-model-0.0.1SNAPSHPT.jar」

4.2 生命周期

Maven的生命周期大概如下,这几个命令对应了一个项目的完整的构建过程,这几个步骤对应的都有插件来完成:

  • clean 「清理」
  • compile 「编译」
  • test 「测试」
  • package 「打包」
  • install「安装到本地库」

Maven的生命周期分为三个独立的生命周期(每一个生命周期有分为若干个阶段,其中defaul是最核心的一个):

  1. clean「清理项目」
  2. default「构建项目」
  3. site「生成项目的站点」

4.2.1 clean「清理项目」

  • pre-clean 「执行清理前的工作」
  • clean「清理上一次构建生成的所有文件」
  • post-clean「执行清理后的文件」

4.2.2 default「构建项目」(最核心)

  • compile 「编译」
  • test 「测试」
  • package 「打包」
  • install「安装到本地库」

4.2.3 site「生成项目站点」

  • pre-site「在生成项目站点之前要完成的工作」
  • site「生成项目的站点文档」
  • post-site「在生成项目站点后要完成的工作」
  • site-deploy「发布生成的站点到服务器上」

注意

  • 每个独立的生命周期,只需执行其中一个命令,此时会从该生命周期的开始命令顺序执行到该命令。
  • Maven的生命周期对应的命令是顺序执行的,如果没有人为的顺序的一个个执行,那么Maven会默认的自动运行。
  • 如执行「mvn clean test」,则此时会顺序执行「pre-clean clean post-clean compile test」
  • 如执行「mvn test」,则此时会顺序执行「compile test」

5. 参考资料

  1. Maven 教程 - 「极客学院 Wiki」
  2. 项目管理利器 — maven「慕课网」
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,560评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,104评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,297评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,869评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,275评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,563评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,833评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,543评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,245评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,359评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,006评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2 273
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2 268

推荐阅读更多精彩内容