maven插件maven-shade-plugin打包jar文件使用详解

最新推荐文章于 2024-06-06 07:45:00 发布

流年五十前

最新推荐文章于 2024-06-06 07:45:00 发布

阅读量3.6k

点赞数 24

分类专栏：玩转Maven 文章标签： maven jar java spring boot

本文链接：https://blog.csdn.net/txhlxy/article/details/136213647

版权

玩转Maven 专栏收录该内容

22 篇文章 1 订阅

订阅专栏

文章目录

前言
一、使用方式
二、配置详解
总结

前言

在使用maven打包Java里，除了maven-jar-plugin和maven-assembly-plugin可以打包jar文件外，使用maven-shade-plugin也可以将程序打包成jar文件。maven-shade-plugin插件的功能也很强大，能够进行高度定制化jar的打包规则。

一、使用方式

在pom.xml中加入下面配置：

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>3.5.2</version>
        <configuration>
          <!-- put your configurations here -->
        </configuration>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>shade</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>

插件的goal只有一个shade

二、配置详解

maven-shade-plugin插件的功能和我前面介绍的maven-assembly-plugin插件打包功能类似，但maven-shade-plugin不具备归纳文件ZIP/TAR的功能。
我们先准备一个普通的Java项目然后加入一些依赖，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.test.csdn</groupId>
    <artifactId>test-plugin-shade</artifactId>
    <version>1.0.0</version>
    <name>test-plugin-shade</name>
    <description>test-plugin-shade</description>
    <properties>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.21</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.1.7</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.1.7</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
        </dependency>
        <dependency>
            <groupId>commons-lang</groupId>
            <artifactId>commons-lang</artifactId>
            <version>2.6</version>
        </dependency>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.4</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit-dep</artifactId>
            <version>4.9</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.9</version>
        </dependency>

    </dependencies>

    <build>
        <finalName>test-shade</finalName>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.1.1</version>
                <executions>
                    <!-- Run shade goal on package phase -->
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <createDependencyReducedPom>false</createDependencyReducedPom>
                            <transformers>
                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <manifestEntries>
                                        <Main-Class>
                                            com.test.shade.Launcher
                                        </Main-Class>
                                    </manifestEntries>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

        </plugins>
    </build>
</project>

其中 com.test.shade.Launcher是我们的启动类，类容大致如下：

package com.test.shade;


import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang.time.DateFormatUtils;
import org.apache.commons.lang.time.DateUtils;

import java.util.Date;
import java.util.concurrent.CountDownLatch;

@Slf4j
public class Launcher {
    private static final CountDownLatch latch=new CountDownLatch(2);

    public static void main(String[] args) {
       log.info("start");
       log.info("time is :"+DateFormatUtils.format(DateUtils.addDays(new Date(),2),"yyyy-MM-dd HH:mm:ss"));
        try {
            latch.await();
        } catch (InterruptedException e) {
        }

    }
}

然后我们先直接运行maven打包命令：

mvn clean -DskipTests package

打包成功后，会生成一个jar文件，如果直接运行jar文件，就会和我们在IDE中启动运行的效果一样：

java -jar test-shade.jar

输出：

16:37:24.429 [main] INFO  - start
16:37:24.439 [main] INFO  - time is :2024-02-23 16:37:24

说明jar文件没问题，同时我们添加的依赖也包含在了jar包中。下面我们通过几个实例来介绍maven-shade-plugin如何定制化jar文件。

1、去掉不必要的依赖

有时我们项目所依赖的库可能只是用于帮助编译的功能，在运行阶段这些库是没必要的，或者在运行环境classpath已经包含了这些内库，那么我们在打包时就没必要将这些库一起打包，这样会增加我们的jar文件大小，我们可以去掉这些依赖，最典型的就是我们依赖的lombok和junit以及jmock，实际上在运行阶段是完全不需要lombok。我们加入下面配置：

<configuration>
    <artifactSet>
        <excludes>
            <exclude>org.projectlombok:lombok</exclude>
            <exclude>junit:*</exclude>
        </excludes>
    </artifactSet>
</configuration>

这样在打包后就不会包含lombok和junit相关的字节码文件和对于的资源
exclude是排除了依赖库所有的资源，如果我们想保留某个库中部分资源，那么可以使用filter来配置：

<configuration>
    <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>
    </filters>
</configuration>

上面的配置我们保留了junit中部分资源，而将另外的一些资源给排除了

2、解决jar文件启动抛出java.lang.SecurityException: Invalid signature file digest for Manifest错误

在使用maven-shade-plugin打包时，很多时候我们在运行jar文件时会抛出这个错误，原因是我们在打包是将所有的资源打包jar中，其他的依赖库中可能会包含.SF/.DSA/.RSA的签名文件，从而导致签名异常，在插件中追加下面配置可解决：

<configuration>
    <filters>
        <filter>
            <artifact>*:*</artifact>
            <excludes>
                <exclude>META-INF/*.SF</exclude>
                <exclude>META-INF/*.DSA</exclude>
                <exclude>META-INF/*.RSA</exclude>
            </excludes>
        </filter>
    </filters>
</configuration>

排除了所有依赖库中的.SF/.DSA/.RSA。

3、minimizeJar精简jar包

如果我们在插件中配置minimizeJar属性：

<configuration>
  <minimizeJar>true</minimizeJar>
</configuration>

这样打包出来的jar文件会很小，但是这会有很多奇葩的问题，如果安装上面的配置，我们直接打包，然后再运行，会发现程序会抛出异常：

Caused by: java.lang.ClassNotFoundException: ch.qos.logback.core.rolling.RollingFileAppender
        at      at java.base/jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:641)

我的理解是minimizeJar会在打包时去探索程序中使用到的字节码文件，如果没有显示的使用某个字节码，那么它就不会打包到jar文件中。比如上面的代码中完全没有使用commons-io库中相关的依赖，打包后，commons-io的字节码文件时不会打包进jar中的。这样带来的问题很明显，对于运行时才加载的的库就无法正常工作，就比如上面logback日志Appender是通过配置文件配置，然后在运行时进行初始化。当然针对这类情况，可以使用filter来配合使用也能解决问题，但总的来说太麻烦，对应大项目来说配置太复杂，不建议使用。

上面的异常我们添加一个filter如下配置即可解决：

 <configuration>
    <minimizeJar>true</minimizeJar>
    <createDependencyReducedPom>false</createDependencyReducedPom>
    <transformers>
        <transformer
                implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
            <manifestEntries>
                <Main-Class>
                    com.test.shade.Launcher
                </Main-Class>
            </manifestEntries>
        </transformer>
    </transformers>

    <artifactSet>
        <excludes>
            <exclude>org.projectlombok:lombok</exclude>
            <exclude>junit:*</exclude>
        </excludes>
    </artifactSet>

    <filters>
        <filter>
            <artifact>ch.qos.logback:*</artifact>
            <includes>
                <include>**</include>
            </includes>
        </filter>
        <filter>
            <artifact>*:*</artifact>
            <excludes>
                <exclude>META-INF/*.SF</exclude>
                <exclude>META-INF/*.DSA</exclude>
                <exclude>META-INF/*.RSA</exclude>
                <exclude>META-INF/NOTICE.txt</exclude>
                <exclude>META-INF/LICENSE.txt</exclude>
            </excludes>
        </filter>
    </filters>

</configuration>

4、shadedArtifactAttached只打包项目代码

如果我们不想把相关的依赖一起打包到jar中，使用shadedArtifactAttached就可以，这样效果就和maven-jar-plugin一样，具体配置如下：

<configuration>
  <shadedArtifactAttached>true</shadedArtifactAttached>
</configuration>

5、定制MANIFEST.MF文件

使用maven-shade-plugin插件也可以定制MANIFEST.MF文件，比如我们上面的示例项目，具体的配置如下：

<transformers>
    <transformer
            implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
        <manifestEntries>
            <Main-Class>
                com.test.shade.Launcher
            </Main-Class>
        </manifestEntries>
    </transformer>
</transformers>

在manifestEntries中可以加入我们自定义的属性

6、定制各种资源

maven-shade-plugin提供了各种资源绑定，通过transformer标签来使用。

Transformer	说明
ApacheLicenseResourceTransformer	防止license重复
ApacheNoticeResourceTransformer	合并NOTICE文件
AppendingTransformer	添加额外资源
DontIncludeResourceTransformer	防止resources重复
ManifestResourceTransformer	MANIFEST.MF构建

上面几个是常用的transformer，比如我们加入下面配置：

<transformers>
    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
        <manifestEntries>
            <Main-Class>
                com.test.shade.Launcher
            </Main-Class>
        </manifestEntries>
    </transformer>
    <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer"></transformer>
    <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer">
        <addHeader>false</addHeader>
    </transformer>
</transformers>

这样就不会生成license文件，同时NOTICE文件也会被合并

总结

在前面的插件介绍中，关于打包jar的插件我们已经介绍了2个，maven-jar-plugin和maven-assembly-plugin，包含今天介绍的，总共有3种方式来打包jar。这3个插件各自都有各自的特点和功能。可以根据实际的情况来进行使用。

这3个插件中，如果是springboot项目的话，目前测试是无法和maven-shade-plugin插件配合使用的，貌似和springboot的插件spring-boot-maven-plugin有冲突，如果要对springboot项目的jar文件进行瘦身处理可以配合maven-jar-plugin来完成。可以参照【使用maven对springboot项目进行瘦身分离jar的多种处理方案】

目前测试如果使用maven-assembly-plugin来对springboot进行瘦身处理的话，还是有问题，所以在springboot项目中maven-assembly-plugin基本上用来制作规则文件,大家可以参照【maven插件maven-assembly-plugin打包归纳文件zip/tar使用详解】

流年五十前

关注

24
点赞
踩
37

收藏

觉得还不错? 一键收藏
打赏
0
评论
maven插件maven-shade-plugin打包jar文件使用详解

在使用maven打包Java里，除了maven-jar-plugin和maven-assembly-plugin可以打包jar文件外，使用maven-shade-plugin也可以将程序打包成jar文件。maven-shade-plugin插件的功能也很强大，能够进行高度定制化jar的打包规则。在前面的插件介绍中，关于打包jar的插件我们已经介绍了2个，maven-jar-plugin和maven-assembly-plugin，包含今天介绍的，总共有3种方式来打包jar。
复制链接

扫一扫