将 jar 打包到具有分离的外部资源和依赖项的 dist 目录中

Posted 2023-03-07

【中文标题】将 jar 打包到具有分离的外部资源和依赖项的 dist 目录中

【英文标题】：Packaging a jar into a dist dir with separated external resources and dependencies

【发布时间】：2011-05-11 04:25:52

【问题描述】：

这就是我想要实现的目标——dist 目录（或 zip 文件），如下所示：

dist/
|-- application-1.0.jar
|-- conf/
    |-- application.properties
    |-- log4j.properties
|-- lib/
    |-- *.jar

基本上：

生成可执行 jar（在清单中具有适当的类路径） 我想排除src/main/resources与jar自动打包，以便修改application.properties 我想在lib/目录中有外部依赖

我想出了一个解决方案，它使用带有附加到包阶段的插件的配置文件，但是使用程序集插件会是更好的解决方案吗？

【参考方案1】：

使用组装插件的解决方案有几个部分：

pom 包括配置 jar 插件 (maven-jar-plugin) 和配置组装插件 (maven-assembly-plugin)。 在maven打包阶段，调用jar插件构建应用jar。 然后运行程序集插件，并将构建的 jar、资源和依赖项组合到程序集文件 (distribution-zip.xml) 定义的 zip 文件中。

在 pom 中，配置插件：

<build>
    <plugins>
        <plugin>
            <artifactId>maven-jar-plugin</artifactId>
            <version>2.2</version>
            <configuration>
                <archive>
                    <!-- Make an executable jar, adjust classpath entries-->
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <classpathPrefix>./lib/</classpathPrefix>
                        <mainClass>com.acme.KillerApp</mainClass>
                    </manifest>
                    <!--Resources will be placed under conf/-->
                    <manifestEntries>
                        <Class-Path>./conf/</Class-Path>
                    </manifestEntries>
                </archive>
                <!--exclude the properties file from the archive-->
                <excludes>
                    <exclude>*.properties</exclude>
                </excludes>
            </configuration>
        </plugin>

        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>2.2-beta-5</version>
            <configuration>
                <descriptors>
                    <descriptor>$basedir/assembly/distribution-zip.xml</descriptor>
                </descriptors>
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
...

汇编文件distribution-zip.xml的内容（感谢Neeme Praks）结合了创建的jar、资源和依赖：

<assembly>
    <id>dist</id>
    <formats>
        <format>zip</format>
    </formats>

    <includeBaseDirectory>true</includeBaseDirectory>

    <dependencySets>
        <dependencySet>
            <!--Include runtime dependencies-->
            <outputDirectory>lib</outputDirectory>
            <scope>runtime</scope>
        </dependencySet>
    </dependencySets>

    <fileSets>
        <fileSet>
            <!--Get the generated application jar-->
            <directory>$project.build.directory</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>*.jar</include>
            </includes>
        </fileSet>
        <fileSet>
            <!--Get application resources-->
            <directory>src/main/resources</directory>
            <outputDirectory>conf</outputDirectory>
        </fileSet>
        <fileSet>
            <!--Get misc user files-->
            <directory>$project.basedir</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>README*</include>
                <include>LICENSE*</include>
                <include>NOTICE*</include>
            </includes>
        </fileSet>       
    </fileSets>
</assembly>

生成的可分发 zip 文件创建为 target/killer-app-1.0-dist.zip!

【参考方案2】：

您需要使用两个插件来完成此操作：ma​​ven-jar-plugin 和 ma​​ven-assembly-plugin。

有用的pom.xml 示例：

how make JAR executable and set manifest classpath how to exclude files from JAR file assembly plugin usage

（我建议您将用户可编辑的属性文件分开到单独的目录中，但这只是个人喜好问题。）

示例程序集配置，帮助您入门：

<assembly>
  <id>dist</id>
  <formats>
    <format>zip</format>
  </formats>
  <includeBaseDirectory>true</includeBaseDirectory>
  <baseDirectory>dist</baseDirectory>
  <dependencySets>
    <dependencySet>
      <outputDirectory>lib</outputDirectory>
      <scope>runtime</scope>
    </dependencySet>
  </dependencySets>
  <fileSets>
    <fileSet>
      <directory>src/conf</directory>
      <outputDirectory>conf</outputDirectory>
    </fileSet>
    <fileSet>
      <directory>src/run</directory>
      <outputDirectory></outputDirectory>
      <excludes>
        <exclude>*.sh</exclude>
      </excludes>
    </fileSet>
  </fileSets>
  <files>
    <file>
      <source>src/run/run.sh</source>
      <outputDirectory></outputDirectory>
      <fileMode>0755</fileMode>
    </file>
  </files>
</assembly>

【讨论】：

酷，但还需要使jar可执行，设置清单类路径，并从jar中排除属性文件..

这已经是配置JAR插件的问题了，与组装插件无关。我猜你已经在这样做了，不是吗？如果您将 pom.xml 中的相关部分添加到您的问题中，这将有所帮助。

使 JAR 可执行并设置清单类路径：maven.apache.org/shared/maven-archiver/examples/classpath.html，排除属性：maven.apache.org/plugins/maven-jar-plugin/usage.html