是否可以使用自定义清单文件创建包含项目类和项目依赖项的“超级”jar作为jar?

时间:2009-12-02 13:19:19

标签: java maven-2 build-process maven-plugin uberjar

我正在尝试创建一个包含项目类的可执行jar(使用maven),它是一个清单文件的依赖项,该文件包含主类的条目和指向根目录中包含的依赖项的类路径条目jar的东西;这样的东西:

清单文件:

.....
Main-Class : com.acme.MainClass
Class-Path : dependecy1.jar dependecy2.jar
.....

罐:

jar-root
|-- ....
|-- com/acme/../*.class
|-- dependecy1.jar
`-- dependecy2.jar

我正在使用maven-jar-plugin来创建清单文件和maven-shade-plugin来创建“uber”jar,但是依赖项被解压缩并作为类添加到我的jar中。

5 个答案:

答案 0 :(得分:58)

实际上,我并没有检查maven-shade-plugin正在做什么(或任何其他插件),因为maven 2拥有内置的一切来创建megajar或uberjar。您只需使用带有预定义jar-with-dependencies描述符的maven-assembly-plugin。

只需将此代码段添加到pom.xml即可自定义清单:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-assembly-plugin</artifactId>
  <configuration>
    <archive>
      <manifest>
        <mainClass>my.package.to.my.MainClass</mainClass>
      </manifest>
    </archive>
  </configuration>
</plugin>

以下命令将生成你的uberjar:

mvn assembly:assembly -DdescriptorId=jar-with-dependencies

但是,同样,此描述符的默认行为是解包依赖项(如maven-shade-plugin)。说实话,我不明白为什么这是一个问题但是,如果这不是你想要的,你可以使用自己的自定义汇编描述符。

为此,首先,使用以下内容创建汇编描述符,例如src/assembly/uberjar.xml

<assembly>
  <id>uberjar</id>
  <formats>
    <format>jar</format>
  </formats>
  <includeBaseDirectory>false</includeBaseDirectory>
  <dependencySets>
    <dependencySet>
      <unpack>false</unpack>
      <scope>runtime</scope>
      <useProjectArtifact>false</useProjectArtifact>
    </dependencySet>
  </dependencySets>
  <fileSets>
    <fileSet>
      <directory>${project.build.outputDirectory}</directory>
      <outputDirectory>/</outputDirectory>
    </fileSet>
  </fileSets>
</assembly>

然后,配置maven-assembly-plugin以使用此描述符并将依赖项添加到清单的Class-Path条目:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-assembly-plugin</artifactId>
  <configuration>
    <descriptors> 
      <descriptor>src/assembly/uberjar.xml</descriptor>
    </descriptors>
    <archive>
      <manifest>
        <mainClass>my.package.to.my.MainClass</mainClass>
        <addClasspath>true</addClasspath>
      </manifest>
    </archive>
  </configuration>
  <!--
  <executions>
    <execution>
      <phase>package</phase>
      <goals>
        <goal>single</goal>
      </goals>
    </execution>
  </executions>
  -->
</plugin>

最后运行mvn assembly:assembly来制作你的uberjar。

(可选)取消注释executions元素以绑定package阶段的程序集插件(并将程序集作为正常构建的一部分生成)。

答案 1 :(得分:6)

答案 2 :(得分:2)

我过去曾经使用过FatJar。 http://fjep.sourceforge.net/

我创建了一个相对简单的应用程序,客户端想要双击可执行文件并使其正常工作。安装程序或依赖项是不可能的。 Fatjar将Eclipse中的项目库和引用文件捆绑到一个几兆字节的可执行jar中。无瑕疵。

答案 3 :(得分:0)

我知道有两种产品可以做到这一点:

  • 其中一个被称为'bigjar',但这个术语过于普遍,无法在Google搜索中使用;我无法找到它。
  • 另一个被称为'onejar'。有很多引用它,它声称做你需要的。

以下是在Maven程序集中使用OneJar的人的帖子:

http://5341.com/list/55/498657.html

答案 4 :(得分:0)

task uberJar(type: Jar) {
    manifest {
        attributes 'Main-Class': 'main.RunTest'
    }
    dependsOn configurations.runtimeClasspath
    from sourceSets.main.output
    from sourceSets.test.output
    from sourceSets.main.resources
    from sourceSets.test.resources
    from {
        configurations.runtimeClasspath.findAll { it.name.endsWith('jar') }.collect { zipTree(it) }
    }
    from {
        project(':someothermoudule').sourceSets.main.resources // If current project depends on some other modules
        project(':someothermoudule').sourceSets.test.resources // If current project depends on some other modules
    }
    exclude 'META-INF/*.RSA'
    exclude 'META-INF/*.SF'
    exclude 'META-INF/*.DSA'
}

在以上情况下可以提供帮助。请注意from { project('')}行,仅当当前项目依赖于某些其他子项目或模块时才需要。