巧用maven-shade-plugin解决依赖冲突

针对maven的依赖冲突通常有两种方式:

  • 当冲突两者其中一方兼容另外一方时,通过exclusions和exclusion标签解决。
  • 当冲突两者互不兼容时,使用maven-shade-plugin管理插件解决。

exclusions标签

  exclusions标签可以将对应依赖的依赖进行剔除,这里注意的是不能针对scope为system的属性或者是通过systemPath引入的jar包依赖,它们不受maven管理。

<dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
            <exclusions>
                <exclusion>
                    <groupId>commons-logging</groupId>
                    <artifactId>commons-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

maven-shade-plugin插件

  maven-shade-plugin插件可以解决冲突双方的包互相不兼容情况,其原理是修改其中任意一方的依赖路径,来解决。比如package A依赖package org.apache.common_v1,package C依赖package org.apache.common_v2,此时可以将package B_v1重新打包成package shade.org.apache.common_V1,而后修改package A的所有包引入代码,import org.apache.common修改成import shade.org.apache.common

关键词说明

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>2.4.3</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <createDependencyReducedPom>true</createDependencyReducedPom>
                            <relocations>
                                <!-- 多个包需要替换使用多个relocation-->
                                <relocation>
                                    <!-- pattern 为需要匹配的前缀-->
                                    <pattern>org.slf4j</pattern>
                                    <!-- shadedPattern 为替换成什么前缀-->
                                    <shadedPattern>shaded.org.slf4j</shadedPattern>
                                </relocation>
                            </relocations>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

举例说明

整个举例说明是要解决工程中与jar包中出现的log依赖冲突。
a. 这是是我项目中的依赖(Package A),我在工程中引入的log4j的依赖

package A截图

b. 这是我项目中的jar依赖(Package B),我在工程中引入的无关package。
package B截图

c. 此时我发现,原先的log4j的地方报错了,点击查看引用处,是这个jar包里的log4j。
工程报错处截图

引用处截图

d. 将工程中log4j的依赖单独出来,到新工程,重新进行打包。

<?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>

    <groupId>ceshi</groupId>
    <artifactId>ceshi</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <encoding>UTF-8</encoding>
        <slf4j.version>1.7.7</slf4j.version>

    </properties>
    <repositories>
        <repository>
            <id>apache release</id>
            <url>https://repository.apache.org/content/repositories/releases/</url>
        </repository>
    </repositories>

    <build>
        <plugins>
            <!-- 指定项目java编译版本 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>2.4.3</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <createDependencyReducedPom>true</createDependencyReducedPom>
                            <relocations>
                                <relocation>
                                    <pattern>org.slf4j</pattern>
                                    <shadedPattern>shaded.org.slf4j</shadedPattern>
                                </relocation>
                            </relocations>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

        </plugins>
    </build>


    <dependencies>

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <!-- common-logging 实际调用slf4j -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <!-- java.util.logging 实际调用slf4j -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jul-to-slf4j</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
    </dependencies>
</project>

命令行执行如下操作:

C:\Users\Lczy-Huang\Desktop\ceshi>mvn package

此时你会发现打包路径会有两个包,一个是原始未加入shade的包,一个是shade的包,我们需要使用的是shade的包;通过第二张截图可以看到log4j的包路径发生了改变。


打包路径

jar包信息

e.将shade包引入工程中,删除原先的依赖,将所有的import org.slf4j替换成import shade.org.slf4。


引入shade jar包

注释掉之前依赖

修改import

f. 此时工程就可以正常启动了。


项目启动啦
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容