Maven打包之maven-shade-plugin---zhangheng

打包是一个比较头疼的事情，默认maven打包的结果只包含项目本身的代码，如果要执行代码，还得带上依赖。maven-shade-plugin插件就能够帮我们把项目依赖的包也打进最终文件。

shade打包过程

shade插件绑定在maven的package阶段，他会将项目依赖的jar包解压并融合到项目自身编译文件中。

举个例子：例如我们的项目结构是

com.gavinzh.learn.shade Main

假设我们依赖了一个jar包，他的项目结构是:

com.fake.test A B

那么shade会将这两个结构融合为一个结构:

com gavinzh.learn.shade Main fake.test A B

并将上述文件打成一个jar包。

如果shade只有这一个功能，那它并不能够满足开发者的需求。因此，它提供了ResourceTransformer的接口，处理扫描到的资源文件，修改最终的输出结果，这个功能正是大家所需要的。

shade配置

shade配置较多，结构也比较复杂，因此，我在这里写了一个比较全的demo，在demo中做注释。

<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-shade-plugin</artifactId> <version>3.1.1</version> <configuration> <!-- put your configurations here --> <!--只包含该项目代码中用到的jar,在父项目中引入了，但在当前模块中没有用到就会被删掉--> <minimizeJar>true</minimizeJar> <!--重新定位类位置，就好像类是自己写的一样，修改别人jar包的package--> <relocations> <relocation> <pattern>com.alibaba.fastjson</pattern> <shadedPattern>com.gavinzh.learn.fastjson</shadedPattern> <excludes> <!--这些类和包不会被改变--> <exclude>com.alibaba.fastjson.not.Exists</exclude> <exclude>com.alibaba.fastjson.not.exists.*</exclude> </excludes> </relocation> </relocations> </configuration> <executions> <execution> <configuration> <!--创建一个你自己的标识符，位置在原有名称之后--> <shadedArtifactAttached>true</shadedArtifactAttached> <shadedClassifierName>gavinzh</shadedClassifierName> <!--在打包过程中对文件做一些处理工作--> <transformers> <!--在META-INF/MANIFEST.MF文件中添加key: value 可以设置Main方法--> <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"> <manifestEntries> <mainClass>com.gavinzh.learn.shade.Main</mainClass> <Build-Number>123</Build-Number> <Built-By>your name</Built-By> <X-Compile-Source-JDK>1.7</X-Compile-Source-JDK> <X-Compile-Target-JDK>1.7</X-Compile-Target-JDK> </manifestEntries> </transformer> <!--阻止META-INF/LICENSE和META-INF/LICENSE.txt--> <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer"/> <!--合并所有notice文件--> <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer"> <addHeader>true</addHeader> </transformer> <!--如果多个jar包在META-INF文件夹下含有相同的文件，那么需要将他们合并到一个文件里--> <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"> <resource>META-INF/spring.handlers</resource> </transformer> <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"> <resource>META-INF/spring.schemas</resource> </transformer> <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"> <resource>META-INF/spring.factories</resource> </transformer> <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"> <resource>META-INF/spring.tld</resource> </transformer> <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"> <resource>META-INF/spring-form.tld</resource> </transformer> <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"> <resource>META-INF/spring.tooling</resource> </transformer> <!--如果多个jar包在META-INF文件夹下含有相同的xml文件，则需要聚合他们--> <transformer implementation="org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer"/> <!--排除掉指定资源文件--> <transformer implementation="org.apache.maven.plugins.shade.resource.DontIncludeResourceTransformer"> <resource>.no_need</resource> </transformer> <!--将项目下的文件file额外加到resource中--> <transformer implementation="org.apache.maven.plugins.shade.resource.IncludeResourceTransformer"> <resource>META-INF/pom_test</resource> <file>pom.xml</file> </transformer> <!--整合spi服务中META-INF/services/文件夹的相关配置--> <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/> </transformers> </configuration> <phase>package</phase> <goals> <goal>shade</goal> </goals> </execution> </executions> </plugin> </plugins> </build>

上边的配置基本上可以满足我们的需求，但需要注意的是像spring包比较分散，但每个包中的META-INF中有很相同名称的文件，需要通过特定的ResourceTransformer将他们融合到一个文件中。如果项目要求不能融合或者融合会出错，那么建议使用assembly插件打包。

参考

Apache Maven Shade Plugin

maven-shade-plugin 简书

---来自腾讯云社区的---zhangheng