类plugins块风格批量引入自定义Gradle脚本的实现方式是什么
Gradle 自定义脚本引入的块式配置实现方案
Gradle 本身没有内置专门用来批量引入自定义脚本的官方配置块,但有两种可落地的方式可以实现统一管理、块式维护的效果,完全匹配你想要的配置形式:
1. 原生简化批量引入写法
不用逐行散落写单条apply from,可以把所有需要引入的脚本路径集中维护在统一列表里,一次性批量执行引入,维护成本比逐行写低很多:
plugins { id 'com.android.application' id 'kotlin-android' } // 所有自定义脚本路径集中维护 def helperScripts = [ "$rootDir/gradle/helpers/common-methods.gradle", "$rootDir/gradle/helpers/dependency-check.gradle", "$rootDir/gradle/helpers/release-task.gradle" ] // 批量执行脚本引入 helperScripts.each { path -> apply from: path }
这种写法所有要引入的脚本路径都堆在一个固定位置,增删改动不用找散落在脚本各处的apply语句,对中大型项目的配置维护比较友好。
2. 自定义块式语法实现完全匹配的配置效果
如果你就想要类似foo { from "xxx" }的块式写法,完全可以靠Gradle的扩展机制自己实现,不需要依赖额外插件,流程如下:
- 先在项目根目录的
build.gradle里给项目对象注册一个自定义扩展,比如命名为importedScripts:// 根项目build.gradle中添加的自定义块注册逻辑 project.extensions.create('importedScripts', ImportedScriptExtension) - 写对应的扩展处理逻辑(可以放在项目的
buildSrc目录下作为构建脚本的公共类),定义块里支持的from方法,收集所有传入的脚本路径,最后统一执行引入:// 存放在buildSrc/src/main/groovy下的自定义扩展类 abstract class ImportedScriptExtension { private final Project targetProject private final List<String> scriptPathList = [] @Inject ImportedScriptExtension(Project targetProject) { this.targetProject = targetProject } // 支持块内多次调用from传入不同脚本路径 void from(String scriptPath) { scriptPathList.add(scriptPath) } // 统一执行所有脚本的引入操作 void applyAll() { scriptPathList.each { path -> targetProject.apply(from: path) } } } - 配置完成后,在模块的build.gradle里就可以直接用块式写法统一管理要引入的自定义脚本了:
plugins { id 'com.android.application' id 'kotlin-android' } // 自定义的块式配置,所有要引入的自定义脚本都在这里声明 importedScripts { from "$rootDir/gradle/helpers/common-methods.gradle" from "$rootDir/gradle/helpers/dependency-check.gradle" } // 等当前模块所有基础配置加载完成后,统一应用收集到的脚本 afterEvaluate { importedScripts.applyAll() }
补充说明
- 如果觉得写独立扩展类+buildSrc的流程太重,也可以直接靠Groovy的动态语法在根项目配置里生成对应块的处理逻辑,不需要单独建类,最终模块里的块式写法和上面的效果完全一致。
- 自定义块实现时要注意调整脚本引入的时机,保持和原来单行
apply from的生效时机一致,避免出现配置加载顺序不对、任务注册冲突的问题。
内容的提问来源于stack exchange,提问作者a_local_nobody
相关产品推荐
相关产品推荐

