maven的optional选项说明以及具体应用

news/2024/11/16 8:28:05/

写在前面

本文看下maven的optional选项的作用和用法。

1:什么作用

考虑这样的场景,A依赖B,B依赖C,正常的按照依赖的传递性,A也会间接的依赖C,但是在一些特定的场景中项目A只希望依赖B,而不依赖C,此时就需要使用到optional选项。具体使用也比较简单,只需要在C的对应依赖GAV中增加<optional>true</optional>就行了。

2:实战例子

我们使用maven的父子项目首先创建项目A,其POM如下:

<?xml version="1.0" encoding="UTF-8"?>
<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><parent><groupId>org.example</groupId><artifactId>untitled5656</artifactId><version>1.0-SNAPSHOT</version></parent><artifactId>A</artifactId><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><dependencies><dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.83</version>
<!--            <optional>true</optional>--></dependency></dependencies>
</project>

可以看到我们依赖了fastjson,并且注释掉了optional(默认false),接着处理项目B,在其pom中依赖项目A:

<?xml version="1.0" encoding="UTF-8"?>
<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><parent><groupId>org.example</groupId><artifactId>untitled5656</artifactId><version>1.0-SNAPSHOT</version></parent><artifactId>B</artifactId><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><dependencies><dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId><version>5.8.26</version></dependency><dependency><groupId>org.example</groupId><artifactId>A</artifactId><version>1.0-SNAPSHOT</version></dependency></dependencies>
</project>

接着执行命令mvn clean install dependency:tree:

PS D:\netty-sourcecode\untitled5656> mvn clean install dependency:tree 
...
[INFO] org.example:B:jar:1.0-SNAPSHOT
[INFO] +- cn.hutool:hutool-all:jar:5.8.26:compile
[INFO] \- org.example:A:jar:1.0-SNAPSHOT:compile
[INFO]    \- com.alibaba:fastjson:jar:1.2.83:compile
...
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  3.410 s
[INFO] Finished at: 2024-11-15T11:38:20+08:00
[INFO] ------------------------------------------------------------------------

可以看到此时项目B不仅仅依赖了项目A,还传递依赖了项目A直接依赖的fastjson,如果是不需要依赖fastjson,则可以修改jackson pom为如下:

<dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.83</version><optional>true</optional>
</dependency>

即增加<optional>true</optional>,重新导入依赖后,再执行命令mvn clean install dependency:tree:

PS D:\netty-sourcecode\untitled5656> mvn clean install dependency:tree
[INFO] Scanning for projects...
...
[INFO] --- maven-dependency-plugin:2.8:tree (default-cli) @ B ---
[INFO] org.example:B:jar:1.0-SNAPSHOT
[INFO] +- cn.hutool:hutool-all:jar:5.8.26:compile
[INFO] \- org.example:A:jar:1.0-SNAPSHOT:compile
[INFO] ------------------------------------------------------------------------
...
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  3.324 s
[INFO] Finished at: 2024-11-15T11:44:23+08:00
[INFO] ------------------------------------------------------------------------

此时项目A的jackson就没有被传递依赖了。

3:在netty中的应用

netty中的日志工具类,会根据我们项目中具体引入了哪种jdk的相关jar而进行动态的选择日志实现,如下:

// io.netty.util.internal.logging.InternalLoggerFactory#newDefaultFactory
private static InternalLoggerFactory newDefaultFactory(String name) {InternalLoggerFactory f = useSlf4JLoggerFactory(name);if (f != null) {return f;}f = useLog4J2LoggerFactory(name);if (f != null) {return f;}f = useLog4JLoggerFactory(name);if (f != null) {return f;}return useJdkLoggerFactory(name);
}

其中以useSlf4JLoggerFactory为例看下:

private static InternalLoggerFactory useSlf4JLoggerFactory(String name) {try {InternalLoggerFactory f = new Slf4JLoggerFactory(true);f.newInstance(name).debug("Using SLF4J as the default logging framework");return f;} catch (LinkageError ignore) {return null;} catch (Exception ignore) {// We catch Exception and not ReflectiveOperationException as we still support java 6return null;}
}

这里当运行环境中有对应的类时就会返回正常的实例,否则发生异常返回null。这里的日志相关的依赖就都是optional的,因为使用common包的项目并不一定需要这些依赖,就算需要的话,自己单独引入就可以了,如下:
在这里插入图片描述
而因为common中引入了,所以common本身的编译肯定是没有问题的,只不过依赖common的项目不会传递依赖这些log相关的依赖了。

写在后面

参考文章列表

maven之如何查看依赖树 。


http://www.ppmy.cn/news/1547404.html

相关文章

H5页面多个视频如何只同时播放一个?

目录 背景1. 首先介绍下 muted 属性2. 监听播放和暂停操作3. 视频播放完毕后返回桌面&#xff0c;再进入H5页面发现视频封面丢失置灰解决思路&#xff1a; 背景 页面模块同时有个四个视频模块&#xff0c;发现可以同时播放四个视频&#xff0c;但是理想的是每次只播放一个。 …

ApiSmart-QWen2.5 coder vs GPT-4o 那个更强? ApiSmart 测评

QWen2.5 coder vs GPT-4o 那个更强&#xff1f; 那个更快&#xff0c; 那个更精准&#xff0c;让我们来看看&#xff1b; ApiSmart Api design Copilot - ApiHugApiSmart make your api design and implement happierhttps://apihug.com/zhCN-docs/copilot 【Apismart】QWen2.…

SpringBoot -- 自动化装配源码

自动化装配源码 EnableAutoConfiguration 注解&#xff0c;开启自动配置的核心注解AutoConfigurationPackage 注解 AutoConfigurationImportSelector 类getAutoConfigurationEntry 方法getCandidateConfigurations 方法 SpringFactoriesLoader EnableAutoConfiguration 注解&am…

Rust 语言学习笔记(五)

终于来到了 Rust 的精髓所在了&#xff0c;那就是使之不依赖于垃圾回收又能保障内存安全且高效运行的所有权系统(Ownership System)。想要用 Rust 做一个稍显规模项目必定绕不过它&#xff0c;所有权系统包括所有权(Ownership), 借用(Borrowing), 生命周期(Lifetimes)。 以下概…

【教程】Ubuntu设置alacritty为默认终端

转载请注明出处&#xff1a;小锋学长生活大爆炸[xfxuezhagn.cn] 如果本文帮助到了你&#xff0c;欢迎[点赞、收藏、关注]哦~ 目录 背景介绍 设置教程 注意事项 背景介绍 alacritty是一个开源的终端&#xff0c;比默认的xterm更好看&#xff0c;甚至编辑文本时候还会代码高亮…

使用 Vue 和 ECharts 创建交互式图表

使用 Vue 和 ECharts 创建交互式图表 引言 在现代 Web 应用中&#xff0c;数据可视化是一个重要的组成部分。它不仅能够帮助用户更好地理解复杂的数据&#xff0c;还能提升用户体验。 技术背景 Vue.js Vue.js 是一个渐进式 JavaScript 框架&#xff0c;用于构建用户界面。…

面试经典 150 题:20、2、228

20. 有效的括号 参考代码 #include <stack>class Solution { public:bool isValid(string s) {if(s.size() < 2){ //特判&#xff1a;空字符串和一个字符的情况return false;}bool flag true;stack<char> st; //栈for(int i0; i<s.size(); i){if(s[i] ( |…

免押租赁系统的优势与应用前景分析

内容概要 免押租赁系统是一种新兴的租赁形式&#xff0c;它利用了信用大数据与区块链技术的优势&#xff0c;帮助用户摆脱了传统租赁中常见的押金烦恼。通过这种方式&#xff0c;用户不仅可以体验到更低的租用门槛&#xff0c;还能享受到更顺畅的交易过程。用户只需提供基本的…