深圳幻海软件技术有限公司 欢迎您!

Maven依赖的作用域你到底用对了没有

2023-02-28

​Maven是目前Java开发主要使用的依赖管理构建工具之一,但是很多人在引用依赖的时候直接引用坐标,而没有考虑依赖的作用范围,结果导致出现这样和那样的问题。今天胖哥就来说明一下Maven引用依赖的一个要点概念——作用域。要选择正确的scopescope是Maven坐标的一个关键字,它主要来限制依赖

​Maven是目前Java开发主要使用的依赖管理构建工具之一,但是很多人在引用依赖的时候直接引用坐标,而没有考虑依赖的作用范围,结果导致出现这样和那样的问题。今天胖哥就来说明一下Maven引用依赖的一个要点概念——作用域。

要选择正确的scope

scope是Maven坐标的一个关键字,它主要来限制依赖的作用域。它有五种类型:

Maven依赖的作用域

选择合理的作用域,能够避免一些依赖引用问题。

compile

这是我们大部分情况下使用的引用作用域,它也是Maven默认的scope值,表明该依赖从Java代码编译、测试以及运行时都会参与其中。

runtime

runtime顾名思义,只参与运行时,跳过了编译阶段。当然它打fat jar时也会像compile一样打包。比如我们常用的数据库驱动,你可以去看看自己Spring Boot项目生成器初始化数据库驱动依赖的是不是runtime。

provided

provided用的同学相信不会太多。它用来声明你希望JDK和容器运行时来提供它,你自己不引入,仅仅使用这个依赖,在一些通用规范和插件扩展使用该选项比较普遍。举个例子,servlet api你希望Servlet容器提供,但是你自己还希望去调用HttpServletRequest之类的API,你就可以用provided来声明。

它还有一个场景,比如你自己开发一个针对某个类库A的扩展类库B,你肯定要在扩展类库B中引用A。如果你不使用provided,当你开发完扩展类库B,直接引用B就能使用完整的功能;如果你使用provided,你需要同时引用A和B。为什么要这样做呢?这样做可以让扩展类库更加纯粹,仅仅提供扩展功能,而不干涉主类库的功能,彻底的插件化。

system感觉和provided正好相反。provided是要求别人提供;而system是别人不提供自己提供, Maven不会在本地存储库中查找。使用system的大部分没有托管在Maven中央仓库和私有仓库,另外provided不会被打包,只是申明一个调用关系,system会被打包。

胖哥仅仅建议在测试一些三方私有jar的时候使用,如果该jar被选中的话,还是建议放入私有仓库。system我个人不建议在生产中使用。

optional

optional不是scope的一个选项,而是一个关键字,它的选项是布尔值true和false。这里之所以要说一说,是因为它也能控制依赖的作用域,只不过它的场景和上面的不一样。它用来声明依赖是否是可选的(optional)而不向上传递。

来举一个例子,胖哥开发了一个类库,使用了lombok。但是很多开发者很反感lombok,一看胖哥的这个类库里面用lombok他们就不用了。胖哥为了推广,肯定要想办法照顾这一部分人,所以就让lombok的optional值设置为true。这样不耽误胖哥类库中lombok注解的使用,也不影响使用了胖哥类库的开发者。你可以去看看Spring Boot Starter,里面使用了大量的optional。

要注意和provided的区别,provided是这个库我一定要用,但是这个库我不提供;optional是这个库我也用,但是我不给你用。

总结

依赖作用域在开发中一定不要忽略,选择合理的作用域能让你项目的依赖更加合理和“干净”。看了本篇后,赶紧去看看你项目的依赖引用是否合理吧。