【问题标题】:Maven: compile a project using shade-plugin specifying main class and properties fileMaven:使用指定主类和属性文件的 shade-plugin 编译项目
【发布时间】:2017-04-11 06:21:41
【问题描述】:

Maven 新手,我正在尝试使用带有 maven-shade-plugin 的 Maven 编译一个项目(因为它似乎是构建胖 jar 的最佳插件)。我试图指定我的主类来制作一个可运行的 jar 文件和一些包含翻译字符串的 .properties 文件。

编译和构建似乎通过了,根据netbeans的输出,但我无法运行它(假设Maven构建的jar被重命名为“程序”):

/usr/bin/java -cp program.jar bot.Main
> could not find or load main class bot.Main

这是我的项目文件结构:

这是我的 pom.xml 文件:

<?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>com.mycompany</groupId>
<artifactId>mavenproject1</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<build>
    <resources>
    <resource>
        <directory>src/main/java/resources</directory>
        <includes>
            <include>**/*.properties</include>
        </includes>
    </resource>
</resources>
<plugins>

  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>2.4.3</version>
    <configuration>
      <archive>
      <manifest>
        <addClasspath>true</addClasspath>
        <classpathPrefix>lib/</classpathPrefix>
        <mainClass>bot.Main</mainClass>
      </manifest>
    </archive>
    <shadedArtifactAttached>true</shadedArtifactAttached>
    <shadedClassifierName>launcher</shadedClassifierName>
    </configuration>
    <executions>
      <execution>
        <phase>package</phase>
        <goals>
          <goal>shade</goal>
        </goals>
      </execution>
    </executions>
  </plugin>

  <plugin>
      <groupId>org.codehaus.mojo</groupId>
      <artifactId>exec-maven-plugin</artifactId>
      <version>1.2.1</version>
      <executions>
          <execution>
              <goals>
                  <goal>java</goal>
              </goals>
          </execution>
      </executions>
      <configuration>
          <mainClass>bot.Main</mainClass>
      </configuration>
  </plugin>

</plugins>
</build>
<dependencies>
    <dependency>
        <groupId>org.telegram</groupId>
        <artifactId>telegrambots</artifactId>
        <version>2.4.0</version>
        <classifier>jar-with-dependencies</classifier>
    </dependency>
    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-lang3</artifactId>
        <version>3.5</version>
    </dependency>
</dependencies>
<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
</properties>
</project>

资源是否正确包含?为什么我不能在不指定主类的情况下使用 java -jar 命令运行我的程序?它说我“无效或损坏的 jar 文件”,这应该意味着它不可运行。

另外,为什么两个都不开始指定 Main 类路径?

【问题讨论】:

    标签: java maven maven-shade-plugin


    【解决方案1】:

    问题在于您当前的 Shade 插件配置

    <configuration>
      <archive>
        <manifest>
          <addClasspath>true</addClasspath>
          <classpathPrefix>lib/</classpathPrefix>
          <mainClass>bot.Main</mainClass>
        </manifest>
      </archive>
      <shadedArtifactAttached>true</shadedArtifactAttached>
      <shadedClassifierName>launcher</shadedClassifierName>
    </configuration>
    

    shade goal 没有 &lt;archive&gt; 参数。事实上,您使用的是不存在的配置元素 is not an error,该配置将被忽略,这解释了为什么您的主类未在 Manifest 中设置。

    要使用 Shade 插件构建可执行 JAR,您需要 to provide the ManifestResourceTransformer 作为 transformers。正确的配置是:

    <configuration>
      <transformers>
        <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
          <mainClass>bot.Main</mainClass>
        </transformer>
      </transformers>
      <shadedArtifactAttached>true</shadedArtifactAttached>
      <shadedClassifierName>launcher</shadedClassifierName>
    </configuration>
    

    请注意,使用此配置,阴影 JAR 不会替换主 JAR。 shadedArtifactAttached 设置为 true,这意味着阴影 JAR 将作为辅助工件附加到项目中。它将通过 launcher 的分类器(即 shadedClassifierName 参数)与主 JAR 区分开来。

    在此项目上运行 mvn clean package 后,您将创建 2 个 JAR:

    • mavenproject1-1.0-SNAPSHOT.jar,这是主要的 JAR。此 JAR 仅包含应用程序的已编译 Java 源代码。它不是可执行的,并且不包含所有依赖项的类。
    • mavenproject1-1.0-SNAPSHOT-launcher.jar 是带有阴影的附加 JAR,由 Shade 插件构建。这个是可执行的并且包含依赖的类。

    这意味着,如果您想将应用程序作为可执行 JAR 启动,您必须启动 -launcher.jar,而不是另一个,使用

    java -jar mavenproject1-1.0-SNAPSHOT-launcher.jar
    

    作为旁注,两个 JAR 都将包含您在 &lt;directory&gt;src/main/java/resources&lt;/directory&gt; 中的资源,因为它们是项目本身的资源,如使用 &lt;resource&gt; 元素声明的那样。但是,最好尊重standard directory layout 并将资源放在src/main/resources 中。

    【讨论】:

    • 谢谢!但是当我尝试启动它时,我得到unable to access jarfile 错误。这是否仍然与阴影插件设置有关?
    • @A7X 听起来您没有在正确的位置运行java -jar 命令。 JAR 不在您启动它的目录中。如果您在您的项目中,它位于target 文件夹中,而不是根文件夹中。不过,这与 Shade 插件无关。
    • 是的,这是我的错。顺便说一句,我仍然收到 MissingResourceBundleException can't find bundle for resources.strings locale en_US。我使用ResourceBundle.getBundle("resources.strings", new Locale("en", "US"), loader); 将它们包含在我的项目中是因为我将错误的文件路径传递给资源吗?应该是完整路径吗?
    • @A7X 这是一个非常不同的错误,它意味着阴影 JAR 现在是正确的。我会猜测一下这个问题:你的资源在src/main/java/resources 里面,这是非常规的。您的 IDE 将 src/main/java 放置为源文件夹(Maven 约定),这意味着可以使用 resources.strings 访问资源(前缀为 resources.,因为它是类路径上的文件夹)。但是现在,在你的 uber jar 中,你告诉 Maven src/main/java/resources 是一个源文件夹,它支持它。因此,要访问您的资源,您必须单独拥有 "strings"
    • 谢谢。它没有解决另一个问题,但我接受你的回答,因为它解决了主要问题:)
    猜你喜欢
    • 2019-03-04
    • 2014-09-01
    • 2014-06-01
    • 1970-01-01
    • 2015-09-24
    • 2014-09-05
    • 1970-01-01
    • 2018-11-25
    相关资源
    最近更新 更多