maven-plugin-shade 详解

 <!--
        maven-plugin-shade 插件提供了两个能力:
        把整个项目(包含它的依赖)都打包到一个 “uber-jar” 中
        shade - 即重命名某些依赖的包
        由此引出了两个问题:
        什么是 uber-jar ?
        uber-jar 也叫做 fat-jar 或者 jar-with-dependencies,意思就是包含依赖的 jar。
        什么是 shade ?
        shade 意为遮挡,在此处可以理解为对依赖的 jar 包的重定向(主要通过重命名的方式)。
        -->
<!--maven-plugin-shade 必须和 Maven 构建生命周期中的 package 阶段绑定,
也就是说,当执行 mvn package 时会自动触发 shade-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>2.4.3</version>
                <executions>
                    <execution>
                        <!-- 和 package 阶段绑定 -->
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <!--自动移除项目中没有使用到的依赖,以此来最小化 jar 包的体积-->
                            <minimizeJar>true</minimizeJar>

                            <!--  按需进行选择需要添加到jar包中国呢到依赖
                                   支持include 和 exclude
                                   配置格式: groupId:artifactId[[:type][:classifier]] 至少包含 groupId:artifactId type和类名可选
                                   支持* ? 执行通配符匹配-->
                            <artifactSet>
                                <excludes>
                                    <exclude>classworlds:classworlds</exclude>
                                    <exclude>junit:junit</exclude>
                                    <exclude>jmock:*</exclude>
                                    <exclude>*:xml-apis</exclude>
                                    <exclude>org.apache.maven:lib:tests</exclude>
                                    <exclude>log4j:log4j:jar:</exclude>
                                </excludes>
                            </artifactSet>
                            <!--      更加灵活的另外一种方式过滤文件                      -->
                            <filters>
                                <filter>
                                    <artifact>junit:junit</artifact>
                                    <includes>
                                        <include>junit/framework/**</include>
                                        <include>org/junit/**</include>
                                    </includes>
                                    <excludes>
                                        <exclude>org/junit/experimental/**</exclude>
                                        <exclude>org/junit/runners/**</exclude>
                                    </excludes>
                                </filter>
                                <filter>
                                    <artifact>*:*</artifact>
                                    <excludes>
                                        <exclude>META-INF/*.SF</exclude>
                                        <exclude>META-INF/*.DSA</exclude>
                                        <exclude>META-INF/*.RSA</exclude>
                                    </excludes>
                                </filter>
                            </filters>
                        <!--   重定位class
                               如果最终的 jar 包被其他的项目所依赖的话,直接地引用此 jar 包中的类可能会导致类加载冲突,
                               这是因为 classpath 中可能存在重复的 class 文件。
                               为了解决这个问题,我们可以使用 shade 提供的重定位功能,
                               把部分类移动到一个全新的包中 -->
                            <relocations>
                                <relocation>
                                    <!--原始包名-->
                                    <pattern>org.codehaus.plexus.util</pattern>
                                    <!-- 重命名后的包名-->
                                    <shadedPattern>org.shaded.plexus.util</shadedPattern>
                                    <!--原始包内不需要重定位的类,类名支持通配符-->
                                    <excludes>
                                        <exclude>org.codehaus.plexus.util.xml.Xpp3Dom</exclude>
                                        <exclude>org.codehaus.plexus.util.xml.pull.*</exclude>
                                    </excludes>
                                    <!--反向操作 仅需要的 -->
                                    <includes>
                                        <include>org.codehaud.plexus.util.io.*</include>
                                    </includes>
                                </relocation>
                            </relocations>
                            <!-- 生成可执行 jar 包 : 通过java -java 命令启动  -->
                            <transformers>
                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <mainClass>com.wfg.selenium.ApplicationMain</mainClass>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

生成资源文件 6

项目中涉及到的依赖可能会有它们所必需的资源文件,使用 shade 可以把它们聚合在同一个 jar 包中。

默认地,shade 为我们提供了 12 个 ResourceTransformer 类:

类名作用
ApacheLicenseResourceTransformer防止 LICENSE 文件重复
ApacheNoticeResourceTransformer准备合并的 NOTICE
AppendingTransformer为某个资源文件附加内容
ComponentsXmlResourceTransformer聚合 Plexus components.xml
DontIncludeResourceTransformer防止包含指定的资源
GroovyResourceTransformer合并 Apache Groovy 的扩展模块
IncludeResourceTransformer添加项目中的文件为资源文件
ManifestResourceTransformer自定义 MANIFEST 文件
PluginXmlResourceTransformer聚合 Maven 的 plugin.xml 配置
ResourceBundleAppendingTransformer合并 ResourceBundles
ServicesResourceTransformer重定位且合并 META-INF/services 资源文件中的 class 文件.
XmlAppendingTransformer为 XML 资源文件附加内容

如果上述 12 个类都不能够满足我们的需求,我们可以实现 shade 提供的接口,按需自定义一个 ResourceTransformer,实现方法详见官网 Using your own Shader implementation

  • 6
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值