Question

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

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

我可以设法让maven将src/main/external-resources/*内部的内容复制到target/*，这样当我打包项目时，我可以轻松地执行java -jar ...，并且属性文件位于jar旁边。

但这与Netbeans混淆，后者希望属性文件位于src / main / external-resources

内

如何在调试时在IDE的类路径中使app.properties文件可用。表示我可以使用new File("app.properties")
当我打包我的应用程序时，app.properties文件与.jar文件并列。

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

奖金：如果按照惯例这是不可能的，我必须在它周围工作，为什么....还没有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运行测试的类路径中。

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

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启动器中显式设置。

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

2 个答案: