Apache Maven Shade插件详解

偏执的太偏执、 2022-06-07 14:12 714阅读 0赞

Apache Maven项目提供的Shade插件，能够将Maven应用打包为超级的uber-jar（也称为fat jar，或shaded jar）。即在打包的过程中，可以：

*  包含依赖库
 *  重命名依赖库的包名（以避免类库的冲突）
 *  有选择地打包

Shade插件的最新版本是2017.8.19发布的3.1.0。  
1. goals

*  shade，默认加入到Maven的package阶段

2. 插件的基本用法  
1) 编辑项目的pom.xml，配置插件

<plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>3.1.0</version>
            <configuration>
              
            </configuration>
            <executions>
              <execution>
                <phase>package</phase>
                <goals>
                  <goal>shade</goal>
                </goals>
              </execution>
            </executions>
          </plugin>

2) 执行mvn package

3. 只把Maven应用需要的依赖库打包

4. 改变默认包名（以避免冲突）

<configuration>
      <relocations>
        <relocation>
          <pattern>com.ericsson.old.util</pattern>
          <shadedPattern>com.ericsson.new.util</shadedPattern>
        </relocation>
      </relocations>
    </configuration>

5. 可执行的jar包

<configuration>
                  <transformers>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                      <mainClass>com.ericsson.bbauto.Entrance</mainClass>
                    </transformer>
                  </transformers>
                </configuration>

或

<configuration>
                  <transformers>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                      <manifestEntries>
                        <Main-Class>com.ericsson.bbauto.Entrance</Main-Class>
                        <Build-Number>1.23</Build-Number>
                      </manifestEntries>
                    </transformer>
                  </transformers>
                </configuration>

说明：这里使用了资源转换器ManifestResourceTransformer。

Shade插件提供了如下多种资源转换器，详见[Resource Transformers][]。

![Center][]

参考链接：

http://maven.apache.org/plugins/maven-shade-plugin/

[Resource Transformers]: http://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html
[Center]: /images/20220607/4aba7f63cab04973b112bcee1908a49e.png