漫画:工作这么多年,你居然不知道 Maven 中 Optional 和 Exclusions 的区别?
Maven 依赖排除(Exclusions)
因为 Maven 构建项目具有依赖可传递的特性,当你在 pom.xml
添加某个依赖时,可能也会引入不需要的依赖到你的项目中,这将会会可能引起如下问题:
Jar
包版本冲突,如老版本Jar
包缺失某个方法;- JDK 版本不兼容;
- 老版本存在安全漏洞;
- ...
为了解决这些问题,Maven 容许你通过 <exclusions>
来排除你不想要的依赖。这样,在你构建项目时,这些被排除依赖,将不会被打包进你的项目中。
PS:
<exclusions>
需要在具体的依赖上显示指定,针对特定的groupId
和artifactId
。
如何使用呢?
在 <dependency>
节点中添加<exclusions>
,指定你想要排除的依赖,如下所示:
<project>
...
<dependencies>
<dependency>
<groupId>sample.ProjectA</groupId>
<artifactId>Project-A</artifactId>
<version>1.0</version>
<scope>compile</scope>
<exclusions>
<exclusion> <!-- 在这里声明,将项目A中的项目B依赖排除 -->
<groupId>sample.ProjectB</groupId>
<artifactId>Project-B</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
</project>
Maven 可选依赖 (Optional)
Maven 的可选依赖其实很好理解,我举个例子,你就明白了!假设你想做一个类似 Mybatis
的持久化框架,那你就得支持丰富的数据库吧,如:MySql
、 Oracle
不同版本、 PostgreSQL
等,这样才会有更多的用户使用你的框架。这样的话,你就不得不在你开发的持久化框架里引入种类繁多的数据库驱动包。
这个时候,某个用户使用了你的框架,而他仅需要使用数据库 MySQL
,因为 Maven 构建项目具有依赖可传递的特性,导致了项目打包时,引入了很多不必要的数据库驱动,那压根不是他需要的~
当某个依赖的 <optional>
被定义为 true
后,该依赖便只能在本项目中传递,不会被传递到引用该依赖的父项目中,父项目需要主动引用才行。
为什么需要可选依赖项
可选依赖项可以帮助项目节省空间与内存,亦可防止将许可协议的依赖构建到 WAR
, EAR
, fat
jar 等包中。
如何使用
<project>
...
<dependencies>
<!-- 将 mysql 驱动包依赖设置为可选 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.45</version>
<optional>true</optional> <!-- optional 的值有 true 和 false 可选 -->
</dependency>
</dependencies>
</project>
举个例子🌰
针对上面的场景,可以在我们的持久化框架中,将每个驱动包依赖均设置为可选:
这时,假设有个 ProjectA 项目需要使用这个持久化框架,数据库使用的 Mysql
, 那么它还需要在 ProjectA 项目中,重新添加 Mysql
驱动依赖:
总结
最后,我们总结下 Maven 中的 <optional>
与 <exclusions>
的区别:
它们都是用来排除 Jar 包依赖的,但是作用上却是有所不同。
- 依赖被定义为
optional
可选,那么依赖只能在该项目中传递,并不会被传递到引用该项目的父项目中,父项目需要重新引用该依赖才可以。 exclusions
则是排除子项目中传递过来的依赖。
PS: 这期分享到这里就结束咯,首次采用漫画文的这种创作方式,真的花了好长时间,希望小伙伴会喜欢这种方式~
可以的话,希望小伙伴们三连哟,阅读效果好的话,小哈会创作更多的漫画文,给技术添点料,让它稍微有趣一点~
哈哈,下期见~
Ref
http://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html
https://www.exception.site/essay/what-different-maven-optional-exclusions
作者:犬小哈
出处:犬小哈教程: www.quanxiaoha.com
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
本文如对您有帮助,还请多帮 【推荐】 下此文。
如果喜欢我的文章,不妨关注下我的公众号哟
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 如何编写易于单元测试的代码
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
· 地球OL攻略 —— 某应届生求职总结
· 周边上新:园子的第一款马克杯温暖上架
· Open-Sora 2.0 重磅开源!
· 提示词工程——AI应用必不可少的技术
· .NET周刊【3月第1期 2025-03-02】