无法取舍的包冲突 maven-shade-plugin 了解一下

废话

好久没写点什么，忙的要死，却依旧是个“三无好青年”。

问题

最近在接入一个公司自研中间件，类似于一个数据采集工具。数据采用kafka方式上报。接入前信誓旦旦，理直气壮，项目里刚好接入过kafka，所以一切都是那么流畅。当我一顿行云流水，bugfree，编码完成，启动运行，可怕的事情出现了，它不好用、也不报错。百般定位最终发现是kafka版本与client版本不匹配。WTF?同一个公司 kafka资源版本竟然不一致，很有必要资源统一管理的。回过神，发现凉了，client降下来 原有的kafka功能用不了，client升上去 中间件的功能不好用。Emmmm

解决

在我几经周折 近乎想放弃走弯路，重写他们提供的jar的时候，整理下思路：
现在的问题本质是包冲突，且无法通过排除包的方式解决冲突，直观的方案是同时存在两套同一package的包。或者换个思路 同时存在两个不同版本的jar 将其中有个jar的包重命名。几经搜索，救世主-- maven-shade-plugin 出现了。shade主要提供了两个功能：

• 打包
• 重命名jar包名
  我们主要使用了第二个功能。

试试

• 新建maven工程，仅配置pom文件即可

<?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">
    <parent>
      ...
    </parent>
    <modelVersion>4.0.0</modelVersion>
    
    <artifactId>...</artifactId>
    <name>...</name>
    <version>1.0.0${project.release.version}</version>
    
    <dependencies>
        <!--        冲突jar kafka-->
        <dependency>
            <groupId>org.apache.kafka</groupId>
            <artifactId>kafka-clients</artifactId>
            <version>0.8.2.2</version>
            <scope>compile</scope>
            <exclusions>
                <exclusion>
                    <artifactId>spring</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>netty</artifactId>
                    <groupId>org.jboss.netty</groupId>
                </exclusion>
            </exclusions>
        </dependency>
       <!-- 万恶第三方插件 -->
        <dependency>
            <groupId>...</groupId>
            <artifactId>...</artifactId>
            <version>1.0.2</version>
            <exclusions>
                <exclusion>
                    <groupId>org.apache.kafka</groupId>
                    <artifactId>kafka-clients</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.2.1</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <createDependencyReducedPom>false</createDependencyReducedPom>
                            <shadedArtifactAttached>false</shadedArtifactAttached>
                            <shadeSourcesContent>true</shadeSourcesContent>
                            <createSourcesJar>true</createSourcesJar>
                            <relocations>
                                <relocation>
                                    <pattern>org.apache.kafka</pattern>
                                    <shadedPattern>example.shade.kafka</shadedPattern>
                                </relocation>
                            </relocations>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

配置后 进行maven package、install、deploy
其中几个配置说一下

• createDependencyReducedPom
  是否需要移除 已经被打入jar的依赖，例如：项目 依赖fastjson，而fastjson已经被打入打包后的jar文件中了，createDependencyReducedPom 为true，fastjson将从导出后的pom中移除 ，这个配置项详细解释很多 自行百度
• shadedArtifactAttached
  是否将shade作为主要打包工具，这个我们只是个空maven项目，可忽略
• createSourcesJar
  是否提供source文件 source是比较重要的，方便联调、debug 这里设置为true，这里要注意，所有打入jar的依赖jar 都要有source哦，不然会打包失败
• shadeSourcesContent
  是否同步将source中的包进行重命名，这点比较重要，如果设置false，source中我们重命名的package会报错，虽然不影响功能。

配置好一切，deploy后，我们的应用工程就可以不依赖中间件提供的jar啦，直接依赖我们shade工程编译后的jar。调整依赖后，重新构建工程，运行、测试。噔噔！解决，一切如此丝滑，心里毫无波澜。

总结

作为第三方提供公共jar服务的时候，还是应该把这种jar冲突问题好好想想，尤其是这种无法取舍致命的冲突。让业务方解决，有点不妥。。。emm遇到问题不要慌。