Gradle Kotlin DSL如何创建使用插件类的安卓子模块共享函数

解决方案 #

推荐方案：使用buildSrc模块（符合Gradle官方规范，类型安全） #

你之前的buildSrc方案不可用只是因为没有给buildSrc模块添加Android Gradle Plugin（AGP）的依赖，补全配置即可正常使用：

1. 新建/修改buildSrc/build.gradle.kts配置，添加AGP依赖：

plugins {
    `kotlin-dsl`
}

repositories {
    google()
    mavenCentral()
}

dependencies {
    // 版本号和你项目实际使用的AGP版本保持一致即可
    implementation("com.android.tools.build:gradle-api:7.4.2")
    implementation(kotlin("stdlib"))
}

2. 在buildSrc/src/main/kotlin目录下新建工具类文件，比如VariantUtils.kt，直接写入你定义的函数：

import com.android.build.api.variant.LibraryVariantBuilder

fun calculateIsEnabled(lvb: LibraryVariantBuilder): Boolean {
    return lvb.productFlavors[0].second == "flavor" && lvb.buildType == "debug"
}

3. 所有安卓库子模块不需要额外配置，直接调用该函数即可，子模块build.gradle.kts用法示例：

plugins {
    id("com.android.library")
    kotlin("android")
}

android {
    androidComponents.beforeVariants {
        it.enabled = calculateIsEnabled(it)
    }
}

备选方案：根项目扩展属性（适合简单逻辑场景） #

如果不想引入buildSrc模块，也可以通过根项目扩展属性共享函数，缺点是没有类型安全校验，调用时需要强转类型：

1. 在根目录build.gradle.kts中注册函数：

extra["calculateIsEnabled"] = fun(lvb: com.android.build.api.variant.LibraryVariantBuilder): Boolean {
    return lvb.productFlavors[0].second == "flavor" && lvb.buildType == "debug"
}

2. 子模块调用方式：

val calculateIsEnabled = rootProject.extra["calculateIsEnabled"] as (com.android.build.api.variant.LibraryVariantBuilder) -> Boolean

android {
    androidComponents.beforeVariants {
        it.enabled = calculateIsEnabled(it)
    }
}

内容的提问来源于stack exchange，提问作者curioushikhov