本教程旨在指导开发者如何使用 gradle 将一个兄弟项目（sibling project）编译生成的 JAR 文件复制到另一个项目中的特定目录。通过自定义 Gradle 任务，可以实现在构建项目 A 之前，先构建项目 B 并将其 JAR 文件复制到项目 A 的指定位置，从而满足项目 A 在运行时对项目 B 的 JAR 文件的依赖需求，而无需显式声明项目间的依赖关系。
在某些情况下，一个项目可能需要在运行时依赖于另一个兄弟项目的 JAR 文件，但又不希望在构建时建立显式的依赖关系。例如，项目 A 需要使用项目 B 编译后的 JAR 文件进行测试，但项目 A 的代码本身并不直接依赖于项目 B。这时，可以使用 Gradle 自定义任务来实现这个需求。
以下是如何使用 Gradle 实现将兄弟项目 B 编译后的 JAR 文件复制到项目 A 的指定目录的步骤：
-
定义自定义任务 buildBJar
该任务负责构建项目 B 的 JAR 文件。使用 Exec 类型的任务可以执行命令行指令，从而调用项目 B 的 Gradle 构建脚本。
task buildBJar(type: Exec) { workingDir '.B' // 项目B的根目录 commandLine("cmd", "/c", "gradle", "build") // 执行项目B的gradle build命令 doLast { println "B has been built and now JAR will be copied" } }- workingDir: 指定项目 B 的根目录。
- commandLine: 指定要执行的命令行指令，这里是调用项目 B 的 gradle build 命令。
- doLast: 在任务执行完毕后，打印一条消息。
-
定义自定义任务 copyB
该任务负责将项目 B 构建生成的 JAR 文件复制到项目 A 的指定目录。使用 Copy 类型的任务可以方便地复制文件。
task copyB(type: Copy) { from './B/build/libs/B.jar' // 项目B构建生成的JAR文件路径 into '.' // 复制到的目标目录，这里是项目A的根目录，可以根据实际情况修改 }- from: 指定要复制的文件路径，这里是项目 B 构建生成的 JAR 文件路径。
- into: 指定复制到的目标目录，这里是项目 A 的根目录，可以根据实际情况修改。
-
配置任务依赖关系
需要确保在构建项目 A 之前，先构建项目 B 并将其 JAR 文件复制到项目 A 的指定目录。可以通过 finalizedBy 来建立任务之间的依赖关系。
tasks.named("copyB") { finalizedBy("buildBJar") } //copyB 任务依赖于 buildBJar 任务 tasks.named("build") { finalizedBy("copyB") } // build 任务依赖于 copyB 任务- tasks.named(“copyB”) { finalizedBy(“buildBJar”) }: 表示 copyB 任务在 buildBJar 任务完成后执行。
- tasks.named(“build”) { finalizedBy(“copyB”) }: 表示 build 任务（项目 A 的默认构建任务）在 copyB 任务完成后执行。
这样配置后，当执行项目 A 的 build 任务时，Gradle 会先执行 buildBJar 任务构建项目 B 的 JAR 文件，然后执行 copyB 任务将 JAR 文件复制到项目 A 的指定目录，最后才执行项目 A 的 build 任务。
完整示例
将以下代码添加到项目 A 的 build.gradle 文件中：
task buildBJar(type: Exec) { workingDir '.B' commandLine("cmd", "/c", "gradle", "build") doLast { println "B has been built and now JAR will be copied" } } task copyB(type: Copy) { from './B/build/libs/B.jar' into '.' } tasks.named("copyB") { finalizedBy("buildBJar") } tasks.named("build") { finalizedBy("copyB") }
注意事项
- 请确保项目 B 的 build.gradle 文件能够正确构建 JAR 文件。
- 需要根据实际情况修改 workingDir、from 和 into 的路径。
- 此示例假设项目 A 和项目 B 位于同一父目录下。
- commandLine 在 windows 系统下使用 “cmd”, “/c”, “gradle”, “build”，在 linux 或 macos 系统下可以使用 “./gradlew”, “build”。
总结
通过自定义 Gradle 任务并配置任务依赖关系，可以灵活地实现将兄弟项目的编译 JAR 文件复制到指定目录的需求，而无需显式声明项目间的依赖关系。这种方法适用于需要在运行时依赖于其他项目的 JAR 文件，但又不希望在构建时建立显式依赖关系的情况。
