java 中使用maven shade plugin 打可执行Jar包

Java是一门非常流行的编程语言，Maven是一个优秀的Java项目管理工具，能够极大地简化Java项目的构建和管理。在Java项目中，我们有时需要将所有依赖打包成一个可执行的jar包，这时候我们可以使用Maven Shade Plugin来实现。下面，我将详细介绍如何使用Maven Shade Plugin打可执行Jar包的完整攻略。

步骤1：创建Maven项目

首先，我们需要创建一个Maven项目。你可以使用Maven的archetype生成项目模板，并根据需要进行修改。如果已经有了自己的项目，则可以跳过此步骤。

步骤2：添加Maven Shade Plugin插件

在pom.xml文件中添加如下配置：

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

该配置告诉Maven在构建项目时执行一个名为shade的目标，将所有依赖打包成一个可执行的jar包。

步骤3：配置Maven Shade Plugin插件

Maven Shade Plugin提供了丰富的配置选项，可以根据需要进行定制。下面是一个示例配置，可以将jar包打包成可执行文件，包含所有依赖。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>3.2.4</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <finalName>myApp</finalName>
                <transformers>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/spring.handlers</resource>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                        <mainClass>com.example.MainClass</mainClass>
                    </transformer>                   
                </transformers>
                <filters>
                    <filter>
                        <artifact>*:*</artifact>
                        <excludes>
                            <exclude>META-INF/*.SF</exclude>
                            <exclude>META-INF/*.DSA</exclude>
                            <exclude>META-INF/*.RSA</exclude>
                        </excludes>
                    </filter>
                </filters>
            </configuration>
        </plugin>
    </plugins>
</build>

在该配置中，我们通过transformers配置项，配置了两个转换器：

AppendingTransformer: 将META-INF/spring.handlers文件合并到可执行Jar包中。
ManifestResourceTransformer: 设置主类，使得可执行Jar包可以直接运行。

我们还通过filters配置项，排除了一些不必要的文件，如签名文件。

步骤4：构建可执行Jar包

以上配置完成后，就可以使用Maven构建可执行Jar包了。在命令行中输入如下命令：

mvn clean package

该命令将会清除之前的构建结果，并重新构建整个项目。构建完成后，在target目录下会生成一个可执行Jar包，如myApp.jar。

示例1：将依赖打入可执行Jar包

前面的配置中，我们使用了Maven Shade Plugin自带的AppendingTransformer来打包META-INF/spring.handlers文件。类似地，我们可以使用Maven Shade Plugin提供的其他转换器来修改依赖的打包方式。例如，我们可以将所有依赖打入一个可执行Jar包中。在pom.xml文件中添加如下配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>3.2.4</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <createDependencyReducedPom>false</createDependencyReducedPom>
                <artifactSet>
                    <excludes combine.children="append">
                        <exclude>org.apache.maven:lib:tests</exclude>
                        <exclude>org.apache.maven:lib:provided</exclude>
                    </excludes>
                </artifactSet>
                <filters>
                    <filter>
                        <artifact>*:*</artifact>
                        <excludes>
                            <exclude>META-INF/*.SF</exclude>
                            <exclude>META-INF/*.DSA</exclude>
                            <exclude>META-INF/*.RSA</exclude>
                        </excludes>
                    </filter>
                </filters>
                <transformers>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                        <mainClass>com.example.MainClass</mainClass>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/spring.handlers</resource>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ReproducibleTransformer"/>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.XmlAppendingTransformer">
                        <resource>log4j.xml</resource>
                    </transformer>
                </transformers>
            </configuration>
        </plugin>
  </plugins>
</build>

由于可执行Jar包中必须包含所有依赖，因此我们需要将所有的依赖打包到一个可执行Jar包中。这里我们使用Maven Shade Plugin提供的artifactSet配置项来实现。

示例2：构建基于Spring Boot的可执行Jar包

Spring Boot是一种基于Spring框架的快速应用程序开发框架，它的特点是简单易用。在Spring Boot中，我们可以使用spring-boot-maven-plugin插件来构建可执行Jar包。这里给出一个基于Spring Boot的可执行Jar包构建示例。在pom.xml文件中添加如下配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

该插件可以生成一个可执行Jar包，其中包含了Spring Boot应用的所有内容。我们可以通过设置它的mainClass属性来指定可执行Jar包的主类，例如：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <mainClass>com.example.MainClass</mainClass>
            </configuration>            
        </plugin>
    </plugins>
</build>

通过以上配置，我们可以得到一个基于Spring Boot的可执行Jar包。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：java 中使用maven shade plugin 打可执行Jar包 - Python技术站