Android Gradle ビルドロジック & Convention Plugins

このスキルは、Gradle Convention Plugins と Version Catalogs を使用して、Android アプリ用のスケーラブルで保守しやすいビルドシステムを設定するのに役立ちます。"Now in Android" (NiA) アーキテクチャに従っています。

目標

build.gradle.kts ファイル間でのコードのコピー&ペースト作業を廃止します。ビルドロジック (Compose セットアップ、Kotlin オプション、Hilt など) を再利用可能なプラグインに一元化します。

プロジェクト構造

プロジェクトに 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: Convention Plugin を作成

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)
}

これにより、モジュールレベルのビルドファイルが大幅に整理されます。