使用Gradle排除JAR中的资源

Question

我最近开始从事7年以上的旧项目，该项目使用Ant / Ivy 进行依赖和构建管理。我的任务是将其转换为Gradle ，但结构有点不合常规：

|- projectRoot
  |- folderA
  |- folderB
  |- projectX
    |- conf
    | |- file1.txt
    |
    |- core
    |  |- src
    |  | |- App.java
    |  |
    |  |- test
    |    |- AppTest.java
    |
    |- res
    | |- file2.txt
    |
    |- ivybuild.xml
    |- ivysettings.xml

Ivy的构建过程非常简单，生成的dist文件夹如下所示：

|- dist
  |- proj.jar
  |- lib
  |  |- dep1.jar
  |  |- dep2.jar
  |
  |- conf
  |  |- file1.txt
  |- res
     |- file2.txt

没有资源内置到生成的JAR中，因为在部署期间从单独的存储库中应用了某些配置，因此资源必须保留在JAR外部。

我正在努力寻找一种方法来实现这一目标，同时还要让IDE（Intellij IDEA）在调试和运行测试期间成功找到资源。

sourceSets {
    main {
        java {
            srcDir 'core/src'
        }
        resources {
            srcDir 'conf'
            srcDir 'res'
        }
    }
    test {
        java {
            srcDir 'core/test'
        }
    }
}
processResources {
    from 'conf' into 'lib/conf'
    from 'res' into 'lib/res'
}
startScripts {
    classpath += files('conf')
    classpath += files('res')
}

通过上述操作，我能够成功运行/测试项目，因为将来自“ conf”和“ res”的所有文件复制到“ build / resources / main”中，这使得调试和测试都可以找到它们。它将两个资源目录都复制到输出lib文件夹，并将它们添加到运行脚本中的classpath中。

除了将资源仍复制到已构建的JAR中之外，上述方法有效。这些将覆盖外部文件夹配置，因此不会。

jar {
    processResources {
        exclude("*")
    }
}

如果我现在仅运行assemble，则构建的项目正是我想要的样子，但是IDE现在无法运行调试器或测试成功，因为它无法找到build/resources/main下缺少的文件

我还尝试了idea插件来设置资源路径，但无济于事。

有办法吗？

Answer 1

仅供参考：作为一个 gradle 新手，我最近在尝试从 jar 中排除一些 src/main/resources 文件时发现了这一点

// Exclude all resources from the jar
jar {
    processResources.exclude('*')
}

实际上不仅仅是从 jar 中排除 - 它完全从构建中排除，因为它们不存在于 build/resources/ 中；所以可能会影响您的测试等。

Answer 2

使用Gradle排除JAR中的资源

示例 build.gradle

plugins {
    id 'java'
    id 'application'
}

// Project specifics
version '1.0-SNAPSHOT'
group 'com.example'

sourceCompatibility = 1.8
project.mainClassName = "core.ExampleApp"

dependencies {
    testCompile 'junit:junit:4.12'
}

// Define the project source paths
sourceSets {
    main.java {
        srcDir 'core/src'
    }
    test.java {
        srcDir 'core/test'
    }
}

// Exclude all resources from the jar
jar {
    processResources.exclude('*')
}

// Allows the 'test' task to see the directories on the classpath
test {
    classpath += files('conf')
    classpath += files('res')
}

// Allows the 'run' task to see the directories on the classpath
run {
    classpath += files('conf')
    classpath += files('res')
}

// Adds the directories to classpath in the start scripts
// They will have '$APP_DIR/lib/' prepended so they need to be copied into 'dist/lib/'
startScripts {
    run {
        classpath += files('conf')
        classpath += files('res')
    }
}

// Copy 'conf' and 'res' into the 'dist/lib' directory
distributions {
    main {
        contents {
            from('conf').into("lib/conf")
            from('res').into("lib/res")
        }
    }
}

在gradle run期间找到资源
在gradle test期间找到资源
内置JAR不包含资源
资源已复制到example.zip/lib/conf和.../lib/res
将资源内容添加到生成的构建脚本中的类路径中
通过IntelliJ UI运行测试确实可以（例如right click -> run tests）

但：

无法通过IntelliJ UI运行（例如right click -> run main()）

解决方案：

IntelliJ Gradle插件允许right click -> run和right click -> debug
以上内容为IntelliJ运行面板添加了一个配置，作为一个不错的替代品

Answer 3

在 Kotlin DSL 中

tasks.jar.configure {
    exclude("**/node_modules/")
    exclude("web/package*.json")
    exclude("web/*.config.js")
    archiveFileName.set("my.jar")
    ...
}

Answer 4

我得到了一个解决方案，它不会影响测试。

jar {
    exclude { FileTreeElement el -> el.file.toPath().startsWith("$buildDir/resources/main") }
}

如何从Gradle中的JAR中排除资源，以及如何通过IntelliJ运行

4 个答案:

使用Gradle排除JAR中的资源