使用 maven 构建一个胖罐子

Question

我有一个要作为 jar 分发的代码库。它还依赖于外部 jar，我想将其捆绑在最终的 jar 中。

我听说这可以使用maven-assembly-plug-in 来完成，但我不明白怎么做。有人可以指点我一些例子。

现在，我正在使用 fat jar 来捆绑最终的 jar。我想用 maven 实现同样的目标。

Answer 1

注意：如果你是spring-boot应用，请阅读答案末尾

将以下插件添加到您的pom.xml 最新版本可以found at

...
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>CHOOSE LATEST VERSION HERE</version>
            <configuration>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
            </configuration>
            <executions>
                <execution>
                    <id>assemble-all</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
...

配置此插件后，运行 mvn package 将生成两个 jar：一个仅包含项目类，第二个包含所有依赖项的 fat jar，后缀为“-jar-with-dependencies”。

如果您想在运行时正确设置classpath，那么还要添加以下插件

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <configuration>
        <archive>
            <manifest>
                <addClasspath>true</addClasspath>
                <mainClass>fully.qualified.MainClass</mainClass>
            </manifest>
        </archive>
    </configuration>
</plugin>

---

对于 Spring Boot 应用程序只使用以下插件（选择合适的版本）

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
        <fork>true</fork>
        <mainClass>${start-class}</mainClass>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>repackage</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Answer 2

您可以使用maven-shade-plugin。

在您的构建中配置阴影插件后，命令mvn package 将创建一个包含所有依赖项合并到其中的单个 jar。

Answer 3

也许你想要maven-shade-plugin，捆绑依赖，最小化未使用的代码并隐藏外部依赖以避免冲突。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>3.1.1</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                    <configuration>
                        <minimizeJar>true</minimizeJar>
                        <createDependencyReducedPom>true</createDependencyReducedPom>
                        <dependencyReducedPomLocation>
                            ${java.io.tmpdir}/dependency-reduced-pom.xml
                        </dependencyReducedPomLocation>
                        <relocations>
                            <relocation>
                                <pattern>com.acme.coyote</pattern>
                                <shadedPattern>hidden.coyote</shadedPattern>
                            </relocation>
                        </relocations>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

参考资料：

• http://maven.apache.org/plugins/maven-shade-plugin/plugin-info.html
• http://maven.apache.org/plugins/maven-shade-plugin/shade-mojo.html

Answer 4

实际上，添加

<archive>
   <manifest>
    <addClasspath>true</addClasspath>
    <packageName>com.some.pkg</packageName>                     
    <mainClass>com.MainClass</mainClass>
  </manifest>
</archive>

对 maven-jar-plugin 的声明不会为我将主类条目添加到清单文件中。 我必须将它添加到 maven-assembly-plugin 才能在清单中得到它

Answer 5

您可以使用onejar-maven-plugin 进行打包。基本上，它将您的项目及其依赖项组装为一个 jar，不仅包括您的项目 jar 文件，还包括所有外部依赖项作为“jar 的 jar”，例如

<build>
    <plugins>
        <plugin>
            <groupId>com.jolira</groupId>
            <artifactId>onejar-maven-plugin</artifactId>
                <version>1.4.4</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>one-jar</goal>
                        </goals>
                    </execution>
                </executions>
        </plugin>
    </plugins>
</build>

注意 1：配置选项在项目 home page 中可用。

注意 2：出于某种原因，onejar-maven-plugin 项目未在 Maven 中心发布。但是jolira.com 跟踪原始项目并将其发布到 groupId com.jolira。

Answer 6

另一种方法是使用 maven shade 插件来构建 uber-jar。

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