从 Gradle 构建脚本中提取常用方法

Question

我有一个 Gradle 构建脚本 (build.gradle)，我在其中创建了一些任务。这些任务主要由方法调用组成。调用的方法也在构建脚本中。

现在，情况如下：

我正在创建大量构建脚本，其中包含不同的任务，但使用原始脚本中的相同方法。因此，我想以某种方式提取这些“常用方法”，这样我就可以轻松地重复使用它们，而不是为我创建的每个新脚本复制它们。

如果 Gradle 是 PHP，那么以下内容将是理想的：

//script content
...
require("common-methods.gradle");
...
//more script content

当然，这是不可能的。还是这样？

无论如何，我怎样才能达到这个结果？最好的方法是什么？我已经阅读了 Gradle 文档，但我似乎无法确定哪种方法最简单且最适合。

提前致谢！

---

更新：

我已经设法将方法提取到另一个文件中

（使用apply from: 'common-methods.gradle'），

所以结构如下：

parent/
      /build.gradle              // The original build script
      /common-methods.gradle     // The extracted methods
      /gradle.properties         // Properties used by the build script

从build.gradle 执行任务后，我遇到了一个新问题：显然，方法在common-methods.gradle 中时无法被识别。

关于如何解决这个问题的任何想法？

Answer 1

我建议对Matthias Braun's answer 稍作调整， 在那个而不是两次编写相同的方法名称并且仍然拥有它 清晰简洁，为什么不简单地执行以下操作：

ext.commonMethod1 = (param) -> {
    return true
} as Closure<boolean>

as-operator 的用法只是明确地告诉一个人， 这个函数将返回一个值boolean-type。

因为毕竟这仍然是 Groovy 的优点。整齐吧？

Answer 2

以Peter's answer 为基础，这是我导出方法的方式：

helpers/common-methods.gradle的内容：

// Define methods as usual
def commonMethod1(param) {
    return true
}
def commonMethod2(param) {
    return true
}

// Export methods by turning them into closures
ext {
    commonMethod1 = this.&commonMethod1
    otherNameForMethod2 = this.&commonMethod2
}

这就是我在另一个脚本中使用这些方法的方式：

// Use double-quotes, otherwise $ won't work
apply from: "$rootDir/helpers/common-methods.gradle"

// You can also use URLs
//apply from: "https://bitbucket.org/mb/build_scripts/raw/master/common-methods.gradle"

task myBuildTask {
    def myVar = commonMethod1("parameter1")
    otherNameForMethod2(myVar)
}

Here's more 在 Groovy 中将方法转换为闭包。

Answer 3

Kotlin DSL 的另一种方法可能是：

my-plugin.gradle.kts

extra["sum"] = { x: Int, y: Int -> x + y }

settings.gradle.kts

@Suppress("unchecked_cast", "nothing_to_inline")
inline fun <T> uncheckedCast(target: Any?): T = target as T

apply("my-plugin.gradle.kts")

val sum = uncheckedCast<(Int, Int) -> Int>(extra["sum"])

println(sum(1, 2))

Answer 4

使用 Kotlin dsl 它的工作原理如下：

build.gradle.kts：

apply {
  from("external.gradle.kts")
}

val foo = extra["foo"] as () -> Unit
foo()

external.gradle.kts：

extra["foo"] = fun() {
  println("Hello world!")
}

Answer 5

无法共享方法，但您可以共享包含闭包的额外属性，归结为同一件事。比如在common-methods.gradle中声明ext.foo = { ... }，使用apply from:应用脚本，然后用foo()调用闭包。