Maven构建可执行“胖Jar“实践指南

Maven构建可执行"胖Jar"实践指南

在Java开发中，经常需要将应用程序及其所有依赖项打包成一个单独的可执行Jar文件，这种Jar被称为"胖Jar"（Fat Jar）。Apache Maven的Assembly插件能够方便地实现这一需求。本文将通过一个简单的实例，详细说明如何使用Maven Assembly插件来创建一个包含所有依赖项的可执行Jar。

创建简单项目

首先，使用Maven的maven-archetype-quickstart创建一个新项目，参数如下：

• groupId: com.logicbig.example
• artifactId: maven-assembly-plugin-example
• version: 1.0-SNAPSHOT

项目创建后，导入到你的IDE中。

添加第三方Jar依赖

以Guava库为例，展示如何在项目中添加依赖。在pom.xml文件中的<dependencies>部分添加如下依赖配置：

<dependency>
  <groupId>com.google.guava</groupId>
  <artifactId>guava</artifactId>
  <version>21.0</version>
</dependency>

在pom.xml中添加Maven Assembly插件配置

接着，在pom.xml的<build>部分中添加Maven Assembly插件的配置：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-assembly-plugin</artifactId>
      <version>3.0.0</version>
      <configuration>
        <descriptorRefs>
          <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
        <archive>
          <manifest>
            <mainClass>com.logicbig.example.Main</mainClass>
          </manifest>
        </archive>
      </configuration>
      <executions>
        <execution>
          <phase>package</phase>
          <goals>
            <goal>single</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

创建主类Main

创建一个主类Main，使用Guava库中的LinkedListMultimap：

package com.logicbig.example;
import com.google.common.collect.LinkedListMultimap;
import com.google.common.collect.Multimap;

public class Main {
    public static void main(String[] args) {
        Multimap<Integer, String> map = LinkedListMultimap.create();
        map.put(1, "apple");
        map.put(1, "banana");
        map.put(1, "orange");
        System.out.println(map);
    }
}

打包Jar

在命令行中运行mvn package，这将触发assembly:single目标，因为我们已经在pom.xml中的<execution>部分将其与package阶段关联起来。你也可以直接运行mvn assembly:single。

运行生成的可执行Jar

在Windows命令提示符下，执行以下步骤：

D:\examples\maven-assembly-plugin-example>mvn -q clean
D:\examples\maven-assembly-plugin-example>mvn -q package
D:\examples\maven-assembly-plugin-example>java -jar target\maven-assembly-plugin-example-1.0-SNAPSHOT-jar-with-dependencies.jar

输出结果将是：

{1=[apple, banana, orange]}

查看"胖Jar"内部结构

可以创建一个临时文件夹，并将"胖Jar"解压到该文件夹中，以查看其内部结构：

D:\examples\maven-assembly-plugin-example>md temp
D:\examples\maven-assembly-plugin-example>cd temp
D:\examples\maven-assembly-plugin-example\temp>jar -xf ..\target\maven-assembly-plugin-example-1.0-SNAPSHOT-jar-with-dependencies.jar
D:\examples\maven-assembly-plugin-example\temp>tree /A /F

这将展示一个扁平的目录结构，其中包括合并后的Java包和类。

项目依赖和技术

• guava 21.0: Guava是一个包含实用类、Google的集合、I/O类等核心和扩展库的套件。Guava只有一个代码依赖——javax.annotation，符合JSR-305规范。
• JDK 1.8
• Maven 3.3.9

通过上述步骤，你可以轻松地使用Maven Assembly插件创建一个包含所有依赖项的可执行Jar，简化了项目的部署和分发过程。