使用maven-shade-plugin插件解决Phoenix依赖中的Guava版本冲突问题

一、问题描述

在自定义查询项目中本来存在Guava 20.0版本的引用，为了使自定义查询支持Phoenix，在自定义查询的pom.xml文件中引入了如下依赖：

<dependency>
	<groupId>org.apache.phoenix</groupId>
	<artifactId>phoenix-core</artifactId>
	<version>4.11.0-HBase-1.3</version>
</dependency>

但是引入的Phoenix jar包需要依赖Guava 13.0版本中的common包下相应的代码。

如果我们在自定义查询的pom.xml文件中显示的指定Guava的版本为20.0则会导致hoenix的Java API报版本太高的错误，如果显示的指定为Guava 13.0版本则由于版本太低而导致自定义查询工程中会出现很多方法的引用错误。

二、解决思路

使自定义查询项目依然依赖Guava 20.0版本，而我们引入的Phoenix包依然可以使用自己所依赖的Guava 13.0 版本。

三、解决方案

1.首先是参考es官网blog：https://www.elastic.co/blog/to-shade-or-not-to-shade ,新建一个maven项目。比如我使用Maven新建了一个名为phoenix-shaded的工程，如下所示：

随后在pom.xml文件中添加如下配置：

<?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>com.nubia.bigdata.phoenix</groupId>
    <artifactId>phoenix-core-guava-shaded</artifactId>
    <version>1.0</version>

    <dependencies>
    <!--引入phoenix依赖-->
        <dependency>
            <groupId>org.apache.phoenix</groupId>
            <artifactId>phoenix-core</artifactId>
            <version>4.10.0-HBase-1.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>2.4.1</version>
                <configuration>
                    <createDependencyReducedPom>false</createDependencyReducedPom>
                </configuration>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <relocations>
                                <relocation>
                                    <pattern>com.google.common</pattern>
                                    <shadedPattern>com.nubia.phoenix.common</shadedPattern>
                                </relocation>
                            </relocations>
                            <transformers>
                                <transformer
                                        implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"/>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            
            <!-- deploy插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-deploy-plugin</artifactId>
                <version>2.7</version>
                <configuration>
                    <updateReleaseInfo>true</updateReleaseInfo>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <distributionManagement>
    <!-- 公司私有maven库-->
        <repository>
            <id>nexus-release</id>
            <url>http://ip：port/nexus/content/repositories/releases/</url>
        </repository>
    </distributionManagement>
</project>

如上配置完成后，其实就是将Guava中的存在冲突的common的jar包通过maven-shade-plugin插件迁移后重新打个jar包从而使得在引入这个jar包时能够使用该jar包自己的依赖而不是使用外部依赖。

2.随后使用如下命令将当前工程打包成一个jar包放入maven仓库中。

clean compile install -f pom.xml

3.随后在原来的自定义查询项目的pom.xml中引入如下依赖，就可以解决Guava版本冲突的问题：

<dependency>
    <groupId>com.nubia.bigdata.phoenix</groupId>
    <artifactId>phoenix-core-guava-shaded</artifactId>
    <version>1.0</version>
    <exclusions>
        <exclusion>
            <groupId>org.apache.phoenix</groupId>
            <artifactId>phoenix-core</artifactId>
        </exclusion>
    </exclusions>
</dependency>

注意这里必须需要使用exclusions排除对phoenix包的依赖，否则在打包自定义查询项目时会重新引入存在冲突的依赖。

4.解决冲突的原理
实际上在打包的时候对于生成的phoenix-core-guava-shaded-1.0.jar文件，我们将guava依赖下的com.google.common的代码给移植到了com.nubia.phoenix.common下，如下图所示：