本教程旨在指导 Gradle 新手如何将一个兄弟项目编译后的 JAR 文件复制到另一个项目的指定目录。通过自定义 Gradle 任务，实现兄弟项目的编译，并将生成的 JAR 文件复制到目标项目，从而满足特定测试或运行时需求，而无需建立项目间的依赖关系。
在 Gradle 项目开发中，有时我们需要将一个兄弟项目（sibling project）编译后的 JAR 文件复制到另一个项目中，以满足测试或运行时需求。这种需求与项目间的依赖关系不同，仅仅是需要将编译好的 JAR 文件复制到目标项目的特定目录。下面将介绍如何通过自定义 Gradle 任务来实现这一目标。
实现步骤
- 定义复制 JAR 文件的任务 (copyB)
首先，我们需要创建一个自定义的 Gradle 任务，该任务负责将兄弟项目的 JAR 文件复制到目标项目的指定目录。以下是一个示例：
task copyB(type: Copy) {
from './B/build/libs/B.jar' // 指定源 JAR 文件的路径
into '.' // 指定目标目录（这里表示当前项目根目录）
}这段代码定义了一个名为 copyB 的任务，类型为 Copy。from 属性指定了要复制的 JAR 文件的路径，这里假设兄弟项目 B 的 JAR 文件位于 ./B/build/libs/B.jar。into 属性指定了目标目录，这里使用 '.' 表示当前项目（项目 A）的根目录。你可以根据实际需求修改这些路径。
- 定义编译兄弟项目 JAR 文件的任务 (buildBJar)
接下来，我们需要定义一个任务，该任务负责编译兄弟项目 B 的 JAR 文件。这可以通过执行 Gradle 的 build 命令来实现。
task buildBJar(type: Exec) {
workingDir '.\\B' // 指定兄弟项目 B 的工作目录
commandLine("cmd", "/c", "gradle", "build") // 执行 Gradle build 命令
doLast {
println "B has been built and now JAR will be copied" // 完成后的提示信息
}
}这个任务 buildBJar 的类型是 Exec，用于执行外部命令。workingDir 属性指定了兄弟项目 B 的工作目录，commandLine 属性指定了要执行的命令，这里使用 cmd /c gradle build 来执行兄弟项目 B 的 Gradle 构建。doLast 代码块定义了任务执行完成后的操作，这里简单地输出一条提示信息。
- 关联任务执行顺序
为了确保兄弟项目 B 的 JAR 文件在复制之前已经被编译，我们需要将 copyB 任务与 buildBJar 任务关联起来。同时，我们还需要将 copyB 任务与目标项目 A 的 build 任务关联起来，确保在构建项目 A 之前执行 JAR 文件复制。
tasks.named("copyB") { finalizedBy("buildBJar") } // copyB 任务在 buildBJar 任务完成后执行
tasks.named("build") { finalizedBy("copyB") } // build 任务在 copyB 任务完成后执行finalizedBy 关键字表示一个任务将在另一个任务完成后执行。这里我们指定 copyB 任务在 buildBJar 任务完成后执行，并且 build 任务在 copyB 任务完成后执行。
完整示例
将以上代码片段添加到项目 A 的 build.gradle 文件中，完整的 build.gradle 文件可能如下所示：
plugins {
// your plugins
}
dependencies {
// your dependencies
}
task copyB(type: Copy) {
from './B/build/libs/B.jar'
into '.'
}
tasks.named("copyB") { finalizedBy("buildBJar") }
task buildBJar(type: Exec) {
workingDir '.\\B'
commandLine("cmd", "/c", "gradle", "build")
doLast {
println "B has been built and now JAR will be copied"
}
}
tasks.named("build") { finalizedBy("copyB") }执行构建
现在，当你执行项目 A 的 build 任务时，Gradle 将按照以下顺序执行任务：
- 首先，执行 buildBJar 任务，编译兄弟项目 B 的 JAR 文件。
- 然后，执行 copyB 任务，将编译好的 JAR 文件复制到项目 A 的根目录。
- 最后，执行项目 A 的 build 任务。
注意事项
- 确保兄弟项目 B 的路径 ./B/build/libs/B.jar 是正确的。
- 根据实际需求修改目标目录 into 属性的值。
- 可以根据需要自定义 buildBJar 任务，例如添加额外的编译参数。
- 该方法假设兄弟项目 B 也是一个 Gradle 项目，可以使用 gradle build 命令进行编译。
总结
通过自定义 Gradle 任务，我们可以灵活地控制构建过程，实现将兄弟项目编译后的 JAR 文件复制到目标项目的指定目录。这种方法适用于需要共享编译结果，但又不想建立项目间直接依赖关系的情况。 希望本教程能够帮助你理解和掌握 Gradle 的自定义任务功能，并在实际项目中灵活应用。
