Maven核心知识
前言
Java领域,可以说Maven随处可见。Maven的仓库管理、依赖管理、继承和聚合等特性为项目的构建提供了一整套完善的解决方案,可以说如果你搞不懂Maven,那么一个多模块的项目足以让你头疼,依赖冲突就会让你不知所措,甚至搞不清楚项目是如何运行起来的.....OK,博主就曾经被Maven“伤害”过,那么该专题的目的就是:彻底搞定Maven!
Thinking in Maven
回想一下,当你新到一家公司,安装完JDK后就会安装配置Maven(MAVEN_HOME、path),很大可能性你需要修改settings.xml文件,比如你会修改本地仓库地址路径,比如你很可能会copy一段配置到你的settings.xml中(很可能就是私服的一些配置)。接下来,你会到IDEA或者Eclipse中进行Maven插件配置,然后你就可以在工程中的pom.xml里面开始添加<dependency>标签来管理jar包,在Maven规范的目录结构下进行编写代码,最后你会通过插件的方式来进行测试、打包(jar or war)、部署、运行。
上面描述了我们对Maven的一些使用方式,下面我们进行一些思考:
Q1:本地仓库?Maven到底有哪些仓库?它们什么关系?
仓库关系 自定义本地仓库位置你要jar包,不可能每次都要联网去下载吧,多费劲,所以本地仓库就是相当于加了一层jar包缓存,先到这里来查。如果这里查不到,那么就去私服上找,如果私服也找不到,那么去中央仓库去找,找到jar后,会把jar的信息同步到私服和本地仓库中。
私服,就是公司内部局域网的一台服务器而已,你想一下,当你的工程Project-A依赖别人的Project-B的接口,怎么做呢?没有Maven的时候,当然是copy Project-B jar到你的本地lib中引入,那么Maven的方式,很显然需要其他人把Project-B deploy到私服仓库中供你使用。因此私服中存储了本公司的内部专用的jar!不仅如此,私服还充当了中央仓库的镜像,说白了就是一个代理!
中央仓库:该仓库存储了互联网上的jar,由Maven团队来维护,地址是:http://repo1.maven.org/maven2/。
Q2:关于<dependency>的使用
image其实这个标签揭示了jar的查找坐标:groupId、artifactId、version。
一般而言,我们可以到私服上输入artifactId进行搜索,或者到http://search.maven.org/、http://mvnrepository.com/上进行查找确定坐标。
version分为开发版本(Snapshot)和发布版本(Release),那么为什么要分呢?**
在实际开发中,我们经常遇到这样的场景,比如A服务依赖于B服务,A和B同时开发,B在开发中发现了BUG,修改后,将版本由1.0升级为2.0,那么A必须也跟着在POM.XML中进行版本升级。过了几天后,B又发现了问题,进行修改后升级版本发布,然后通知A进行升级...可以说这是开发过程中的版本不稳定导致了这样的问题。
Maven,已经替我们想好了解决方案,就是使用Snapshot版本,在开发过程中B发布的版本标志为Snapshot版本,A进行依赖的时候选择Snapshot版本,那么每次B发布的话,会在私服仓库中,形成带有时间戳的Snapshot版本,而A构建的时候会自动下载B最新时间戳的Snapshot版本!
Q3:既然Maven进行了依赖管理,为什么还会出现依赖冲突?处理依赖冲突的手段是?
image首先来说,对于Maven而言,同一个groupId同一个artifactId下,只能使用一个version!
根据上图的依赖顺序,将使用1.2版本的jar。
现在,我们可以思考下了,比如工程中需要引入A、B,而A依赖1.0版本的C,B依赖2.0版本的C,那么问题来了,C使用的版本将由引入A、B的顺序而定?这显然不靠谱!如果A的依赖写在B的依赖后面,将意味着最后引入的是1.0版本的C,很可能在运行阶段出现类(ClassNotFoundException)、方法(NoSuchMethodError)找不到的错误(因为B使用的是高版本的C)!
这里其实涉及到了2个概念:依赖传递(transitive)、Maven的最近依赖策略。
依赖传递:如果A依赖B,B依赖C,那么引入A,意味着B和C都会被引入。
Maven的最近依赖策略:如果一个项目依赖相同的groupId、artifactId的多个版本,那么在依赖树(mvn dependency:tree)中离项目最近的那个版本将会被使用。(从这里可以看出Maven是不是有点小问题呢?能不能选择高版本的进行依赖么?据了解,Gradle就是version+策略)
现在,我们可以想想如何处理依赖冲突呢?
想法1:要使用哪个版本,我们是清楚的,那么能不能不管如何依赖传递,都可以进行版本锁定呢?
使用<dependencyManagement> [这种主要用于子模块的版本一致性中]
想法2:在依赖传递中,能不能去掉我们不想依赖的?
使用<exclusions> [在实际中我们可以在IDEA中直接利用插件帮助我们生成]
想法3:既然是最近依赖策略,那么我们就直接使用显式依赖指定版本,那不就是最靠近项目的么?
使用<dependency>
Q4:引入依赖的最佳实践,提前发现问题!
在工程中,我们避免不了需要加一些依赖,也许加了依赖后运行时才发现存在依赖冲突在去解决,似乎有点晚!那么能不能提前发现问题呢?
如果我们新加入一个依赖的话,那么先通过mvn dependency:tree命令形成依赖树,看看我们新加入的依赖,是否存在传递依赖,传递依赖中是否和依赖树中的版本存在冲突,如果存在多个版本冲突,利用上文的方式进行解决!
Q5:Maven规范化目录结构
image这里需要注意2点:
第一:src/main下内容最终会打包到Jar/War中,而src/test下是测试内容,并不会打包进去。
第二:src/main/resources中的资源文件会COPY至目标目录,这是Maven的默认生命周期中的一个规定动作。(想一想,hibernate/mybatis的映射XML需要放入resources下,而不能在放在其他地方了)
Q6:Maven的生命周期
image我们只需要注意一点:执行后面的命令时,前面的命令自动得到执行。
实际上,我们最常用的就是这么几个:
clean:有问题,多清理!
package:打成Jar or War包,会自动进行clean+compile
install:将本地工程Jar上传到本地仓库
deploy:上传到私服
Q7:关于scope依赖范围
既然,Maven的生命周期存在编译、测试、运行这些过程,那么显然有些依赖只用于测试,比如junit;有些依赖编译用不到,只有运行的时候才能用到,比如mysql的驱动包在编译期就用不到(编译期用的是JDBC接口),而是在运行时用到的;还有些依赖,编译期要用到,而运行期不需要提供,因为有些容器已经提供了,比如servlet-api在tomcat中已经提供了,我们只需要的是编译期提供而已。
总结来说:
compile:默认的scope,运行期有效,需要打入包中。
provided:编译期有效,运行期不需要提供,不会打入包中。
runtime:编译不需要,在运行期有效,需要导入包中。(接口与实现分离)
test:测试需要,不会打入包中。
system:非本地仓库引入、存在系统的某个路径下的jar。(一般不使用)
**Q8: 不同环境使用不同配置:Profile+Filter
在实际开发场景下,我们必然会存在多套环境:测试环境、开发环境、线上环境等。在不同环境下,我们就会有多套配置文件,比如数据源配置。
我们期望的是,不论部署到什么环境,不必修改代码,不必修改配置。
很庆幸的是,Maven提供了一个方便的解决方案:Profile功能。
给大家演示个小demo:
image对于多套环境而言,我们可以抽取出相同的部分,放入到公共的文件当中,把那些跟着环境变化而变化的配置信息,分环境存放,最后根据选择的环境而将那部分配置信息动态注入到公共的文件当中。(比如db.properties和filter/db-xxx.properties)
当然,我们也可以建立多个目录,每一个目录表示一个环境,那么选择一套环境,就让这个目录下的资源文件生效。(比如xxx/config.xml)
Profile定义:
imageIDEA Maven插件:
image如pom.xml所示,通过profile定义了dev、release、test这3套环境。注意在<profile>中通过<properties>进行了自定义属性。
Maven属性的概念?
Maven有一套自己内置的属性,比如{project.xxx},Java相关,操作系统相关等,这些可以直接在pom.xml中进行引用;用户也可以通过<properties>来自定义属性,比如上面的例子,我们就可以在pom.xml中通过${profiles.active}来指明用户选择的profile。
注意,可以指定默认的profile。
选择Profile进行打包?
实质上就是在执行mvn package -Pxxx而已。
我们来具体看一眼配置文件的内容信息:
image这里,我们需要重点注意的是:
在db.properties中,我们通过${jdbc.username}进行了引用,而jdbc.username是在db-xxx.properties中定义的。
说白了,现在,我们要让db-xxx.properties中的KEY成为变量,并进行替换db.properties这个资源文件中的内容。
filter配置:
image第一,我们通过filter来指定变量配置文件的地址,要通过profile变量进行动态选择;
第二,要知道默认Maven资源文件的打包,就是COPY一份资源文件到默认的输出目录,一般就是classes下,现在必须让资源文件可以进行变量替换,因此开启过滤功能;
第三,在图中配置,通过exclude排除了filter资源目录下的文件,也就是最后打包里面没有filter目录下的文件;
第四:要么使用绝对路径,那就要使用到Maven的内置变量;要么使用相对路径,相对于pom.xml文件的路径;
资源插件配置:
image上面的意思就是说把不同环境目录下的配置文件拷贝到classes下,而不是classes下的XXX目录下。
比如我们选择profile为test打包,结果如下:
image image**Q9: 多模块开发:继承与聚合
继承?聚合?
继承,在Java中就存在的概念,而且继承和多态往往密不可分。对于Maven而言,我们可以将一个大的复杂的项目,进行模块划分,这样各个模块各司其职,独立开发,这就涉及到继承与聚合了。
演示一个小Demo:
image image父工程关键片段:
image子工程关键片段:
image其实,上述demo把工程划分为:
parent:root工程,没有代码,只有配置(比如进行版本锁定),用于聚合子模块,在此工程上进行mvn clean/package等,那么maven会自动根据依赖关系对每一个模块进行处理;
web模块依赖service模块,service模块依赖dao模块;
我们可以想象下:
dao模块负责对DB的持久化操作,比如需要依赖mybatis,肯定也需要Spring来进行bean管理以及Mapper代理,也即是依赖mybatis+spring,注意mybatis的mapper文件以及spring的配置文件都放入到resources下。
service模块负责业务逻辑,需要依赖dao模块。由于依赖dao自然就引入了spring依赖,这里只需要加入事务的相关配置。
web模块负责前端交互,需要依赖service模块,以及spring-mvc。
到这里,对于多模块的继承和聚合就有点了解了吧。
这里提一个问题:
在web模块中,除了需要加载web模块中的Spring配置文件外,显然也需要加载service/dao模块中的Spring配置文件,可是web模块依赖service,service依赖dao,也就是说最终web模块会依赖service.jar(spring配置文件在其中),dao.jar(spring配置文件在其中),因此我们需要加载service.jar、dao.jar中的spring配置文件!
留给你思考!_
私服
image私服,我们对其的印象,就如上图所示。其实在日常中,我们对于私服的操作主要在于:
第一:可以搜索依赖坐标得到XML片段;
第二:deploy 依赖到私服以及从私服下载依赖;
私服仓库类型:
imagegroup:一个仓库组,说白了,就是几个仓库的集合。
hosted:宿主仓库,存储公司内部开发的jar,分为Releases/Snapshots。
proxy:用于代理中央仓库。
到这里,你应该能感觉到,在settings.xml/pom.xml中进行私服配置的时候,我们势必会配置宿主仓库的信息,比如仓库的ID、用户名、密码、访问URL等。
作者:张丰哲
链接:https://www.jianshu.com/p/34740cd1fb58
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。