应用程序属性文件的 Maven 标准约定

Question

我有一个 jar 类型的 maven 项目。这旨在成为作为服务运行的独立 Java SE 应用程序。像往常一样，它有自己的 app.properties 文件，其中包含数据库连接信息等属性。所以这不是要上传到 maven Central 的项目，它应该留在我的组织中，并且在 jar 旁边有一个属性文件是有意义的。

我见过很多地方人们只是将应用程序属性文件放在 src/main/resources 中。但这会被复制到罐子里，这正是我不想要的。

我可以设法让 maven 复制里面的内容，例如 src/main/external-resources/* 到 target/*，所以当我打包项目时，我可以轻松地做 java -jar ... 并且属性文件在 jar 旁边。

但是与期望属性文件位于 src/main/external-resources 内的 Netbeans 混淆

1. 如何在调试时使 app.properties 文件在 IDE 的类路径中可用。意味着我可以使用new File("app.properties") 访问该文件
2. 当我打包我的应用程序时，如何使 app.properties 文件与 .jar 文件并排放置。

基本上我希望能够在我的 IDE 中调试我的程序并使用带有new File("app.properties") 的属性文件，然后在打包或组装应用程序时我想做 java -jar ...并且应用程序仍然可以使用 new File("app.properties") 访问它的属性文件（在 jar 旁边）

奖励：如果按照惯例这是不可能的并且我必须围绕它工作，为什么....到目前为止还没有 maven 将其更改？

Answer 1

可能有很多方法可以实现所需的输出。假设您有一个 app.properties 具有应与您的应用程序一起部署的默认值。进一步假设，您的应用程序也有许多库。

在这种情况下，我们要做的是组装一个包含以下内容的 zip 文件：

<root>
  |
  +--- lib/
  |     |
  |     +--- [all your libraries here]
  |
  +--- application.jar (of course named as you want)
  |
  +--- app.properties

可能还有一个用于配置日志框架的属性文件，您也可以将其放入根目录。然后，您的 application.jar 会正确引用其清单文件的 Class-Path 部分中的所有 JAR 和根目录。

此 ZIP 文件可以使用 maven-assembly-plugin 进行组装。至少，这是我们所做的。这可以在仅为此目的而存在的自己的项目中完成。然后，此项目在您认为合适的目录中包含 app.properties 文件和默认值。

如果您想通过直接从 IDE 运行主类来测试您的项目（就像我们使用 Eclipse 所做的那样），您可以在 src/test/resources 目录中使用 app.properties。从 IDE 运行时，这通常位于类路径上，但不会出现在 JAR 文件中。运行测试时它也在类路径上。

这符合您的需要吗？

根据要求编辑：

您应该将app.properties 文件放入项目目录src/test/resources。这样，当从 IDE 运行主类时，它将位于类路径中（用于测试目的）。这样它也将位于使用 Maven 运行测试的类路径中。

其次，您应该不使用new File(...) 加载app.properties 文件。始终为此目的使用类加载器，因为这是在程序中加载资源的正确方法：

ClassLoader loader = Thread.currentThread().getContextClassLoader();
URL appResourceURL = loader.getResource("app.properties");

请注意，您在加载资源时不提供路径（或包，或其他）。只是文件名。那是因为文件本身位于类路径的 root 中。例如在运行测试时，这是因为它直接位于src/test/resources。

现在您要部署您的应用程序。一个应用程序不仅包含一个主 JAR 文件，它还依赖于许多库 JAR 文件和一些配置文件，例如您希望将其放在 外部的 app.properties 文件主 JAR 文件。

Maven 的理念是只有一个生成的工件。因此，为了不影响这一点，您可以创建一个新项目，其目的是创建一个 ZIP 文件以进行部署。但您也可以（我在许多项目中也这样做过）调整项目的 POM 以生成 JAR 文件和组装的 ZIP 文件。

POM 应包含以下插件：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
        <descriptors>
            <descriptor>src/main/assembly/zip.xml</descriptor>
        </descriptors>
    </configuration>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

阅读assembly plugin，它有很多配置选项。描述符元素是指一个描述符文件，它配置 ZIP 文件的组装方式。您还可以使用一些内置配置。阅读文档。

最后一步必须是配置 jar 插件，以便清单包含正确的类路径。例如：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <configuration>
        <archive>
            <addMavenDescriptor>false</addMavenDescriptor>
            <manifestEntries>
                <Class-Path>config/</Class-Path>
            </manifestEntries>
            <manifest>
                <addClasspath>true</addClasspath>
                <classpathPrefix>lib/</classpathPrefix>
            </manifest>
        </archive>
    </configuration>
</plugin>

请注意，我确实将配置文件放入名为 config 的目录中（仅在生成的 ZIP 中）。这必须是类路径的一部分。

如果您之后将 ZIP 文件解压缩到任何目录，您可以使用您喜欢的任何方法启动您的程序。它很可能是一个可运行的 JAR，或者一个可执行文件（或者可能是一个脚本）也将与您的 JAR 一起出现。

Answer 2

通常，您的项目的输出是您的 jar 文件本身。因此，您只需在 src/*/resources 中包含 jar 文件中的内容。

当你说：

当我打包我的应用程序时，如何使 app.properties 文件与 .jar 文件一起出现。

我建议（如果我遇到您的情况）插入程序集插件以创建一个分发 tarball/zipfile，其中包含您的 jar 文件、属性文件以及您需要的任何其他内容。

Here's the basic information about it.

更新（注意是手工制作，请注意错别字）：

在 pom 中添加组装插件：

<build>
<plugins>
  <plugin>
    <artifactId>maven-assembly-plugin</artifactId>
    <version>2.4</version>
    <configuration>
      <descriptor>src/assembly/dep.xml</descriptor>
    </configuration>
    <executions>
                <execution>
                    <id>create-executable-jar</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
    </executions>
  </plugin>
</plugins>
</build>

然后在src/assembly/dep.xml中添加程序集描述符：

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">

  <id>bundle</id>
  <formats>
    <format>zip</format>
  </formats>
  <includeBaseDirectory>true</includeBaseDirectory>
  <dependencySets>
    <dependencySet>
      <!-- ************************************************************ -->
      <!-- This dependency copies all  jar files    -->
      <!-- ************************************************************ -->
      <unpack>false</unpack>
      <scope>runtime</scope>
      <useProjectArtifact>true</useProjectArtifact>
      <useTransitiveDependencies>true</useTransitiveDependencies>
      <outputDirectory>lib/</outputDirectory>
      <includes>
        <include>*:jar:*</include>
      </includes>
    </dependencySet>
  </dependencySets>
 <fileSets>
    <fileSet>
      <!-- ************************************************************ -->
      <!-- Copy the environment specific property files                 -->
      <!-- ************************************************************ -->
      <directory>src/main/external-config</directory>
      <outputDirectory>/</outputDirectory>
      <includes>
        <include>app.properties</include>
      </includes>
    </fileSet>
 </fileSets>
</assembly>

此外，如果我有这个特定要求，eclipse 启动器会将工作目录设置为 src/main/external-config。它可以在参数选项卡上的 Eclipse 启动器中显式设置。