构建与依赖 / 系统课时
排除依赖与可选依赖
排除依赖与可选依赖
当某个库把你不需要的 JAR 传递进来时,可以在当前依赖上使用 exclusions 切断那条传递路径;如果你维护的是上游库,则可以用 optional 表示“本库构建时需要,但下游默认不要继承”。两者看起来都能减少依赖,生效位置和责任边界却完全不同。
学习目标
- 能在
pom.xml中按groupId和artifactId精确排除传递依赖。 - 能判断应该由消费方写
exclusions,还是由库作者声明<optional>true</optional>。 - 能用依赖树验证修改是否真的改变了下游依赖关系。
用 exclusions 切断一条传递路径
exclusions 写在“把问题依赖带进来的那个直接依赖”内部,而不是写成项目级黑名单。下面的项目依赖 Apache HttpClient 4.5.14,并排除它传递引入的 commons-logging:commons-logging。排除项只写坐标,不写版本,因为它描述的是要切断的依赖身份。
片段示例:把下面内容放进现有 pom.xml 的 <dependencies> 中。
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.14</version>
<exclusions>
<exclusion>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
</exclusion>
</exclusions>
</dependency>生效后,commons-logging:commons-logging 不会再通过 HttpClient 这条路径进入当前项目。验证时运行 mvn dependency:tree -Dincludes=commons-logging:commons-logging;如果仍然看到该坐标,说明它还从另一条直接或传递路径进入,需要对那条路径单独处理。

这里最常见的误用是“看到一个不想要的 JAR,就随便找个依赖写 exclusion”。正确做法是先确认它由哪条路径引入,再把排除写在那条路径的入口上。若同一 JAR 还能从另一条路径到达,单个 exclusion 不会形成全局封禁。
optional 控制下游是否自动继承
optional 应由库作者声明。假设你维护 com.example:report-core:1.0.0,其中只有“导出到 PostgreSQL”功能需要 JDBC 驱动,可以把驱动声明为可选依赖。report-core 自己编译和测试时仍能解析该依赖,但其他项目依赖 report-core 时不会自动得到这个驱动。
片段示例:下面内容位于 report-core 自己的 <dependencies> 中。
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>42.7.7</version>
<optional>true</optional>
</dependency>下游如果确实使用 PostgreSQL,就应在自己的 pom.xml 中显式声明 org.postgresql:postgresql。验证方式是在下游项目执行 mvn dependency:tree -Dincludes=org.postgresql:postgresql:未显式声明时不应通过 report-core 看到该驱动,补上直接依赖后才应出现。
用责任边界选择正确方案
可以用一个简单判断:你是在修自己的项目依赖图,还是在定义自己发布出去的库的依赖契约。 前者通常用 exclusions,后者才考虑 optional。
| 场景 | 更合适的做法 | 原因 |
|---|---|---|
| 第三方库传递带入旧版日志库 | 在引入它的直接依赖上写 exclusions |
你无法修改第三方 POM,只能切断当前路径 |
| 自己的 SDK 只有少数功能需要 JDBC 驱动 | 在 SDK 中声明 optional |
下游默认不继承,按需自行声明 |
| 业务代码直接调用某个库的 API | 直接声明该依赖,不要靠传递依赖 | 上游升级后传递关系可能变化 |
| 想让某个 artifact 在整个项目里绝不出现 | 先查全路径,再逐路径排除;必要时配合 Maven Enforcer | 单个 exclusion 只作用于其所在依赖分支 |
修改后至少做两次检查:先用 dependency:tree 验证依赖图,再执行 mvn test 或项目自己的集成测试。依赖树变干净只说明解析结果符合预期;如果业务代码实际调用了被排除依赖中的类,运行阶段仍可能出现缺类或功能异常。