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

Question

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

我见过很多地方，人们只是把applieton属性文件放在src/main/resources中。但这会被复制到罐子里，这绝对是我不想要的。

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

但这与Netbeans有关，Netbeans希望属性文件位于src/main/external resources 内部

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

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

额外的好处：如果按照惯例这是不可能的，而我必须绕过它，为什么。。。。马文不是已经把这个改成这个日期了吗？

Answer 1

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

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

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

可能还有一个用于配置日志框架的属性文件，您也可以将其放在根目录中。然后，application.jar在其清单文件的类路径部分中正确地引用了所有jar和根目录。

这个ZIP文件可以使用maven汇编插件进行汇编。至少，这就是我们所做的。这可以在一个只为这个目的而存在的自己的项目中完成。然后，这个项目在您认为合适的目录中包含具有默认值的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");

请注意，在加载资源时，您不会提供路径（或包，或其他什么）。只是文件名。这是因为文件本身位于类路径的根中。例如，在运行测试时，这是因为它直接位于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>

阅读有关汇编插件的信息，它有许多配置选项。描述符元素引用描述符文件，该文件配置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文件本身。因此，您只将jar文件中的内容包含在src/*/resources中。

当你说：

如何在打包应用程序时使app.properties文件与.jar文件放在一起

我建议（如果我在你的情况下）你插入汇编插件来创建一个分发tarball/zipfile，其中包括你的jar文件、属性文件，以及你需要的任何其他文件。

这是关于它的基本信息。

更新（注意它是手工制作的，所以手表打字错误）：

将汇编插件添加到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启动器中显式设置。