KotlinのGradleカスタムタスクを徹底解説！初心者でもわかるビルドスクリプトの活用方法

先生と生徒の会話形式で理解しよう

生徒

「KotlinでGradleってよく聞くけど、具体的に何をするツールなんですか？」

先生

「Gradleは、Kotlinのプロジェクトをビルド（コンパイルして実行できる形にする）するためのツールです。プログラムに必要な部品（ライブラリ）を自動で入れてくれる便利な仕組みもありますよ。」

生徒

「なるほど！そのGradleにカスタムタスクって追加できるんですか？」

先生

「はい、できます。自分だけの特別な作業を、Gradleに覚えさせて実行させることができます。それでは、やり方をわかりやすく説明していきましょう！」

1. Gradleとは？Kotlinで使うビルドツールの基本

Gradle（グレードル）とは、KotlinやJavaのプロジェクトで使われるビルドツールです。「ビルド」とは、ソースコードを機械が読める形にまとめたり、外部の部品（ライブラリ）を自動でダウンロードしたりすることです。

Gradleは、パソコンに「こうして動かしてね」と伝えるスクリプト（命令のメモ）を書くことで、自動的に作業をしてくれます。

2. カスタムタスクって何？

カスタムタスクとは、Gradleに自分だけの特別な作業を追加する機能のことです。

例えば、ファイルの中身を表示するだけの簡単な処理や、「おはよう」と表示するだけの命令など、自分の好きな作業をタスクとして追加できます。

これにより、毎回手作業でやっていた処理をボタン一つで実行できるようになります。

3. Gradleスクリプトにカスタムタスクを追加する方法

それでは、実際にKotlinのプロジェクトでGradleにカスタムタスクを追加する方法を見てみましょう。Kotlin DSL（Kotlinの書き方）を使ったbuild.gradle.ktsファイルに記述します。

次のコードは、「こんにちは！」と表示するだけのカスタムタスクです。


tasks.register("helloTask") {
    group = "custom"
    description = "カスタムで作ったHelloタスク"
    doLast {
        println("こんにちは！Gradleカスタムタスクです。")
    }
}

Kotlinを基礎からしっかり学びたい人や、 Java経験を活かしてモダンな言語にステップアップしたい人には、定番の入門書がこちらです。

基礎からわかるKotlinをAmazonで見る

※ Amazon広告リンク

4. タスクの実行方法

追加したカスタムタスクは、コマンドライン（黒い画面）で次のように実行できます。


./gradlew helloTask

Windowsの人は次のように入力します。


gradlew.bat helloTask

実行すると、ターミナルに次のように表示されます。


こんにちは！Gradleカスタムタスクです。

5. doFirstとdoLastの違い

doLastは、タスクの最後に実行される処理を指定します。一方で、doFirstを使うと、最初に実行される処理を追加できます。

例えば次のように、タスクの前後に処理を入れることができます。


tasks.register("greetingTask") {
    doFirst {
        println("タスクの最初に実行されます")
    }
    doLast {
        println("タスクの最後に実行されます")
    }
}

6. よくある使い道の例

カスタムタスクは、次のような場面で使われることが多いです。

特定のファイルを自動でコピーする
古いファイルを削除する
アプリのバージョンを表示する
開発者に向けてメッセージを出す

たとえば、次のタスクはプロジェクトのルートディレクトリを表示するだけの例です。


tasks.register("printProjectDir") {
    doLast {
        println("プロジェクトのディレクトリ: ${project.projectDir}")
    }
}

7. グループと説明（description）の活用

Gradleのカスタムタスクには、groupやdescriptionを設定することで、一覧表示されたときにどんな目的のタスクか分かりやすくなります。

groupはカテゴリ分けのようなもの、descriptionはそのタスクの説明文です。

例えば：


tasks.register("infoTask") {
    group = "情報"
    description = "プロジェクトに関する情報を表示します"
    doLast {
        println("Kotlinバージョン: ${project.kotlinDslPluginOptions}")
    }
}