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

2022-01-15 00:00:00 dependencies java jar maven-2

这就是我想要实现的目标 - 一个如下所示的 dist 目录(或 zip 文件):

Here's what I'm trying to achieve - a dist directory (or a zip file) that looks like this:

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

基本上:

  • 生成一个可执行的 jar(在清单中有适当的类路径)
  • 我想排除src/main/resources与jar自动打包，以便修改application.properties
  • 我想在lib/目录下有外部依赖
  • An executable jar is produced (with appropriate classpath in the manifest)
  • I want to exclude src/main/resources from being automatically packaged with the jar, so that application.properties can be modified
  • I want to have external dependencies in the lib/ directory

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

I came up with a solution using a profile with plugins attached to the package phase, but would using the assembly plugin be a better solution?

推荐答案

使用汇编插件的解决方案有几个部分:

The solution using the assembly plugin has a few parts:

  • pom包括配置jar插件(maven-jar-plugin)，配置组装插件(maven-assembly-plugin).
  • 在maven的打包阶段，调用jar插件构建应用jar.
  • 然后运行程序集插件，并将构建的 jar、资源和依赖项组合到程序集文件 (distribution-zip.xml) 定义的 zip 文件中.
  • The pom includes configuring the jar plugin (maven-jar-plugin), and configuring the assembly plugin (maven-assembly-plugin).
  • During maven's packaging phase, the jar plugin is called to construct the application jar.
  • Then the assembly plugin is run, and combines the constructed jar, resources and dependencies into a zip file as defined by the assembly file (distribution-zip.xml).

在 pom 中，配置插件:

In the pom, configure the plugins:

<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、资源和依赖项:

The contents of the assembly file distribution-zip.xml (with thanks to Neeme Praks) combines the created jar, resources and dependencies:

<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！

The resulting distributable zip file is created like target/killer-app-1.0-dist.zip!

相关文章