在 Gradle 应用程序插件中部署其他文件

Question

我有一个小型 Java/Gradle 项目。我正在使用 应用程序插件 创建 zip 发行版（使用 distZip 任务）。使用标准配置，我在 zip 文件中获得以下目录：

/bin - 启动应用程序的脚本位于此处
/lib - 在 JAR 文件和所有依赖 JAR 文件中包含我的项目代码。

问题是我想要第三个目录： /conf ，我可以在其中放置我的配置文件（而不是将它们打包在我的应用程序 JAR 文件中）。

我想这是一个非常常见的要求，因为事情像 log4j.xml 和 hibernate.properties 这样的文件最好放在 JAR 文件之外，但是我不知道如何自定义应用程序插件的行为来执行此操作。

Answer 1

几个月后我重新审视了这个问题，终于有了一个优雅的解决方案。应将以下代码添加到 gradle 文件中：

distZip {
    into(project.name) {
        from '.'
        include 'conf/*'
    }
}

这会向 distZip 任务添加额外的包含内容。这会将“conf”目录（包括内容）复制到 Zip 发行版中。

生成的 zip 文件包含一个与项目名称相同的目录。这就是为什么需要“进入”部分。

Answer 2

实际上，在项目的 src 目录下创建一个 dist 目录。当 installApp 或 distZip 运行时，应用程序插件（在 applicationDistribution 下）会复制此目录中的所有内容。

如果简单的副本还不够的话，或者编辑 applicationDistribution 来做其他事情。

Answer 3

对我来说，一个简单的

applicationDistribution.from("src/main/config/") {
    into "config"
}

任务就完成了。当然，您需要从代码中正确加载属性。特别是如果您将它们从可通过类路径使用的 src/main/resources 移动到新位置。我通过添加一个指向配置文件的命令行参数来规避这个问题。

Answer 4

我不确定是否可以自定义应用程序插件，我从未使用过它。然而，还有其他方法可以实现您想要实现的目标。

您可以像这样创建一个 /conf 目录：

confDir = new File("$buildDir/conf")

然后您可以将所需的文件复制到该目录中，如下所示：

task copyConfFiles(type: Copy) {
   from _wherever your files reside_
   into confDir
   include('**/*.properties') // your configuration files 
}

然后您可以将此复制任务挂接到该进程中，如下所示：

distZip.dependsOn copyConfFiles

最后，如果您不这样做如果您想要在最终的 zip 中进行配置，您可以这样做：

distZip {
   exclude('**/*.properties') // your configuration files
}

同样，可能有更好的方法。这是一种方式。

Answer 5

OP 的自我回答可能适合他的用例，但有一些我想改进的地方：

1. 他的回答表明他有一个与 build.gradle 并行的目录 conf 。 gradle。 Maven中没有这样的标准目录布局。普遍的共识是拥有一个 src/main/conf ，正如文档中暗示的那样：

如果还有其他对工件构建有贡献的来源，他们
将位于其他子目录下：例如 src/main/antlr 将
包含Antlr语法定义文件。

2. 评论中指出的

3. 如果需要资源过滤（而且经常如此），那么最好有一个单独的任务。本地开发时，可以运行该任务生成过滤后的文件。该发行版将仅使用此任务的输出（与 OP 的答案不同，这也使 conf 可用于 tar 发行版）。

   def props = new Properties()
   文件（“src/main/filters/application.properties”）
       .withInputStream { props.load(it) }
   
   导入 org.apache.tools.ant.filters.ReplaceTokens
   
   任务 copyConf(类型：复制) {
       来自（“src/main/conf/”）
       进入（“$buildDir/conf”）
       文件匹配（“**/*.y*ml”）{
           过滤器（令牌：道具，ReplaceTokens）
       }
   }
   分布{
       主要的 {
           内容 {
               来自（复制会议）{
                   进入（“会议”）
               }
           }
       }
   }