Maven-Optional Dependencies & Dependency Exclusion

最新推荐文章于 2023-06-05 09:00:40 发布
最新推荐文章于 2023-06-05 09:00:40 发布
阅读量149 收藏
点赞数
原文链接：http://www.cnblogs.com/lddbupt/p/5544956.html
版权

本文讨论可选依赖和排除依赖.  帮助用户理解它们是什么, 如何使用, 它们如何工作, 以及什么时候使用它们最合适. 本文也将解释为什么排除是基于单个依赖的, 而非POM级别的.

Optional Dependencies

可选依赖用在不能真正地将一个项目划分为多个子模块时.  一些依赖只在该项目中的某些特性中使用, 并且如果这些特性没有使用到的话, 这些依赖就不需要.  最理想的情况, 这样的特性会被划分到一个依赖于核心功能工程的子模块, 这个新子模块将只有非可选依赖, 因为一旦你决定使用该子模块的功能, 你就会需要这些依赖.

然而, 如果该项目无法划分, 这些依赖就需要被声明为可选的. 如果一个用户想要使用和一个可选依赖相关的功能, 他们需要在自己的工程里声明那个可选依赖.  这并不是处理这种情况的最清晰的方式.. 但可选依赖和依赖排除都是 stop-gap 方案.

Why use optional dependencies?

声明可选依赖不仅仅在节省内存空间问题上很重要. 当一个用户使用一个工程时, 控制实际需要的依赖列表非常重要. 因为这些jar包可能会最终放入一个WAR, EAR, EJB等等. 包含了错误的jar包, 可能会违反许可协议, 引起路径问题等等.

 How do I use the optional tag?

声明一个可选依赖, 只需要在你的依赖声明中简单地设置 <optional> 标签为 true. 如下例所示:

image

How do optional dependencies work?

Project-A -> Project-B

如果 project A 依赖于 project B, 当A将B声明为可选依赖时, 这个关系就确定下来了. 这就像一个正常的构建, B将会被添加到它的类路径里.

Project-X -> Project-A

但当另一个工程 project X 将工程A声明为它的依赖时, 可选依赖就发挥效用了. 你会发现, 工程B没有被包含到X的类路径中. 你需要在POM中直接声明B, 才能将它包含到X的类路径中.

image

Example

假设有一个工程名为X2, 它和Hibernate有相似的功能,  支持很多种数据库驱动, 比如mysql, postge, oracle等. 构建X2需要所有这些依赖, 但你的项目未必. 所以, 将这些依赖声明为可选的对X2来说是非常实用的, 这样无论何时你的项目声明了X2作为一个直接依赖, X2支持的所有驱动就不会自动地包含到你的工程的类路径里, 你需要直接声明你需要的数据库驱动.

[注意] 在理想情况下, 不应用使用可选依赖. 在面向对象设计中, 有个单一职责性原则, 意指一个类应该只有一项职责, 而不是糅合太多功能. 这个原则在规划maven项目时也同样适用. 上例中, 更好的做法是为mysql和postgreSQL分别创建一个maven项目, 基于同样的groupId分配不同的artifactId. 在各自的pom中声明对应的jdbc驱动依赖, 不使用可选依赖. 用户根据需要选择使用. 由于传递性依赖的作用, 就不用再声明jdbc驱动依赖了.

Dependency Exclusions

由于maven 2.x的依赖传递规则, 很有可能你的项目类路径中包含了一些不想要的依赖. 比如说, 你的项目依赖的那些工程可能没有正确地声明他们的依赖集合. 为了应对这个特殊的场景, maven2.x提出了依赖排除的概念. 排除是针对POM中的一个特定的依赖设置的, 以一个特定的groupId和artifactId为标识. 如果你声明了排除依赖, 当你构建你的工程时, 该构件就不会被添加到你的工程的类路径中.

How to use dependency exclusions

我们在pom的<dependency>部分添加<exclusions>标签.

image

How dependency exclusion works and when to use it ( as a last resort! )

如下图所示. 工程A同时依赖于B,C. 而工程B又依赖于D. 默认情况下, A的类路径会包含: B, C, D, E, F.

如果我们不需要使用工程D, 同时不想把它的依赖添加到A的类路径中, 因为我们已知D的某些依赖, 比如说E, 在仓库中找不到了. 而你又不需要工程B中依赖于工程D的那部分功能. 在这种情况下, B的开发者可能会提供一个关于D的可选依赖.

然而!!! 他们没有提供!!!  作为最后的手段, 你依然可以选择在你这一侧把不想要的依赖排除掉.

image

image

如果我们将工程A发布到一个仓库, 并且工程X声明一个关于A的普通依赖, 那么D还会被排除在类路径之外吗?

答案是会. 工程A已经声明了它不需要工程D就可以运行, 所以这会产生一个传递的依赖.

现在, 考虑工程X依赖于Y. 工程Y也有一个关于B的依赖, 且它确实需要由工程D支持的特性. 因此, 在它的依赖列表里不会出现排除D的情况. 它也可能提供一个额外的仓库, 在那里我们可以处理工程E. 在这种情况下, 工程D不是全局排除就非常重要了, 因为它是Y的一个合法依赖.

Why exclusions are made on a per-dependency basis, rather than at the POM level

主要是为了确保依赖关系图是可预知的, 避免排除了不应排除的依赖. 如果你需要排除, 你应绝对确定你引入的哪个依赖带来了不必要的依赖传递.

Reference

http://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html

<Maven实战>

转载于:https://www.cnblogs.com/lddbupt/p/5544956.html

b10l07
关注
Maven学习总结（41）——Maven依赖范围、传递、排除详解
科技D人生
07-13 1453
一、添加依赖 下面我添加了一个spring-web的依赖，maven就会去下载spring-web的jar包及它依赖的一些jar包。 org.springframework spring-web 4.2.5.RELEASE compile 二、依赖范围 依赖配置中有一个scope之前没讲过，它就是依赖范围。什么是依赖范围就是指定你这个jar包在哪个阶段时才有效。 c
【异常】Maven异常‘dependencies.dependency.artifactId‘ does not match a valid id pattern.
最新发布
本本本添哥
03-21 159
具体来说，错误发生在解析项目的 POM 文件时，特别是关于 org.apache.skywalking:apm-toolkit-logback-1.x 和 org.apache.skywalking:apm-toolkit-trace 这两个依赖项的 artifactId。此外，apm-toolkit-logback-1.x 和 apm-toolkit-trace 看起来像是占位符或通配符，而不是有效的 artifactId。问题出现在 artifactId 的值不符合 Maven 的有效 ID 模式。
maven坐标Dependencies和Exclusions详解
热门推荐
eff666的博客
07-22 8万+
1、概念介绍 Dependencies：是可选依赖（Optional Dependencies） Exclusions：是依赖排除（Dependency Exclusions） 2、Dependencies （1）当一个项目A依赖另一个项目B时，项目A可能很少一部分功能用到了项目B，此时就可以在A中配置对B的可选依赖。举例来说，一个类似hibernate的项目，它支持对mysql、oracl
Maven排除依赖和可选依赖
qq_43079001的博客
06-05 784
我们知道 Maven 依赖具有传递性，例如 A 依赖于 B，B 依赖于 C，在不考虑依赖范围等因素的情况下，Maven 会根据依赖传递机制，将间接依赖 C 引入到 A 中。但如果 A 出于某种原因，希望将间接依赖 C 排除，那该怎么办呢？Maven 为用户提供了两种解决方式：排除依赖（Dependency Exclusions）和可选依赖（Optional Dependencies）。
Maven开发笔记（二）—— Maven中的可选依赖（Optional Dependencies）和依赖排除（Dependency Exclusions）
秋梦尘的博客
05-11 7446
Maven 中的依赖关系是有传递性的。Maven 为我们提供了两种管理解决方案，分别是可选依赖（Optional Dependencies）和依赖排除（Dependency Exclusions）。
MAVEN POM dependencies and Dependency Exclusions
weixin_33778544的博客
03-07 147
2019独角兽企业重金招聘Python工程师标准>>> ...
spring-boot-maven-plugin 打包分离依赖lib
beijihukk的博客
02-19 5203
1. 问题：spring-boot项目，默认生成的pom使用spring-boot-maven-plugin打包，会把所有依赖项都打进jar文件中，在调试阶段需要频繁传输jar包时很痛苦。 2. 查找：上网搜索”maven 打包 依赖分离”等关键字，多数文章使用了maven-jar-plugin或其他插件，把spring-boot-maven-plugin替换掉了，例如：https://www.iteye.com/blog/icw-zy-2380977 不说会不会有什么影响，单纯就觉得不完美 -- 自.
Android开发必知的maven-publish插件知识
caizehui的博客
07-26 3707
作为Android开发，在我们开发到一定阶段总会接触SDK开发、组件化开发，这样就会有组件发布Aar的需求。Gradle提供了maven-publish插件供我们完成组件发布需求，但是大多数人可能只是简单的使用，见葫芦画瓢，并没有完整的了解插件的作用。这里本着复习完善的想法，带大家一起好好学习下。...
【异常】‘dependencies.dependency. must be unique:duplicate duplicate declaration of version (?) @ lineXX
本本本添哥
02-01 4420
Maven中存在重复的dependency配置
利用karaf-maven-plugin制作kar部署包
apexlj的博客
10-09 3859
之前项目中部署karaf时是把依赖和本模块的bundle一起扔进deploy目录，然而这种方式有两个明显的缺陷： 对部署的顺序有要求，依赖必须先于模块本身的bundle部署，否则会导致部署失败 一大堆bundle对于部署来说繁琐且容易出错 karaf提供了karaf-maven-plugin这个maven插件来解决这两个问题，首先可以对每一个bundle定义start-level启动顺序，其次可以把
详解 maven的pom.xml用<exclusion>解决版本问题
08-29
主要介绍了详解 maven的pom.xml用解决版本问题的相关资料,希望通过本文能帮助到大家，需要的朋友可以参考下
maven项目pom中scope类型
诚的博客
08-14 437
1.compile：默认值 他表示被依赖项目需要参与当前项目的编译，还有后续的测试，运行周期也参与其中，是一个比较强的依赖。打包的时候通常需要包含进去 2.test：依赖项目仅仅参与测试相关的工作，包括测试代码的编译和执行，不会被打包，例如：junit 3.runtime：表示被依赖项目无需参与项目的编译，不过后期的测试和运行周期需要其参与。与compile相比，跳过了编译而已。例如JDBC驱动，适用运行和测试阶段 4.provided：打包的时候可以不用包进去，别的设施会提供。事实上该依赖理论上可.
SpringBoot项目pom文件排除依赖项
白白白鲤鱼的博客
06-05 1624
SpringBoot项目pom文件排除依赖项
解决pom文件依赖冲突
weixin_43732943的博客
12-01 2866
转载，结合below文档所示， https://blog.csdn.net/zhanhong39/article/details/47749023 自己理解： maven依赖就近原则，如果需要移除冲突的依赖，类似于如下将某个依赖的某一项移除 “ctrl+shift+alt+U”快捷键输出pom依赖框架，右击冲突依赖，选择移除。效果相当于给dependency中加了exclusion <dependency> <groupId>org.springframework&lt
maven的pom 文件scope和exclusion标签
job_csdn的博客
06-13 5163
1.<exclusion> 来排除一些不需要同时下载的依赖ja 1 这个标签的作用是排除关联依赖的引入，因为maven的pom依赖其中 有一点是将关联的依赖全都引入进来 2 这个标签在这的作用就是 如果关联的依赖和引入的其他依赖可能存在冲突， 就必须将关联的依赖排除掉，所以就用这个标签。 ...
maven的pom.xml用<exclusion>解决版本问题
chgp15586的博客
09-20 4003
maven管理库依赖，有个好处就是连同库的依赖的全部jar文件一起下载，免去手工添加的麻烦，但同时也带来了同一个jar会被下载了不同版本的问题，好在pom的配置里面允许用<exclusion>来排除一些不需要同时下载的依赖jar 。 导致jar包冲突的原因 1、mvn的传递依...
maven中排除依赖传递可以在pom.xml文件中使用exclusions标签
【折翼天使不孤单】的博客
02-25 8878
在项目A中引入项目B的依赖，通过依赖传递，会把项目B中的jar都引进来，如果在项目A中不想使用项目B中的某些jar包，可以使用exclusions标签进行排除，具体该标签的用法： <exclusions> <exclusion> <groupId></groupId> <artifactId></artifac...
Description: An attempt was made to call a method that does not exist. The attempt was made from the following location: org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration$PoolBuilderFactory.getPoolConfig(LettuceConnectionConfiguration.java:207) The following method did not exist: 'void org.apache.commons.pool2.impl.GenericObjectPoolConfig.setMaxWait(java.time.Duration)' The calling method's class, org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration$PoolBuilderFactory, was loaded from the following location: jar:file:/D:/Developing%20learning%20software/apache-maven-3.9.2-bin/nfv/org/springframework/boot/spring-boot-autoconfigure/3.1.2/spring-boot-autoconfigure-3.1.2.jar!/org/springframework/boot/autoconfigure/data/redis/LettuceConnectionConfiguration$PoolBuilderFactory.class The called method's class, org.apache.commons.pool2.impl.GenericObjectPoolConfig, is available from the following locations: jar:file:/D:/Developing%20learning%20software/apache-maven-3.9.2-bin/nfv/org/apache/commons/commons-pool2/2.6.0/commons-pool2-2.6.0.jar!/org/apache/commons/pool2/impl/GenericObjectPoolConfig.class The called method's class hierarchy was loaded from the following locations: org.apache.commons.pool2.impl.GenericObjectPoolConfig: file:/D:/Developing%20learning%20software/apache-maven-3.9.2-bin/nfv/org/apache/commons/commons-pool2/2.6.0/commons-pool2-2.6.0.jar org.apache.commons.pool2.impl.BaseObjectPoolConfig: file:/D:/Developing%20learning%20software/apache-maven-3.9.2-bin/nfv/org/apache/commons/commons-pool2/2.6.0/commons-pool2-2.6.0.jar org.apache.commons.pool2.BaseObject: file:/D:/Developing%20learning%20software/apache-maven-3.9.2-bin/nfv/org/apache/commons/commons-pool2/2.6.0/commons-pool2-2.6.0.jar Action: Correct the classpath of your application so that it contains compatible versions of the classes org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration$PoolBuilderFactory and org.apache.commons.pool2.impl.GenericObjectPoolConfig
07-24
The error message suggests that there is a version incompatibility between the classes `LettuceConnectionConfiguration$PoolBuilderFactory` from the Spring Boot autoconfigure library and `GenericObjectPoolConfig` from the Apache Commons Pool library. To resolve this issue, you need to ensure that compatible versions of these libraries are present on your application's classpath. Here's what you can do: 1. Check your application's dependencies: Verify that you have the correct versions of the Spring Boot and Apache Commons Pool libraries specified in your project's dependencies. 2. Resolve version conflicts: If you are using a build tool like Maven or Gradle, ensure that the versions specified for both Spring Boot and Apache Commons Pool are compatible. If there are any conflicting versions, try to align them to a compatible version. 3. Exclude conflicting transitive dependencies: If you are using a build tool, you can exclude the transitive dependencies of Spring Boot or Apache Commons Pool that might be causing conflicts. This can be done by adding exclusion rules in your build file. For example, in Maven, you can exclude a transitive dependency like this: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> <version>3.1.2</version> <exclusions> <exclusion> <groupId>org.apache.commons</groupId> <artifactId>commons-pool2</artifactId> </exclusion> </exclusions> </dependency> ``` By resolving any version conflicts and ensuring compatible versions of the libraries are present on the classpath, you should be able to resolve the method not found error.
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值