JeKa：创建 Uber 和 Shade Jars 的最简单方法-java教程-PHP中文网

首页

Java

java教程

JeKa：创建 Uber 和 Shade Jars 的最简单方法

Barbara Streisand

Jan 04, 2025 am 09:37 AM

JeKa: The Simplest Way to Create Uber and Shade Jars

JeKa 是一个注重简单性的现代 Java 构建工具。

这篇文章是“Jeka：最简单的方法......”系列的一部分，展示了如何毫不费力地创建一个胖罐子（无论是否有阴影）。

适用应用：简单脂肪罐

打包 Java 应用程序的常见方法是创建 FAT jar。 fat jar 捆绑了依赖项中的所有类，因此您只需要该 jar（以及 Java 运行时）即可运行应用程序。

您的应用程序可能需要依赖项，您可以在 dependency.txt 文件中列出这些依赖项，如下例所示：

== COMPILE ==
com.github.lalyos:jfiglet:0.0.9
com.google.guava:guava:33.4.0-jre
com.fasterxml.jackson.core:jackson-core:2.18.2


== TEST ==
org.junit.jupiter:junit-jupiter:5.8.1

登录后复制

要配置 fat jar 生成，请编辑 jeka.properties 文件：

jeka.version=0.11.11
jeka.java.version=17

@project.pack.detectMainClass=true
@project.pack.jarType=FAT

登录后复制

@project.pack.jarType 属性指定要生成的 JAR 的类型。它可以是常规的、胖的或阴影的。

@project.pack.detectMainClass=true 设置指示 Jeka 检测要包含在清单文件中的主类。

要生成 jar，请运行以下命令：

jeka project: pack

登录后复制

FAT jar 将在 jeka-output 目录中创建。要运行它，只需执行：java -jar [jar-name].jar.

对于图书馆：Shade Fat jar

对于图书馆来说，一个好的做法是保留一个常规的 Jar 并提供一个 Fat Jar 作为附加选项。

理想情况下，依赖类也应该重新定位到特定的包，以避免消费者的类路径冲突。我们将 shade jar 称为 fat jar，其中依赖项类已重新定位在特定包中。

要创建这样的 jar，请按如下方式配置 JeKa：

jeka.version=0.11.11
jeka.java.version=17

@project.moduleId=org.examples:my-lib
@project.version=1.0.0-SNAPSHOT
@project.pack.shadeJarClassifier=all

@maven.publication.extraArtifacts=all

登录后复制

现在，调用 jeka prpject: pack 还将创建一个*org.examples.my-lib-all.jar* 文件。
通过打开jat文件，我们可以看到所有的依赖类都已经自动重新定位了。

.
├── org                  
│   └── example             
│       └── mylib           <- Base package for my-lib classes
│           ├── MyLyb.class   
│           └── _shaded     <- Base package for dependency classes
│               ├── com.google...
│               ├── com.fasterxml.jackson...
│               └── com.github.lalyos.jfiglat...
└── META-INF             
    └── MANIFEST.MF

登录后复制

此外，@maven.publication.extraArtifacts=all 包含 jeka maven:publish 命令生成的 maven 出版物中的阴影 jar。

Maven 比较

如下所示，Maven 需要更多的输入才能实现类似的目标。

<?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>org.examples</groupId>
    <artifactId>my-lib</artifactId>
    <version>0.1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>com.github.lalyos</groupId>
            <artifactId>jfiglet</artifactId>
            <version>0.0.9</version>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>33.2.1-jre</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.17.2</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>2.3</version>
                <executions>
                    <!-- Run shade goal on package phase -->
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-shade-plugin</artifactId>
                    <version>2.1</version>
                    <executions>
                        <execution>
                            <phase>package</phase>
                            <goals>
                                <goal>shade</goal>
                            </goals>
                        </execution>
                    </executions>
                    <configuration>
                        <minimizeJar>true</minimizeJar>
                        <artifactSet>
                            <includes>
                                <include>com.google.guava:guava</include>
                                <include>com.github.lalyos:jfiglet</include>
                                <include>com.fasterxml.jackson.core:jackson-core</include>
                            </includes>
                        </artifactSet>
                        <relocations>
                            <relocation>
                                <pattern>com.google.common</pattern>
                                <shadedPattern>org.elasticsearch.common</shadedPattern>
                            </relocation>
                            <relocation>
                                <pattern>com.fasterxml.jackson</pattern>
                                <shadedPattern>org.elasticsearch.common.jackson</shadedPattern>
                            </relocation>
                        </relocations>
                        <filters>
                            <filter>
                                <artifact>*:*</artifact>
                                <excludes>
                                    <exclude>META-INF/license/**</exclude>
                                    <exclude>META-INF/*</exclude>
                                    <exclude>META-INF/maven/**</exclude>
                                    <exclude>LICENSE</exclude>
                                    <exclude>NOTICE</exclude>
                                    <exclude>/*.txt</exclude>
                                    <exclude>build.properties</exclude>
                                </excludes>
                            </filter>
                        </filters>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>

</project>

登录后复制