SuperAPI AI 工具集

android-gradle-logic

编程与开发

查看项目

更新于 10-17 16:16

技能介绍

用途

该技能帮助开发者使用 Gradle Convention Plugins(约定插件)和 Version Catalogs(版本目录)为 Android 应用配置可扩展、易维护的构建系统,遵循 "Now in Android"(NiA)架构。核心目标是停止在多个 build.gradle.kts 文件之间复制粘贴代码,将构建逻辑(Compose 配置、Kotlin 选项、Hilt 等)集中到可复用的插件中。

主要能力

  • 指导建立包含 build-logic 复合构建的项目结构。
  • 指导在 settings.gradle.kts 中通过 pluginManagement 的 includeBuild 引入 build-logic 作为插件管理源。
  • 指导使用 Version Catalog(libs.versions.toml)统一管理库和插件版本。
  • 指导编写 Convention Plugin(如 AndroidApplicationConventionPlugin),集中配置 Android 应用与 Kotlin 插件及通用选项。
  • 指导在 build-logic/convention/build.gradle.kts 中通过 gradlePlugin 块注册自定义插件。
  • 指导在模块(如 app/build.gradle.kts)中通过 alias 应用自定义插件。

使用方式

项目结构

确保项目有一个 build-logic 目录,并在 settings.gradle.kts 中作为复合构建引入。

root/
├── build-logic/
│   ├── convention/
│   │   ├── src/main/kotlin/
│   │   │   └── AndroidApplicationConventionPlugin.kt
│   │   └── build.gradle.kts
│   ├── build.gradle.kts
│   └── settings.gradle.kts
├── gradle/
│   └── libs.versions.toml
├── app/
│   └── build.gradle.kts
└── settings.gradle.kts

第 1 步:配置 settings.gradle.kts

将 build-logic 作为插件管理源引入。

// settings.gradle.kts
pluginManagement {
    includeBuild("build-logic")
    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
    }
}

第 2 步:在 libs.versions.toml 中定义依赖

为库和插件使用 Version Catalog。

[versions]
androidGradlePlugin = "8.2.0"
kotlin = "1.9.20"

[libraries]
# ...

[plugins]
android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }
android-library = { id = "com.android.library", version.ref = "androidGradlePlugin" }
kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
# Define your own plugins here
nowinandroid-android-application = { id = "nowinandroid.android.application", version = "unspecified" }

第 3 步:创建约定插件

在 build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt 中:

import com.android.build.api.dsl.ApplicationExtension
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.kotlin.dsl.configure

class AndroidApplicationConventionPlugin : Plugin<Project> {
    override fun apply(target: Project) {
        with(target) {
            with(pluginManager) {
                apply("com.android.application")
                apply("org.jetbrains.kotlin.android")
            }

            extensions.configure<ApplicationExtension> {
                defaultConfig.targetSdk = 34
                // Configure common options here
            }
        }
    }
}

别忘了在 build-logic/convention/build.gradle.kts 中注册它:

gradlePlugin {
    plugins {
        register("androidApplication") {
            id = "nowinandroid.android.application"
            implementationClass = "AndroidApplicationConventionPlugin"
        }
    }
}

使用

在模块(如 app/build.gradle.kts)中应用自定义插件:

plugins {
    alias(libs.plugins.nowinandroid.android.application)
}

这会大幅简化模块级构建文件。

适用场景

适用于需要为 Android 应用建立可扩展、可维护构建系统的开发场景,尤其是多模块项目,希望通过约定插件集中管理 Compose 配置、Kotlin 选项、Hilt 等构建逻辑,减少重复代码。

限制

资料未提供该技能的具体安装命令、收费方式、平台支持范围或实际效果验证信息,暂未提供。