将jar打包到具有独立外部资源和依赖关系的dist目录中

Question

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

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

基本上:

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

我想出了一个使用配置文件的解决方案,其中包含附加到包阶段的插件,但使用组件插件是一个更好的解决方案吗？

Answer 1

使用程序集插件的解决方案有几个部分:

• pom包括配置jar插件(maven-jar-plugin)和配置程序集插件(maven-assembly-plugin).
• 在maven的打包阶段,调用jar插件来构造应用程序jar.
• 然后运行程序集插件,并将构造的jar,资源和依赖项组合到一个zip文件中,该文件由程序集文件(distribution-zip.xml)定义.

在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!

Answer 2

您需要使用两个插件来完成此操作：maven-jar-plugin和maven-assemble-plugin。

有用的pom.xml样本：

• 如何使 JAR 可执行并设置清单类路径
• 如何从 JAR 文件中排除文件
• 汇编插件使用

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

示例装配配置，帮助您入门：

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