第三章 使用 Maven:命令行环境
第一节:根据坐标创建 Maven 工程
1、Maven 核心概念:坐标
①数学中的坐标
使用 x、y、z 三个『向量』作为空间的坐标系,可以在『空间』中唯一的定位到一个『点』。
②Maven中的坐标
[1]向量说明
使用三个『向量』在『Maven的仓库』中唯一的定位到一个『jar』包。
groupId:公司或组织的 id
artifactId:一个项目或者是项目中的一个模块的 id
version:版本号
[2]三个向量的取值方式
groupId:公司或组织域名的倒序,通常也会加上项目名称
例如:com.sdjzu.maven
artifactId:模块的名称,将来作为 Maven 工程的工程名
version:模块的版本号,根据自己的需要设定
例如:SNAPSHOT 表示快照版本,正在迭代过程中,不稳定的版本
例如:RELEASE 表示正式版本
举例:
groupId:com.sdjzu.maven
artifactId:pro01-sdjzu-maven
version:1.0-SNAPSHOT
③坐标和仓库中 jar 包的存储路径之间的对应关系
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
上面坐标对应的 jar 包在 Maven 本地仓库中的位置:
Maven本地仓库根目录\javax\servlet\servlet-api\2.5\servlet-api-2.5.jar
一定要学会根据坐标到本地仓库中找到对应的 jar 包。
2、操作
①创建目录作为后面操作的工作空间
D:\developertool\Maven\maven-workspace\00
②在工作空间目录下打开命令行窗口
③使用命令生成Maven工程
运行 命令
mvn archetype:generate
②在工作空间目录下打开命令行窗口
③使用命令生成Maven工程
④调整
Maven 默认生成的工程,对 junit 依赖的是较低的 3.8.1 版本,我们可以改成较适合的 4.12 版本。
自动生成的 App.java 和 AppTest.java 可以删除。
D:\developertool\Maven\maven-workspace\00\pro1-maven-java\src\test\java\com\sdjzu\maven
⑤自动生成的 pom.xml 解读
<!--project 标签: 根标签,表示对当前工程进行配置与管理-->
<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 标签: 从Maven 2 开始一直是4.0.0-->
<!--代表当前pom.xml所采用的标签结构-->
<modelVersion>4.0.0</modelVersion>
<!--坐标信息-->
<!--groupId 标签: 坐标向量之一: 代表公司或者某一个组织开发的某一个项目-->
<groupId>com.sdjzu.maven</groupId>
<!--artifactId 标签: 坐标向量之一: 代表项目下的某一个模块-->
<artifactId>pro1-maven-java</artifactId>
<!--version 标签: 坐标向量之一: 代表当前模块的版本号-->
<version>1.0-SNAPSHOT</version>
<!--packageing 标签:代表打包方式-->
<!--取值jar:生成jar包,说明这是一个java工程-->
<!--取值war:生成war包,说明这是一个web工程-->
<!--取值pom:说明这个工程是用来管理其他工程-->
<packaging>jar</packaging>
<name>pro1-maven-java</name>
<url>http://maven.apache.org</url>
<!--在Maven中定义属性值---->
<properties>
<!--在构建过程中读取源码时使用的字符集-->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<!--dependencies 标签:配置具体的依赖信息,可以包含多个dependency子标签-->
<dependencies>
<!--dependecy 标签: 配置具体依赖信息-->
<dependency>
<!--坐标信息:导入哪一个jar包 ,就是他的坐标的信息-->
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12 </version>
<!--scope 标签: 配置当前依赖的范围-->
<scope>test</scope>
</dependency>
</dependencies>
</project>
3、Maven核心概念:POM
①含义
POM:Project Object Model,项目对象模型。和 POM 类似的是:DOM(Document Object Model),文档对象模型。它们都是模型化思想的具体体现。
②模型化思想
POM 表示将工程抽象为一个模型,再用程序中的对象来描述这个模型。这样我们就可以用程序来管理项目了。我们在开发过程中,最基本的做法就是将现实生活中的事物抽象为模型,然后封装模型相关的数据作为一个对象,这样就可以在程序中计算与现实事物相关的数据。
③对应的配置文件
POM 理念集中体现在 Maven 工程根目录下 pom.xml 这个配置文件中。所以这个 pom.xml 配置文件就是 Maven 工程的核心配置文件。其实学习 Maven 就是学这个文件怎么配置,各个配置有什么用。
4、Maven核心概念:约定的目录结构
①各个目录的作用
另外还有一个 target 目录专门存放构建操作输出的结果。
②约定目录结构的意义
Maven 为了让构建过程能够尽可能自动化完成,所以必须约定目录结构的作用。例如:Maven 执行编译操作,必须先去 Java 源程序目录读取 Java 源代码,然后执行编译,最后把编译结果存放在 target 目录。
③约定大于配置
Maven 对于目录结构这个问题,没有采用配置的方式,而是基于约定。这样会让我们在开发过程中非常方便。如果每次创建 Maven 工程后,还需要针对各个目录的位置进行详细的配置,那肯定非常麻烦。
目前开发领域的技术发展趋势就是:约定大于配置,配置大于编码。
第二节 ①在 Maven 工程中编写代码
1、主体程序
主体程序指的是被测试的程序,同时也是将来在项目中真正要使用的程序
package com.sdjzu.maven;
public class Calculator {
public int sum(int i, int j){
return i + j;
}
}
2、测试程序
package com.sdjzu.maven;
import org.junit.Test;
import com.sdjzu.maven.Calculator;
// 静态导入的效果是将Assert类中的静态资源导入当前类
// 这样一来,在当前类中就可以直接使用Assert类中的静态资源,不需要写类名
import static org.junit.Assert.*;
public class CalculatorTest{
@Test
public void testSum(){
// 1.创建Calculator对象
Calculator calculator = new Calculator();
// 2.调用Calculator对象的方法,获取到程序运行实际的结果
int actualResult = calculator.sum(5, 3);
// 3.声明一个变量,表示程序运行期待的结果
int expectedResult = 8;
// 4.使用断言来判断实际结果和期待结果是否一致
// 如果一致:测试通过,不会抛出异常
// 如果不一致:抛出异常,测试失败
assertEquals(expectedResult, actualResult);
}
}
②执行 Maven 的构建命令
1、要求
运行 Maven 中和构建操作相关的命令时,必须进入到 pom.xml 所在的目录。如果没有在 pom.xml 所在的目录运行 Maven 的构建命令,那么会看到下面的错误信息:
The goal you specified requires a project to execute but there is no POM in this directory
TIP
mvn -v 命令和构建操作无关,只要正确配置了 PATH,在任何目录下执行都可以。而构建相关的命令要在 pom.xml 所在目录下运行——操作哪个工程,就进入这个工程的 pom.xml 目录。
2、清理操作
mvn clean
效果:删除 target 目录
3、编译操作
主程序编译:mvn compile
测试程序编译:mvn test-compile
主体程序编译结果存放的目录:target/classes
测试程序编译结果存放的目录:target/test-classes
4、测试操作
mvn test
测试的报告存放的目录:target/surefire-reports
5、打包操作
mvn package
打包的结果——jar 包,存放的目录:target
6、安装操作
mvn install
安装的效果是将本地构建过程中生成的 jar 包存入 Maven 本地仓库。这个 jar 包在 Maven 仓库中的路径是根据它的坐标生成的。
另外,安装操作还会将 pom.xml 文件转换为 XXX.pom 文件一起存入本地仓库。所以我们在 Maven 的本地仓库中想看一个 jar 包原始的 pom.xml 文件时,查看对应 XXX.pom 文件即可,它们是名字发生了改变,本质上是同一个文件。
③:创建 Maven 版的 Web 工程
1、说明
使用 mvn archetype:generate 命令生成 Web 工程时,需要使用一个专门的 archetype。这个专门生成 Web 工程骨架的 archetype 可以参照官网看到它的用法:
2、操作
注意:如果在上一个工程的目录下执行 mvn archetype:generate 命令,那么 Maven 会报错:不能在一个非 pom 的工程下再创建其他工程。所以不要再刚才创建的工程里再创建新的工程,请回到工作空间根目录来操作。
然后运行生成工程的命令:
mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes -DarchetypeArtifactId=maven-archetype-webapp -DarchetypeVersion=1.4
3、生成的pom.xml
确认打包的方式是war包形式
改为4.12
4、生成的Web工程的目录结构
5、创建 Servlet
①在 main 目录下创建 java 目录
②在 java 目录下创建 Servlet 类所在的包的目录
③在包下创建 Servlet 类
package com.sdjzu.maven;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.ServletException;
import java.io.IOException;
public class HelloServlet extends HttpServlet{
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
response.getWriter().write("hello maven web");
}
}
④在 web.xml 中注册 Servlet
<servlet>
<servlet-name>helloServlet</servlet-name>
<servlet-class>com.sdjzu.maven.HelloServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>helloServlet</servlet-name>
<url-pattern>/helloServlet</url-pattern>
</servlet-mapping>
6、在 index.jsp 页面编写超链接
<html>
<body>
<h2>Hello World!</h2>
<a href="helloServlet">Access Servlet</a>
</body>
</html>
7、编译
8、配置对 servlet-api.jar 包的依赖
对于不知道详细信息的依赖可以到**https://mvnrepository.com/**网站查询。使用关键词搜索,然后在搜索结果列表中选择适合的使用。
9、将 Web 工程打包为 war 包
10、将 war 包部署到 Tomcat 上运行
将 war 包复制到 Tomcat/webapps 目录下
启动 Tomcat:
通过浏览器尝试访问:http://localhost:8080/pro02-maven-web/index.jsp
④:让 Web 工程依赖 Java 工程
#1、观念
明确一个意识:从来只有 Web 工程依赖 Java 工程,没有反过来 Java 工程依赖 Web 工程。本质上来说,Web 工程依赖的 Java 工程其实就是 Web 工程里导入的 jar 包。最终 Java 工程会变成 jar 包,放在 Web 工程的 WEB-INF/lib 目录下。
#2、操作
在 pro02-maven-web 工程的 pom.xml 中,找到 dependencies 标签,在 dependencies 标签中做如下配置:
3、在 Web 工程中,编写测试代码
①补充创建目录
pro02-maven-web\src\test\java\com\sdjzu\maven
D:\developertool\Maven\maven-workspace\00\pro02-maven-web\src\test\com\sdjzu
②确认 Web 工程依赖了 junit
③创建测试类
把 Java 工程的 CalculatorTest.java 类复制到 pro02-maven-wb\src\test\java\com\sdjzu\maven 目录下
#4、执行Maven命令
#①测试命令
mvn test
原因:在上一步忘了创建java,在一个Maven项目中必须要有‘’src“目录和”POM.xml“文件,这两个是同一个层次的。其次在”src“目录下必须存在”main“和”test“目录。在”main“和”test“目录下有必须要有”java“目录。
说明:测试操作中会提前自动执行编译操作,测试成功就说明编译也是成功的。
#②打包命令
mvn package
通过查看 war 包内的结构,我们看到被 Web 工程依赖的 Java 工程确实是会变成 Web 工程的 WEB-INF/lib 目录下的 jar 包。
③查看当前 Web 工程所依赖的 jar 包的列表
mvn dependency:list
这样的格式虽然和我们 XML 配置文件中坐标的格式不同,但是本质上还是坐标信息,大家需要能够认识这样的格式,将来从 Maven 命令的日志或错误信息中看到这样格式的信息,就能够识别出来这是坐标。进而根据坐标到Maven 仓库找到对应的jar包,用这样的方式解决我们遇到的报错的情况。
④以树形结构查看当前 Web 工程的依赖信息
mvn dependency:tree
我们在 pom.xml 中并没有依赖 hamcrest-core,但是它却被加入了我们依赖的列表。原因是:junit 依赖了hamcrest-core,然后基于依赖的传递性,hamcrest-core 被传递到我们的工程了。
⑤:测试依赖的范围
标签的位置:dependencies/dependency/scope
标签的可选值:compile/test/provided/system/runtime/import
#①compile 和 test 对比
②compile 和 provided 对比
③结论
compile:通常使用的第三方框架的 jar 包这样在项目实际运行时真正要用到的 jar 包都是以 compile 范围进行依赖的。比如 SSM 框架所需jar包。
test:测试过程中使用的 jar 包,以 test 范围依赖进来。比如 junit。
provided:在开发过程中需要用到的“服务器上的 jar 包”通常以 provided 范围依赖进来。比如 servlet-api、jsp-api。而这个范围的 jar 包之所以不参与部署、不放进 war 包,就是避免和服务器上已有的同类 jar 包产生冲突,同时减轻服务器的负担。说白了就是:“服务器上已经有了,你就别带啦!”
⑥:测试依赖的传递性
#①概念
A 依赖 B,B 依赖 C,那么在 A 没有配置对 C 的依赖的情况下,A 里面能不能直接使用 C?
#②传递的原则
在 A 依赖 B,B 依赖 C 的前提下,C 是否能够传递到 A,取决于 B 依赖 C 时使用的依赖范围。
B 依赖 C 时使用 compile 范围:可以传递
B 依赖 C 时使用 test 或 provided 范围:不能传递,所以需要这样的 jar 包时,就必须在需要的地方明确配置依赖才可以。
⑦:测试依赖的排除
#1、概念
当 A 依赖 B,B 依赖 C 而且 C 可以传递到 A 的时候,A 不想要 C,需要在 A 里面把 C 排除掉。而往往这种情况都是为了避免 jar 包之间的冲突。
所以配置依赖的排除其实就是阻止某些 jar 包的传递。因为这样的 jar 包传递过来会和其他 jar 包冲突
⑧:继承
#1、概念
Maven工程之间,A 工程继承 B 工程
B 工程:父工程
A 工程:子工程
本质上是 A 工程的 pom.xml 中的配置继承了 B 工程中 pom.xml 的配置。
#2、作用
在父工程中统一管理项目中的依赖信息,具体来说是管理依赖信息的版本。
它的背景是:
对一个比较大型的项目进行了模块拆分。
一个 project 下面,创建了很多个 module。
每一个 module 都需要配置自己的依赖信息。
它背后的需求是:
在每一个 module 中各自维护各自的依赖信息很容易发生出入,不易统一管理。
使用同一个框架内的不同 jar 包,它们应该是同一个版本,所以整个项目中使用的框架版本需要统一。
使用框架时所需要的 jar 包组合(或者说依赖信息组合)需要经过长期摸索和反复调试,最终确定一个可用组合。这个耗费很大精力总结出来的方案不应该在新的项目中重新摸索。
通过在父工程中为整个项目维护依赖信息的组合既保证了整个项目使用规范、准确的 jar 包;又能够将以往的经验沉淀下来,节约时间和精力
⑨:聚合
#1、聚合本身的含义
部分组成整体
2、Maven 中的聚合
使用一个“总工程”将各个“模块工程”汇集起来,作为一个整体对应完整的项目。
项目:整体
模块:部分
TIP
概念的对应关系:
从继承关系角度来看:
父工程
子工程
从聚合关系角度来看:
总工程
模块工程
#3、好处
一键执行 Maven 命令:很多构建命令都可以在“总工程”中一键执行。
以 mvn install 命令为例:Maven 要求有父工程时先安装父工程;有依赖的工程时,先安装被依赖的工程。我们自己考虑这些规则会很麻烦。但是工程聚合之后,在总工程执行 mvn install 可以一键完成安装,而且会自动按照正确的顺序执行。
配置聚合之后,各个模块工程会在总工程中展示一个列表,让项目中的各个模块一目了然