使用 Maven 2 构建可运行的 jar

Posted 2023-02-27

【中文标题】使用 Maven 2 构建可运行的 jar

【英文标题】：Building a runnable jar with Maven 2

【发布时间】：2011-01-02 13:59:31

【问题描述】：

我对 Maven 口头禅相对较新，但我正在尝试使用 Maven 构建一个命令行可运行的 jar。我已经设置了我的依赖项，但是当我运行 mvn install 并尝试运行 jar 时，会发生两件事。首先，没有找到主类，这是可以纠正的。更正此问题后，我在运行时收到错误消息，指出找不到类。

Maven 没有将我的依赖库打包到 jar 中，因此我无法将 jar 作为独立应用程序运行。我该如何纠正这个问题？

【问题讨论】：

您可以将 IDE 用于像 Netbenas 这样的 maven

@SjB：这神奇地解决了问题？我不这么认为。

完全复制什么，究竟是什么？

可能是这个***.com/questions/1832853/…，或者这个***.com/questions/574594/…（但接受的答案是错误的），或者这个***.com/questions/1814526/…。实际上，这似乎是 maven 上最常见的问题之一......

其他答案不那么干净，而且 uber jar（ueber 拼写错误）没有提到可执行性。此外，其他主题充斥着不相关的材料，例如源级别等。

【参考方案1】：

只需在 pom.xml 中添加以下代码并运行为：maven:install。 jar 将在 eclipse 的目标文件夹中创建，可以用作 "java -jar Hello.jar" 。但请确保主类的名称为 com.abc.HelloWorld.java

<build>
<plugins>
<plugin>
<groupid>org.apache.maven.plugins</groupid>
<artifactid>maven-shade-plugin</artifactid>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<finalname>HelloW</finalname>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<manifestentries>
<main-class>com.abc.HelloWorld.java</main-class>
<build-number>1</build-number>
</manifestentries>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>

</build>

【参考方案2】：

这就是我会为小型项目做的事情。大多数时候你不想要一个大罐子。

构建： mvn clean dependency:copy-dependencies包

执行（在目标目录）： java -cp myjar.jar:./dependency/* com.something.MyClass

【讨论】：

太棒了！我将它保存在我的 Makefile 中，与 pom.xml 位于同一目录中。 build:\n mvn ....（你说的）

谢谢。在网上搜索了两个多小时后发现这个非常有用的答案......

【参考方案3】：

Maven 不会将您的依赖项打包到您的 jar 文件中，因为您通常不会对 Java 程序执行此操作。

相反，您将依赖项与您的 jar 文件一起提供并在 the Class-Path header of the Manifest 中提及它们。

要走这条路，您需要为maven-jar-plugin 启用addClasspath 属性（记录在here）。

如果你真的想在你的 jar 文件中包含所有依赖项，那么你可以使用 Maven Assembly 插件来创建一个jar-with-dependencies。

【讨论】：

+1 我很难找到有关如何通常打算构建和分发 java 程序的信息，尤其是使用 Maven。

【参考方案4】：

我同意 Joachim Sauer，

您应该像在 pom.xml 中那样配置 jar 插件，而不是使用 jar-with-dependency：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>2.4</version>
    <configuration>
        <archive>
            <index>true</index>
            <manifest>
                <addClasspath>true</addClasspath>
                <mainClass>[mainClassFullName]</mainClass>
            </manifest>
            <manifestEntries>
                <mode>development</mode>
                <url>$project.url</url>
                <key>value</key>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>

并使用此程序集配置将 jar 依赖项添加到您的程序集：

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
  <id>zip-with-jars</id>
  <formats>
    <format>zip</format>
  </formats>
  <includeBaseDirectory>false</includeBaseDirectory>
  <dependencySets>
    <dependencySets>
    <dependencySet>
    <outputDirectory>/</outputDirectory>
    <useProjectArtifact>true</useProjectArtifact>
    <unpack>false</unpack>
    <scope>runtime</scope>
    </dependencySet>
</dependencySets>
  </dependencySets>
</assembly>

【参考方案5】：

最简单的方法是使用maven-assembly-plugin 和预定义的jar-with-dependencies 描述符创建程序集。您还需要为此 uber jar 生成带有主类条目的清单。下面的 sn-p 显示了如何配置程序集插件：

<build>
  <plugins>
    <plugin>
      <artifactId>maven-assembly-plugin</artifactId>
      <configuration>
        <descriptorRefs>
          <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
        <archive>
          <manifest>
            <mainClass>fully.qualified.MainClass</mainClass>
          </manifest>
        </archive>
      </configuration>
    </plugin>
  </plugins>
</build>

然后，要生成程序集，只需运行：

mvn assembly:assembly

如果您想在构建过程中生成程序集，只需将assembly:single mojo 绑定到包阶段：

<build>
  <plugins>
    <plugin>
      <artifactId>maven-assembly-plugin</artifactId>
      <configuration>
        <descriptorRefs>
          <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
        <archive>
          <manifest>
            <mainClass>fully.qualified.MainClass</mainClass>
          </manifest>
        </archive>
      </configuration>
      <executions>
        <execution>
          <phase>package</phase>
          <goals>
            <goal>single</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

然后简单地运行：

mvn package

【讨论】：

maven-shade-plugin 的工作方式也类似，专门用于此目的。

这不适用于 spring 和其他需要在类路径上具有相同名称的多个资源的库。对于 spring，META-INF\spring.schemas 包含在几个 jars（beans、jdbc 等）中，用于为 XML 解析器配置 XML 命名空间支持。如果您尝试使用“jar-with-dependencies”，则在运行时传递 application-context.xml 将失败，并出现类似“org.xml.sax.SAXParseException：cvc-elt.1：找不到元素 'beans' 的声明。”

@David Maven 不会解决 Java“限制”。在这种情况下，只需干净地打包您的应用程序（即不在 uberjar 中）。

这适用于 Spring 配置，没有问题。我的主类使用 Classpath Application 上下文加载所有其他类，并且此解决方案完美运行。

assembly:assembly 目标是 deprecated