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

Question

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

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

我可以设法让 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 会正确引用其 list 文件的类路径部分中的所有 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 的理念是只生成一个 Artifact 。因此，为了让它保持不变，您可以创建一个新项目，目的是创建一个用于部署的 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 , 它有许多配置选项。 descriptor 元素引用描述 rune 件，它配置 ZIP 文件的组装方式。您还可以使用一些内置配置。阅读文档。

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

<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 一起出现。