できない.dev

build.gradle

別名: build.gradle.kts / Gradle ビルドスクリプト / Gradle build script

build.gradle は Gradle のビルドスクリプトで、Groovy で書く。
Kotlin で書く場合は build.gradle.kts になる。
プラグイン・依存の取得先・依存・タスクをここに宣言する。

公開:

定義

build.gradle は、Gradle のプロジェクトのビルド設定を書くスクリプトである。
Groovy で書くと build.gradle、Kotlin で書くと build.gradle.kts になる。
Gradle が受け付けるビルドスクリプトの言語は、この 2 つの DSL だけだ。

詳細

公式ドキュメント(新しいタブで開く)によると、ビルドスクリプトにはプラグイン・依存・タスクの設定を書く。
依存の取得先は repositories に書く。

plugins {
    id 'java'
}
 
repositories {
    mavenCentral()
}
 
dependencies {
    implementation 'org.apache.commons:commons-lang3:3.17.0'
}

プロジェクトの構成は、ルートに置く settings.gradle(settings.gradle.kts)が決める。
マルチプロジェクトでは、各サブプロジェクトのディレクトリにそれぞれの build.gradle を置く。

よくある誤解

Groovy と Kotlin の DSL は書き方が違う。
Groovy では括弧を省けるが、build.gradle.kts では implementation("…") のように関数呼び出しで書く必要がある。

古い手順書の compile は Gradle 7 で削除された。
build.gradle に残っていると Could not find method compile() for arguments で止まる。

関連

Maven で同じ役割を持つのは pom.xml である。
build.gradle のタスクは、多くの場合 Gradle Wrapper の gradlew から実行する。