Maven

Maven教案

🔰学习目标

1.掌握maven的概念
2.能够搭建maven环境
3.熟练掌握maven核心概念
4.能够使用maven创建java工程
5.能够使用maven创建web工程
6.熟练掌握项目对象模型pom.xml文件
7.数量掌握maven的模块化开发

一、maven 介绍

1.1 关于jar管理存在的一些问题

🔰 一个项目中往往会应用比较多的jar包，每个jar都从官网下载会比较麻烦；费时费力，降低了开发效率。
🔰jar包与jar包之间有依赖关系，我们很难记住这些依赖关系；手动导入jar包容易把依赖的jar包丢掉。
🔰不同工程中有相同的jar包，使得资源浪费，项目臃肿。
🔰平时我们开发项目时，一般都是一个项目就是一个工程。我们划分模块时，都是使用package来进行划分。但是，当项目很大时，有很多子模块时，即使是package来进行划分，也是让人眼花缭乱。

※ 针对以上问题，现在最流行的解决方案就是maven

1.2 什么是maven

🔰正式的定义为：Maven是一个项目管理工具，它包含了一个项目对象模型 (Project Object Model)，一组标准集合，一个项目生命周期(Project Lifecycle)，一个依赖管理系统(Dependency Management System)，和用来运行定义在生命周期阶段(phase)中插件(plugin)目标(goal)的逻辑。

🔰项目对象模型：java 工程的 jar、插件、坐标、统一由pom.xml文件管理。所以pom.xml称之为项目的对象模型。
🔰项目生命周期：maven工程的编译、测试、运行、部署等所有过程都可以通过maven工具独立完成。
🔰依赖管理系统：maven工程不需要引入jar包。通过坐标调用仓库的jar包进行运行。如图所示：

🔰插件和目标：maven的 编译、测试、运行、部署都是通过插件运行的。这些插件只需要在pom.xml中配置即可。每个插件的运行会分成n个步骤，每个步骤叫目标。
🔰对于不同职责的人来说有不同的不理解

1. 绝大多数Maven的开发者认为Maven是一个构建工具，用来把源代码构建成可发布、可执行构建的工具。
2. 项目经理可能会认为Maven是一个项目管理工具，可以管理项目建设的生命周期，包含：预处理、编译、打包、测试、部署等。

🔰为什么使用maven ?

1. 下载第三方JAR包
2. 添加第三方jar包
3. jar包之间的依赖

二、准备maven开发环境

注意： Maven的执行需要使用JDK，所以一定安装JDK并配置环境变量，统一使用JDK8及以上版本。

2.1 下载maven

下载地址： http://maven.apache.org

2.2 解压即安装

2.3 配置环境变量

【1】在环境变量中配置 MAVEN_HOME，为maven的安装目录

【2】修改环境变量中path，添加 %MAVEN_HOME%\bin

2.4 验证Maven

🔰在命令窗口执行命令 mvn -v

2.5 准备仓库环境

2.5.1 仓库配置

🔰仓库类型：简单来说仓库就是存储Jar包的目录，一般情况分为3类：

• 中央仓库
• 本地仓库
• 远程仓库。

【1】 中央仓库

🔰由Maven社区提供的仓库，其中包含了绝大多数流行的开源Java构件，一般情况下简单的Java依赖都可以从这里下载到本地。其设置在Maven的核心中，不需要进行配置

【2】本地仓库

🔰在本地电脑中存储Jar包的目录，默认的仓库目录是在自己的用户目录下 .m2/respository/ 的仓库目录。通过修改Maven安装目录下的配置文件 settings.xml 可以修改本地仓库的位置

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ${user.home}/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->
  <localRepository>E:\\java\\maven_repository2</localRepository>
  <!-- ....-->
</settings>

【3】远程仓库

🔰远程仓库是企业或者个人搭建的一个可以通过互联网进行访问的jar包仓库。

🔰一般情况下，Maven执行时如果本地找不到依赖文件，就会去中央仓库进行查找，如果还找不到就会停止构建，并输出错误信息到控制台，远程仓库的出现就是为了解决这种问题的出现。

配置全局的远程仓库（AliMaven） [settings.xml【Maven主配置文件】]

<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.5.2 仓库之间的关系

🔰项目的jar通过依赖坐标去本地库去加载，如果本地库没有去远程库加载，如果远程库没有去中央仓库加载；如果没有配置远程库，本地库会直接去中央仓库去加载。

2.6 统一配置jdk版本

🔰刚才我们配置了maven工程的jar依赖来源，即本地仓库、远程仓库。接下来我们在maven目录conf目录settings.xml文件继续配置jdk的开发版本。配置内容如下：

<profile>
    <id>jdk-1.8</id>
    <activation>
        <activeByDefault>true</activeByDefault>
        <jdk>1.8</jdk>
    </activation>
    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
    </properties>
</profile>

三、入门使用

3.1 创建Maven工程

# 执行命令，进入交互式的创建应用的方式
mvn archetype:generate -DarchetypeCatalog=internal(如果不好用加上这个参数)

1、选择原型，即创建应用的类型，普通的java应用或者web应用；
2、设置应用的基本信息；

• groupId：公司或者组织的唯一标识，一般为官网域名倒序，
• artifactId：该应用在当前公司或者组织中的唯一标识，
• version：应用的版本号，

3、确认设置的应用信息；
4、创建应用完成。

3.2 应用目录

目录或文件	说明
/src/main/java	存放应用的源代码文件
/src/test/java	存放应用的测试程序文件
/pom.xml	该应用的描述信息，每个maven的工程中都会存在这个文件，也称为项目对象模型（POM）

3.3 编译项目

# 编译源代码，生成jar包文件，并且保存到本地仓库中
cd 项目目录
mvn compile 

此时项目的目录结构：

其中新增了 /target目录，该目录下存放的就是在构建过程中生成的相关文件。

3.4 简单的项目对象模型

<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>
  
  
  <!-- 当前项目的坐标  -->
  <!-- 公司域名 -->
  <groupId>com.psjj</groupId>
  <!-- 项目名字 -->
  <artifactId>helloworld</artifactId>
  <!-- 项目版本 -->
  <version>1.0-SNAPSHOT</version>
  <!-- 项目类型 jar代表javaSE工程 war代表java web工程 pom代表maven父工程 -->
  <packaging>jar</packaging>

  <!-- 项目的描述信息 -->
  <name>helloworld</name>
  <url>http://maven.apache.org</url>

  
  <!--属性该属性的意思是项目是utf-8编码 -->
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
	<!-- 测试jar 的坐标 -->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

四、核心概念

4.1 插件与目标

4.1.1 插件与目标的定义

在前面执行创建应用的指令是

mvn archetype:generate

🔰其中，archetype就是一个插件标识，generate是插件中的一个目标标识。一个插件可以看作是一组目标的集合，每个目标代表着执行的某一个具体操作。它们的作用就是帮助开发者完成构建应用。

通常通过 mvn 插件:help 命令查看每个插件的目标组成。

4.1.2 常见插件

常用插件如下：

插件	描述
clean	构建之后清理目标文件。删除目标目录。
compiler	编译 Java 源文件。
surefire	运行 JUnit 单元测试。创建测试报告。
jar	从当前工程中构建 JAR 文件。
war	从当前工程中构建 WAR 文件。
javadoc	为工程生成 Javadoc。

总结:

🔰mvn compile 编译

🔰mvn clean 清理编译文件

🔰mvn test 测试

🔰这些叫命令 输入这些命令就会调用插件并执行；但是插件的执行分n步，每步叫目标 ，查询目标 mvn 插件:help

注意: 命令名和插件名未必相同。

4.2 生命周期

🔰Maven 中有三种标准的生命周期:

• clean：应用中目标目录中文件的清理周期
• default：应用从源代码构建成可执行的构件的周期
• site：项目站点文档创建的周期

🔰三个生命周期是相互独立，并且每个周期中包含很多的阶段，每个阶段的现实都是由插件完成的。

4.2.1 clean

1. 包含的阶段
   1. pre-clean：执行一些需要在clean之前完成的工作
   2. clean：移除所有上一次构建生成的文件
   3. post-clean：执行一些需要在clean之后立刻完成的工作
2. 触发的指令

mvn clean

4.2.2 default

1. 简介

🔰这是 Maven 的主要生命周期，被用于构建应用，包括下面的 23 个阶段：

生命周期阶段	描述
validate（校验）	校验项目是否正确并且所有必要的信息可以完成项目的构建过程。
initialize（初始化）	初始化构建状态，比如设置属性值。
generate-sources（生成源代码）	生成包含在编译阶段中的任何源代码。
process-sources（处理源代码）	处理源代码，比如说，过滤任意值。
generate-resources（生成资源文件）	生成将会包含在项目包中的资源文件。
process-resources （处理资源文件）	复制和处理资源到目标目录，为打包阶段最好准备。
compile（编译）	编译项目的源代码。
process-classes（处理类文件）	处理编译生成的文件，比如说对Java class文件做字节码改善优化。
generate-test-sources（生成测试源代码）	生成包含在编译阶段中的任何测试源代码。
process-test-sources（处理测试源代码）	处理测试源代码，比如说，过滤任意值。
generate-test-resources（生成测试资源文件）	为测试创建资源文件。
process-test-resources（处理测试资源文件）	复制和处理测试资源到目标目录。
test-compile（编译测试源码）	编译测试源代码到测试目标目录.
process-test-classes（处理测试类文件）	处理测试源码编译生成的文件。
test（测试）	使用合适的单元测试框架运行测试（Juint是其中之一）。
prepare-package（准备打包）	在实际打包之前，执行任何的必要的操作为打包做准备。
package（打包）	将编译后的代码打包成可分发格式的文件，比如JAR、WAR或者EAR文件。
pre-integration-test（集成测试前）	在执行集成测试前进行必要的动作。比如说，搭建需要的环境。
integration-test（集成测试）	处理和部署项目到可以运行集成测试环境中。
post-integration-test（集成测试后）	在执行集成测试完成后进行必要的动作。比如说，清理集成测试环境。
verify （验证）	运行任意的检查来验证项目包有效且达到质量标准。
install（安装）	安装项目包到本地仓库，这样项目包可以用作其他本地项目的依赖。
deploy（部署）	将最终的项目包复制到远程仓库中与其他开发者和项目共享。

🔰当一个阶段通过 Maven 命令调用时，例如 mvn compile，只有该阶段之前以及包括该阶段在内的所有阶段会被执行。

2. 触发的指令

# 编程程序
mvn compile
# 执行应用中的测试程序，会先执行编译的生命周期
mvn test
# 执行打包的生命周期，会先执行编译、测试生命周期
mvn package
# 执行安装的生命周期，会依次执行编译、测试、打包的生命周期
mvn install

🔰 多个生命周期可以组合使用mvn clean package, 此时会先进行目标目录文件的清理，然后再执行default中的相关周期阶段。

4.2.3 site

1. 简介:Maven Site 插件一般用来创建新的报告文档、部署站点等。

   1. pre-site：执行一些需要在生成站点文档之前完成的工作
   2. site：生成项目的站点文档
   3. post-site： 执行一些需要在生成站点文档之后完成的工作，并且为部署做准备
   4. site-deploy：将生成的站点文档部署到特定的服务器上

2. 触发的指令

   mvn site
   

需要如下配置信息

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-site-plugin</artifactId>
      <version>3.7</version>
      <dependencies>
        <dependency>
          <groupId>org.apache.maven.doxia</groupId>
          <artifactId>doxia-site-renderer</artifactId>
          <version>1.8</version>
        </dependency>
      </dependencies>
    </plugin>
  </plugins>
</build>

<reporting>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>2.10.4</version>
    </plugin>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>