Maven开发笔记（二）—— Maven中的可选依赖（Optional Dependencies）和依赖排除（Dependency Exclusions）

原文地址

1.Maven中依赖概述

Maven 中的依赖关系是有传递性的。例如：项目B依赖项目C（B —> C），如果有一个项目A依赖项目B（A —> B）的话，那么项目A也会依赖项目C（A —> C）。虽然，这种依赖的自动传递性给我们维护项目的必要依赖关系带来了极大地帮助，但当我们在某些情况下，需要在项目A中排除对项目C的依赖时，这时又该怎么做呢？Maven 为我们提供了两种解决方案，分别是可选依赖（Optional Dependencies）和依赖排除（Dependency Exclusions）。

2.哪些场景需要排除依赖

我们继续用上文中的例子，虽然项目A依赖项目B，但当项目A不是完全依赖项目B的时候，即项目A只用到了项目B的一部分功能，而正巧项目B这部分功能的实现，并不需要依赖于项目C，这个时候，项目A就应该排除对项目C的依赖。

有的人可能有这样的疑问，为什么要排除对项目C的依赖呢？就算包含了对项目C的依赖，也不会出问题啊。事实上，表面上看确实不会出现问题。但是，我们必须记住一点：当我们使用一个工程时，控制实际需要的依赖列表非常重要。而且，排除不必要的依赖还可以帮助我们，节约磁盘、内存等空间，避免许可协议问题以及类路径问题等。我们在享受Maven依赖的自动传递性带给我们的便利的同时，要时刻注意引入冗余、不必要的依赖对我们项目产生的负面影响。

### 3.可选依赖（Optional Dependencies）—— optional

从项目B入手，使项目A依赖项目B时，排除对项目C的依赖。项目B的配置片段如下：

<project>
  ...
  <dependencies>
    <dependency>
      <groupId>sample.ProjectC</groupId>
      <artifactId>Project-C</artifactId>
      <version>1.0</version>
      <scope>compile</scope>
      <optional>true</optional>
    </dependency>
  </dependencies>
</project>

在项目A中按照正常的方式引入对项目B的依赖即可，这个时候，项目A就不会依赖项目C了。如果项目A用到了项目B中涉及项目C的功能，则需要在项目A的 pom.xml 文件中额外配置对项目C的依赖。

应用场景：假设有一个项目X，它实现了类似Hibernate的功能，支持很多种数据库驱动，例如：mysql，oracle等。我们在构建项目X的时候，确实需要所有这些依赖。但设想，假如有一个项目Y想使用项目X提供的功能，那么它极有可能只使用其中的一种数据库驱动。这个时候，就需要我们在项目X中将所有和驱动相关的依赖设置为可选依赖。只有这样，在项目Y中声明项目X为直接依赖的时候，才不会将项目X的所有关于驱动的依赖自动引入。这时，项目Y只需要额外声明自己真正需要依赖的驱动即可。

4.依赖排除（Dependency Exclusions）—— exclusion

接上文例子，如果项目B没有把项目C设置为可选依赖（Optional Dependencies），而项目A又想在依赖项目B的同时不依赖项目C，应该如何操作呢？这个时候，我们使用依赖排除（Dependency Exclusions）就可以达到目的。此时，项目B按照正常的方式引入对项目C的依赖，项目A在引入对项目B的依赖时，配置如下：

<project>
  ...
  <dependencies>
    <dependency>
      <groupId>sample.ProjectB</groupId>
      <artifactId>Project-B</artifactId>
      <version>1.0</version>
      <scope>compile</scope>
      <exclusions>
        <exclusion> 
          <groupId>sample.ProjectC</groupId>
          <artifactId>Project-C</artifactId>
        </exclusion>
      </exclusions> 
    </dependency>
  </dependencies>
</project>

应用场景：接上文例子，假如项目X并没有将所有对驱动的依赖设置为可选依赖（Optional Dependencies），那么项目Y直接引入对项目X的依赖时，就会将项目X中所有对驱动的依赖一起引入。这时候，就需要我们在引入项目X时通过依赖排除（Dependency Exclusions）去除掉我们不需要的那些依赖。

需要注意的是，依赖排除（Dependency Exclusions）是基于单个依赖的，并不是POM级别的。也就是说，虽然，项目A在引入对项目B的依赖时，排除了对项目C的依赖。但，并不影响项目A在其他地方引入对项目C的依赖。例如，项目A又引入了对项目D的依赖，而项目D依赖项目C，这个时候，项目A就又产生了对项目C的依赖。

另外，在Maven引入的jar包发生冲突时，也往往需要借助依赖排除（Dependency Exclusions）来解决。

文章标签： maven dependency exclusion 依赖 j2ee