2_Maven的使用
Maven的使用
一、为什么使用Maven这样的构建工具【why】
① 一个项目就是一个工程
如果项目非常庞大,就不适合使用package来划分模块,最好是每一个模块对应一个工程,利于分工协作。借助于maven就可以将一个项目拆分成多个工程
② 项目中使用jar包,需要“复制”、“粘贴”项目的lib中
同样的jar包重复的出现在不同的项目工程中,你需要做不停的复制粘贴的重复工作。借助于maven,可以将jar包保存在“仓库”中,不管在哪个项目只要使用引用即可就行。
③ jar包需要的时候每次都要自己准备好或到官网下载
借助于maven我们可以使用统一的规范方式下载jar包,规范
④ jar包版本不一致的风险
不同的项目在使用jar包的时候,有可能会导致各个项目的jar包版本不一致,导致未执行错误。借助于maven,所有的jar包都放在“仓库”中,所有的项目都使用仓库的一份jar包。
⑤ 一个jar包依赖其他的jar包需要自己手动的加入到项目中
FileUpload组件->IO组件,commons-fileupload-1.3.jar依赖于commons-io-2.0.1.jar
极大的浪费了我们导入包的时间成本,也极大的增加了学习成本。借助于maven,它会自动的将依赖的jar包导入进来。
二、maven是什么【what】
① maven是一款服务于java平台的自动化构建工具
make->Ant->Maven->Gradle
名字叫法:我们可以叫妹文也可以叫麦文,但是没有叫妈文的。
② 构建
构建定义:把动态的Web工程经过编译得到的编译结果部署到服务器上的整个过程。
编译:java源文件[.java]
->编译->Classz字节码文件[.class]
部署:最终在sevlet容器中部署的不是动态web工程,而是编译后的文件
③ 构建的各个环节
清理clean:将以前编译得到的旧文件class字节码文件删除
编译compile:将java源程序编译成class字节码文件
测试test:自动测试,自动调用junit程序
报告report:测试程序执行的结果
打包package:动态Web工程打War包,java工程打jar包
安装install:Maven特定的概念-----将打包得到的文件复制到“仓库”中的指定位置
部署deploy:将动态Web工程生成的war包复制到Servlet容器下,使其可以运行
三、安装maven
① 当前系统是否配置JAVA_HOME的环境变量
② 下载maven,解压maven放在一个非中文无空格的路径下
③ 配置maven的相关环境变量
在环境变量增加M2_HOME,路径是maven解压后的根目录
在环境变量里的path中增加maven/bin的目录
④ 验证:maven -v 查看maven版本
看到版本信息,恭喜你已经OK了。
四、第一个maven
① 创建约定的目录结构 (maven工程必须按照约定的目录结构创建)
根目录:工程名 |---src:源码 |---|---main:存放主程序 |---|---|---java:java源码文件 |---|---|---resource:存放框架的配置文件 |---|---test:存放测试程序 |---pop.xml:maven的核心配置文件
我们按照上面的文件夹目录结构手动创建一下,不用任何IDE环境(手动的其实最有助于我们理解maven)
文件内容如下
在src/main/java/com/hzg/maven目录下新建文件Hello.java,内容如下
package com.hzg.maven;
public class Hello {
public String sayHello(String name){
return "Hello "+name+"!";
}
}
POM文件内容: 所有 POM 文件都需要 project 元素和三个必需字段:groupId,artifactId,version。
<?xml version="1.0" ?>
<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>
<!-- 公司或者组织的唯一标志,并且配置时生成的路径也是由此生成, 如com.companyname.project-group,maven会将该项目打成的jar包放本地路径:/com/companyname/project-group -->
<groupId>wang.wenlei.maven</groupId>
<!-- 项目的唯一ID,一个groupId下面可能多个项目,就是靠artifactId来区分的 -->
<artifactId>Hello</artifactId>
<!-- 版本号 -->
<version>0.0.1-SNAPSHOT</version>
<name>Hello</name>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.0</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
② 常用maven命令
- mvn clean:清理
- mvn compile:编译主程序
- mvn test-compile:编译测试程序
- mvn test:执行测试
- mvn package:打包
- mvn install:安装
执行maven命令必须进入到pom.xml的目录中进行执行
IDEA中有Maven侧边栏操作
执行完效果
OK,运行完毕,你在pom.xml配置的依赖的包已经导入到仓库了,问题来了,仓库默认的位置在哪?
仓库的默认位置: c:\Usrs[登录当前系统的用户名].m2\repository
,如果配置文件修改了这个路径则为修改后的路径
刚才执行完compile之后,之前的文件夹发生了变化
我们发现Hello项目里里多了一个target文件夹。文件夹的内容为:
发现target里主要存放的就是编译后的字节码文件
2、运行mvn test-compile ,target文件夹下面除了classes之外多了test-classes文件夹
3、运行mvn package ,target文件夹下面又多了一个打好的jar包
4、运行mvn clean,发现整个target文件夹都没了。又回到了编译之前我们手动创建的文件夹
五、仓库和坐标
① pom.xml: Project Object Model 项目对象模型。它是maven的核心配置文件,所有的构建的配置都在这里设置。
② 坐标: 使用下面的三个向量在仓库中唯一的定位一个maven工程
③ maven工程的坐标与仓库中路径的关系:
maven坐标和仓库对应的映射关系:[groupId][artifactId][version][artifactId]-[version].jar
去本地仓库看一下此目录:org\springframework\spring-core\4.3.4.RELEASE\spring-core-4.3.4.RELEASE.jar
果然是完全对应的(默认仓库地址上面说过了哦,不要说不知道在哪,没事下面我们再说一下仓库)
④ 仓库
仓库的分类:
1、本地仓库: 当前电脑上的仓库,路径上已经说过了哦
2、远程仓库:
- 私服:搭建在局域网中,一般公司都会有私服,私服一般使用nexus来搭建。具体搭建过程可以查询其他资料
- 中央仓库:架设在Internet上,像刚才的springframework就是在中央仓库上
六、依赖
① maven解析依赖信息时会到本地仓库中取查找被依赖的jar包
- 对于本地仓库中没有的会去中央仓库去查找maven坐标来获取jar包,获取到jar之后会下载到本地仓库
- 对于中央仓库也找不到依赖的jar包的时候,就会编译失败了
② 如果依赖的是自己或者团队开发的maven工程,需要先使用install命令把被依赖的maven工程的jar包导入到本地仓库中
举例:现在我再创建第二个maven工程HelloFriend,其中用到了第一个Hello工程里类的sayHello(String name)方法。我们在给HelloFriend项目使用 mvn compile命令进行编译的时候,会提示缺少依赖Hello的jar包。怎么办呢?
到第一个maven工程中执行 mvn install后,你再去看一下本地仓库,你会发现有了Hello项目的jar包。一旦本地仓库有了依赖的maven工程的jar包后,你再到HelloFriend项目中使用 mvn compile命令的时候,可以成功编译
③ 依赖范围
scope就是依赖的范围
1、compile, 默认值,适用于所有阶段(开发、测试、部署、运行),本jar会一直存在所有阶段。
2、provided, 只在开发、测试阶段使用,目的是不让Servlet容器和你本地仓库的jar包冲突 。如servlet.jar。
3、runtime, 只在运行时使用,如JDBC驱动,适用运行和测试阶段。
4、test, 只在测试时使用,用于编译和运行测试代码。不会随项目发布。
5、system, 类似provided,需要显式提供包含依赖的jar,Maven不会在Repository中查找它。
七、生命周期
Maven有三套相互独立的生命周期,请注意这里说的是“三套”,而且“相互独立”,初学者容易将Maven的生命周期看成一个整体,其实不然。这三套生命周期分别是:
1. Clean Lifecycle 在进行真正的构建之前进行一些清理工作。
Clean生命周期一共包含了三个阶段:
- pre-clean 执行一些需要在clean之前完成的工作
- clean 移除所有上一次构建生成的文件
- post-clean 执行一些需要在clean之后立刻完成的工作
2. Default Lifecycle 构建的核心部分,编译,测试,打包,部署等等。
- validate
- generate-sources
- process-sources
- generate-resources
- process-resources 复制并处理资源文件,至目标目录,准备打包
- compile 编译项目的源代码
- process-classes
- generate-test-sources
- process-test-sources
- generate-test-resources
- process-test-resources 复制并处理资源文件,至目标测试目录
- test-compile 编译测试源代码
- process-test-classes
- test 使用合适的单元测试框架运行测试。这些测试代码不会被打包或部署
- prepare-package
- package 接受编译好的代码,打包成可发布的格式,如 JAR
- pre-integration-test
- integration-test
- post-integration-test
- verify
- install 将包安装至本地仓库,以让其它项目依赖。
- deploy 将最终的包复制到远程的仓库,以让其它开发人员与项目共享
那我们在Hello的项目中执行 mvn install 命令,通过日志看看中间经历了什么?
通过日志我们发现,其实执行mvn install,其中已经执行了compile 和 test 。
总结: 不论你要执行生命周期的哪一个阶段,maven都是从这个生命周期的开始执行
插件: 每个阶段都有插件(plugin),看上面标红的。插件的职责就是执行它对应的命令。
3. Site Lifecycle 生成项目报告,站点,发布站点。
- pre-site 执行一些需要在生成站点文档之前完成的工作
- site 生成项目的站点文档
- post-site 执行一些需要在生成站点文档之后完成的工作,并且为部署做准备
- site-deploy 将生成的站点文档部署到特定的服务器上\
八、Maven工程的依赖高级特性
WebMavenDemo项目依赖JavaMavenService1 JavaMavenService1项目依赖JavaMavenService2
pom.xml文件配置好依赖关系后,必须首先mvn install后,依赖的jar包才能使用。
- WebMavenDemo的pom.xml文件想能编译通过,JavaMavenService1必须mvn install
- JavaMavenService的pom.xml文件想能编译通过,JavaMavenService2必须mvn install
1. 传递性:
为JavaMavenService2中增加了一个spring-core.jar包后,会惊喜的发现依赖的两个项目都自动的增加了这个jar包,这就是依赖的传递性。
“注意:非compile范围的依赖是不能传递的。
2. 依赖版本的原则:
1、路径最短者优先原则
Service2的log4j的版本是1.2.7版本,Service1排除了此包的依赖,自己加了一个Log4j的1.2.9的版本,那么WebMavenDemo项目遵守路径最短优先原则,Log4j的版本和Sercive1的版本一致。 2、路径相同先声明优先原则
这种场景依赖关系发生了变化,WebMavenDemo项目依赖Sercive1和Service2,它俩是同一个路径,那么谁在WebMavenDemo的pom.xml中先声明的依赖就用谁的版本。
3. 统一管理依赖的版本:
为了统一管理版本号,可以使用properties标签,里面可以自定义版本的标签名。在使用的地方使用${自定义标签名}
optional标签
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.8.18</version>
<optional>true</optional>
</dependency>
optional表示是否会传递依赖,有两个可填值(假如不声明optional标签,默认就是false):
- false: 传递依赖
- true:不传递依赖
举例:A引用了B的依赖,而B又引用了C依赖。 假如B引用C依赖的时候没有设置optional,那么A是可以使用C依赖的。 假如B引用C依赖的时候将optional标签设置为了true,那么在A当中就无法使用C依赖相关的方法,并且A调用B依赖的方法,而B依赖方法使用到了C,这时候会报找不到C依赖下的类,因为C不参与A的打包。
摘自:https://blog.csdn.net/weixin_43888891/article/details/130510971
在父工程设置optional为true,并不会影响子工程继承该依赖。
关于 optional
,最常见的例子就是数据库驱动。例如我们想做一个数据库组件,而且这个数据库组件需要支持多个数据库的话,例如 MySQL
、PostgreSQL
、Oracle
,那么组件端编写的时候将各个数据库的驱动全部引入,像下面这样:
<!-- mysql -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- oracle -->
<dependency>
<groupId>com.oracle</groupId>
<artifactId>ojdbc14</artifactId>
</dependency>
<!-- PostgreSQL -->
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
</dependency>
这样数据库组件倒是可以正常开发了,但是这样做的话,构建出的数据库组件,就同时包含了 mysql、oracle、postgresql 三种数据库的驱动包。应用服务引入了我们的数据库组件后,由于依赖传递,就也会同时引入了上面三种数据库驱动包,加大了应用服务打包后的体积,也浪费了资源,甚至可能出现依赖冲突、jar 包冲突的问题。
optional
就是为了解决上述问题。回到上面的场景,分析后发现,实际上的应用服务不太可能同时使用三种不同的数据库,它只需要自己用到的数据库的驱动包就可以了。比如一个使用了 mysql 的服务,是没有必要引入 oracle 的驱动包的。这时候 optional 就派上用处了。optional 表示该依赖是可选的,意味着构建后,标记为 optional 的依赖是不会被一起打入 jar 包的,也不会发生依赖传递。这样不仅我们自己的组件端体积变小了,应用服务也解决了引入过多无用依赖的问题。 将各个依赖设置为 optional
后,我们打包构建的 jar 将不再包含以上三种数据库的驱动,这样其他应用服务引入了我们的组件后,就不会默认带上上面的数据库驱动包。
可能有同学会疑虑,如果依赖没有带入,那么程序运行期间,会不会发生类找不到的问题?确实是这样的,实际上 optional
表示可选,它将选择权交给了上层应用服务。假如我的服务使用了 mysql,那么我就在服务自己的 pom.xml 中引入 mysql 的驱动包;如果用的是 oracle,同理也是自己引入 oracle 的驱动包,也就是按需使用。如果服务没有引入任何数据库驱动,那么最坏的情况应该是不会使用数据库相关的功能,而不是报错。
最全的maven依赖项版本查询网站
最后推荐个最新最全的maven依赖项版本查询网站:
“http://mvnrepository.com/