关于Maven依赖冲突解决之exclusions

Maven是一种非常流行的构建工具，可以用来自动化构建、打包和管理Java项目中所需的依赖关系。但由于不同的依赖可能会有冲突，因此Maven提供了一种“exclusions”机制来解决这个问题。

1. 什么是exclusions

当一个项目依赖的其他项目中存在相同的依赖时，就可能会发生依赖冲突。例如，项目A依赖了项目B和项目C，而项目B和项目C都依赖了同一个库D，但版本不同，这时就会出现依赖冲突。Maven通过exclusions机制来解决这个问题，通过在项目的pom.xml中排除掉当前依赖项中的某些传递依赖项来避免冲突。

2. exclusions的用法

exclusions的用法非常简单，只需在项目的pom.xml中添加一个标签，然后在该标签内指定要排除的传递依赖项即可。下面是一个示例：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>example-project</artifactId>
    <version>1.0.0</version>
    <exclusions>
        <exclusion>
            <groupId>com.example.libs</groupId>
            <artifactId>example-lib</artifactId>
        </exclusion>
    </exclusions>
</dependency>

在这个示例中，我们在一个依赖项中排除了com.example.libs:example-lib的传递依赖项。

3. exclusions的应用示例

为了更加深入地了解如何使用exclusions，下面解释两个具体的应用示例。

示例1

假设我们有一个Web项目，使用了Spring框架。但在构建期间发现，该项目与某些Spring组件存在版本冲突，导致构建失败。我们可以通过exclusions机制解决这个问题。具体步骤如下：

1. 找出与Spring冲突的组件：首先，我们需要找到与Spring冲突的组件。可以通过查看maven依赖树找出。

bash
mvn dependency:tree

具体结果可以如下：

bash
[INFO] com.example:webproject:war:1.0-SNAPSHOT
[INFO] +- org.springframework:spring-core:jar:5.2.3.RELEASE:compile
[INFO] | \- org.springframework:spring-jcl:jar:5.2.3.RELEASE:compile
[INFO] | \- org.slf4j:slf4j-api:jar:1.7.26:compile
[INFO] +- org.springframework:spring-web:jar:5.2.3.RELEASE:compile
[INFO] | +- org.springframework:spring-beans:jar:5.2.3.RELEASE:compile
[INFO] | \- org.springframework:spring-context:jar:5.2.3.RELEASE:compile
[INFO] | +- org.springframework:spring-aop:jar:5.2.3.RELEASE:compile
[INFO] | \- org.springframework:spring-expression:jar:5.2.3.RELEASE:compile
[INFO] \- javax.servlet:javax.servlet-api:jar:4.0.1:compile

可以看到，Spring-core版本为5.2.3.RELEASE，Spring-web版本为5.2.3.RELEASE。这两个版本与某些Spring组件发生了冲突。

1. 排除相应的传递依赖项：由于Spring组件中存在与Spring-core和Spring-web冲突的版本，我们可以在项目的pom.xml中排除掉这两个组件的传递依赖项。具体代码如下：

xml
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-framework-bom</artifactId>
<version>5.2.3.RELEASE</version>
<type>pom</type>
<scope>import</scope>
<exclusions>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
</exclusion>
</exclusions>
</dependency>

在这个例子中，我们使用了spring-framework-bom作为整个Spring框架的依赖项，并在其中排除了spring-core和spring-web组件。

示例2

另一个示例是一个Spring Boot项目，其依赖于Spring-data-jpa以与数据库交互。如果我们希望使用一个不同的JPA提供程序而不是默认的Hibernate，我们可以使用exclusions来实现。具体步骤如下：

1. 查找要排除的传递依赖项：我们首先需要找到hibernate-entitymanager组件，并确定哪些传递依赖项需要被排除。可以通过以下命令查找：

bash
mvn dependency:tree -Dverbose -Dincludes=hibernate-entitymanager

具体结果如下：

bash
[INFO] +- org.springframework.boot:spring-boot-starter-data-jpa:jar:2.2.4.RELEASE:runtime
[INFO] | +- org.springframework.boot:spring-boot-starter-aop:jar:2.2.4.RELEASE:runtime
[INFO] | | \- org.aspectj:aspectjweaver:jar:1.9.5:runtime
[INFO] | +- org.springframework.boot:spring-boot-starter-jdbc:jar:2.2.4.RELEASE:runtime
[INFO] | | +- com.zaxxer:HikariCP:jar:3.4.2:runtime
[INFO] | | \- org.springframework:spring-jdbc:jar:5.2.3.RELEASE:runtime
[INFO] | +- javax.transaction:javax.transaction-api:jar:1.3:runtime
[INFO] | +- org.hibernate:hibernate-core:jar:5.4.10.Final:runtime
[INFO] | | \- org.javassist:javassist:jar:3.24.0-GA:runtime
[INFO] | +- org.hibernate:hibernate-entitymanager:jar:5.4.10.Final:runtime
[INFO] | | \- org.jboss.logging:jboss-logging:jar:3.4.1.Final:runtime
[INFO] | +- org.springframework.data:spring-data-jpa:jar:2.2.4.RELEASE:runtime
[INFO] | | +- org.springframework.data:spring-data-commons:jar:2.2.4.RELEASE:runtime
[INFO] | | +- org.springframework:spring-orm:jar:5.2.3.RELEASE:runtime
[INFO] | | \- org.springframework:spring-tx:jar:5.2.3.RELEASE:runtime

可以看到，hibernate-entitymanager是在spring-boot-starter-data-jpa中声明的，而hibernate-core是作为hibernate-entitymanager的传递依赖项。因此，我们需要将这两个组件排除。

1. 在项目的pom.xml中添加排除项：在项目的pom.xml文件中，添加以下代码以排除传递依赖项：

xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
<version>2.2.4.RELEASE</version>
<exclusions>
<exclusion>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-entitymanager</artifactId>
</exclusion>
</exclusions>
</dependency>

在这个例子中，我们在spring-boot-starter-data-jpa中排除了hibernate-core和hibernate-entitymanager组件。

4. 总结

exclusions机制是Maven用来解决依赖冲突问题的非常有用和方便的工具。通过在项目的pom.xml文件中添加标签，可以排除当前依赖项中的某些传递依赖项，保证项目的构建成功和正常运行。在使用exclusions的过程中，需要注意正确找出要排除的传递依赖项，并在pom.xml文件中正确设置排除项。