java jar包冲突解决方案

引言

在使用java语言开发，maven做项目管理时，我们经常遇到一个头疼的问题就是jar包冲突。比如项目中不同的两个依赖A和B，都同时依赖了一个项目C，但是依赖的版本不同，这时候我们就要考虑这两个版本之间是否有冲突，不解决这些冲突，我们的项目虽然能编译成功，但执行的时候总是会报各种异常。
这种冲突有两种，比如A依赖C1.0，B依赖C2.0，如果依赖能够向下兼容，即A依赖变成C2.0也能执行，那这种情况很容易解决，我们只需要使用exclusion来排除一个版本即可，比如pom中maven配置如下：

    <dependencies>
        <dependency>
            <groupId>group.A</groupId>
            <artifactId>artifact.A</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>group.C</groupId>
                    <artifactId>artifact.C</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>group.B</groupId>
            <artifactId>artifact.B</artifactId>
        </dependency>
    </dependencies>

这里就是排除A依赖的C，只保留B依赖的C的版本。

典型案例

但是使用过程中，我们常常发现这种方式不是完全有效，有些jar包是不能向下兼容的，实际应用中几个典型的例子如：
1.protobuf jar包冲突
当我们使用protobuf做序列化工具时，protobuf的2.4版本和2.5版本就不能够兼容，如果生成使用2.4，但实际项目依赖了2.5，就会出现执行异常：

Exception in thread "main" java.lang.UnsupportedOperationException: This is supposed to be overridden by subclasses.
    at com.google.protobuf.GeneratedMessage.getUnknownFields(GeneratedMessage.java:180)
    at com.test.utill.TextFormat$Printer.print(TextFormat.java:251)
    at com.test.utill.MessageLiteToStringUtil.toString(MessageLiteToStringUtil.java:20)
    at com.test.protocol.ProtocolTest.main(ProtocolTest.java:23)

2.elasticsearch和hbase依赖的guava包冲突
ES2.2.0 & Hbase1.1.2对 Guava的依赖，ES依赖于Guava 18.0,Hbase 依赖于Guava12.0 对于需要ES&Hbase 整合的项目中两者不兼容，会让我们执行时候出现问题。

解决方案

解决方案就是使用Apache maven shade插件，具体使用方法可以参考我的Apache maven shade plugin使用说明。
我们以protobuf jar冲突解决方案来说明如何避免这些问题：
假设功能（或者模块）A依赖protobuf 2.4.1，B依赖protobuf 2.5.1，在同一个项目中需要使用A和B，那如何使用shade来解决问题呢？
首先，我们需要将A独立处理，并用shade工具封装成独立的jar包，然后在项目中引用封装的jar包，以及B和protobuf 2.5.1包。
1.A和protobuf 2.4.1的shade处理：
只贴出maven配置：

<project >
  ……
    <groupId>group.A</groupId>
    <artifactId>shade.artifact.A</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>2.4.1</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.0.0</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <relocations>
                                <relocation>
                                    <pattern>com.google.protobuf</pattern>
                                    <shadedPattern>shaded.protobuf</shadedPattern>
                                </relocation>
                            </relocations>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
……
</project>

为了区分，我们将shade封装后的artifact定义为shade.artifact.A。
2.整个项目的依赖

<dependencies>
        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>2.5.1</version>
        </dependency>
            <groupId>group.A</groupId>
            <artifactId>shade.artifact.A</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

我们注意到，项目依赖了protobuf的2.5.1，以及1中shade封装的版本，这样，就能解决我们的问题。