问题背景
公司有个业务功能的组件,该组件以jar包的形式透出去;为了把组件的pom弄的比较干净,一开始没有加入任何框架,纯粹的java代码;组件写好后,存在一个问题:没有测试用例,测试是在其他项目中引用该组件的时候进行的测试,虽然组件的功能比较固化,不经常变,但是没有测试就很尴尬;假设组件的代码变化了,还需要引用的项目来进行测试,很蛋疼!!!
为了解决测试的问题,在组件中添加了spring的测试框架(先不讨论添加spring测试框架是否正确,因为spring比较熟悉);这个时候就比较爽了,在组件的代码中直接进行测试,一个字“爽”!!!但是问题又来了。。。。。
有一个上游是spark的代码,不希望引用组件包的时候带入spring的任何框架;问题就诞生了:
如何在不删除spring测试框架的前提下,能够使包不透给引用的项目???
解法
摆事实,讲道理;
把组件项目当成A;引用组件的项目当成B;
首先明白为什么B项目引用A项目,会把A中spring的框架的包给引入进来,其实这是maven的机制;maven包管理会把A中涉及的包都引入进来,maven的包具有传递性,当A项目中引用B包,B包中引用C包,那么在引用A包的项目中会把B和C包都引入进来。
那么如何在引用A包的时候把B包给排除掉???
因为是maven包管理,我们首先从maven入手,找到maven的scope关键字,scope是如何用的???
Scope的用法
scope一共有5个值
compile
在编译,链接,运行三个阶段都会打包。
provided
已提供范围,不会被打包,已提供的范围的依赖在编译classpath中。
runtime
运行时需要,编译时不需要。
test
在测试范围需要,正常编译和运行时都不需要;只在测试阶段可用。
system
范围和provided类似,只是需要提供一个本地的包路径。
import
该关键字只适合pom,不能适用于jar。
scope传递性
Dependency | compile | provided | runtime | test |
---|---|---|---|---|
compile | compile | - | runtime | - |
provided | provided | - | provided | - |
runtime | runtime | - | runtime | - |
test | test | - | Test | - |
左边一列是组件的包scope;第一行是引用这个组件的scope;举个栗子,当组件中一个包的scope是provided,那么当引用组件的包的scope是provided时,该包不会被引入。
从maven的传递性看出当引入这个组件的项目的scope为compile时(默认是compile);那么spring框架的包就会被引入,和我们初衷不符,因此scope这条路走不通!!!
optional关键字
查了maven的文档,发现还有个optional关键字;
<dependency>
<groupId>com.test</groupId>
<artifactId>project</artifactId>
<version>1.0.0</version>
<optional>true</optional>
</dependency>
当project
的optional为true,表示这个包不会被打包,在上层的项目中看不到该包,这个关键字解决了我们的问题。
后记
前面我们提到maven项目会把引用的包传递性的打包进来,这样就会诞生一个问题,同一个包在不同的层级都存在;maven如何这样的问题,通过最短路径优先来解决。取maven依赖树路径最短的那个包。
除了同一个包多个层次的问题,还会存在循环依赖的问题,随着项目膨胀,容易出现循环依赖,这就需要我们进行良好的架构设计!!!
网友评论