Groovy & Gradle: JVM Automation and Build Engineering · レッスン

カスタムタスクの定義

GroovyまたはKotlin DSLを使って独自のGradleタスクを記述し、特定のビルド手順を自動化します。

「カスタムタスクの定義」はCoddyKit上の無料Groovy & Gradle: JVM Automation and Build Engineeringレッスンです。これはレッスン1/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはGroovy & Gradle: JVM Automation and Build Engineering学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Groovy & Gradle: JVM Automation and Build Engineeringコースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

Custom Tasks: Why & How?

Why define your own Gradle tasks? They let you automate unique steps not covered by standard plugins. Think of custom tasks as recipes for specific build actions.

This lesson will show you how to craft them to extend Gradle's capabilities!

Your First Custom Task

The simplest way to create a custom task is directly in your build.gradle file. Use the task keyword followed by your task's name.

Let's create a task named helloCustom:

// build.gradle
task helloCustom {
    doLast {
        println 'Hello from a custom task!'
    }
}

Task Actions: doLast & doFirst

Tasks can have multiple actions. You can define them using doFirst and doLast blocks. These blocks specify code to run before or after the task's main actions.

// build.gradle
task orderedActions {
    doFirst {
        println 'This runs first!'
    }
    doLast {
        println 'This runs last!'
    }
    doLast { // Can have multiple doLast/doFirst
        println 'This runs after the previous doLast!'
    }
}

Beyond Inline: Custom Task Classes

For more complex logic or reusability across projects, you'll want to define a custom task as a class. This allows for better organization, testing, and property management.

Encapsulation: Keep task logic in one place.
Reusability: Share tasks between different projects.
Configuration: Define properties for customization.

Writing a Custom Task Class

Custom task classes extend Gradle's DefaultTask. You define the task's actions within a method, often annotated with @TaskAction.

Create a file named src/main/groovy/com/coddykit/tasks/MyGreetingTask.groovy:

package com.coddykit.tasks

import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction

class MyGreetingTask extends DefaultTask {

    @TaskAction
    def greet() {
        println "Hello from MyGreetingTask!"
    }
}

Using Your Custom Task Class

To use your custom task class, you need to tell Gradle where to find it and then register an instance of it. First, add the Groovy plugin to compile your task class.

Update your build.gradle:

// build.gradle
plugins {
    id 'groovy' // To compile Groovy task classes
}

repositories {
    mavenCentral()
}

dependencies {
    // Required for DefaultTask
    implementation gradleApi()
    // If your task uses Groovy
    implementation 'org.codehaus.groovy:groovy-all:3.0.10'
}

// Register our custom task
tasks.register('myGreeting', com.coddykit.tasks.MyGreetingTask)

Executing the Class-Based Task

Now that your custom task class is defined and registered in build.gradle, you can execute it just like any other Gradle task from your terminal.

Run the command:

gradle myGreeting

Task Types vs. Definitions

It's important to distinguish between defining a task type (the class) and defining a task instance (registering it).

Task Type: The MyGreetingTask class itself, which extends DefaultTask. It defines what the task can do.
Task Definition: tasks.register('myGreeting', MyGreetingTask). This creates a specific task named 'myGreeting' of that type.

Custom Task Quiz

You've learned how to create custom tasks. Let's test your understanding!

Defining Custom Tasks Recap

Great job! You've learned how to define custom Gradle tasks:

Inline Tasks: Using task name { doLast { ... } } for simple, script-local actions.
Task Actions: Controlling execution order with doFirst and doLast.
Custom Task Classes: Extending DefaultTask for reusable, organized, and configurable task logic.
Registering Tasks: Using tasks.register() to create instances of your custom task classes.

Next, we'll dive deeper into task types and how to configure properties for more dynamic tasks!

よくある質問

「カスタムタスクの定義」レッスンは無料ですか？

はい。「カスタムタスクの定義」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Groovy & Gradle: JVM Automation and Build Engineeringコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Groovy & Gradle: JVM Automation and Build Engineeringコースには全4レッスンが含まれています。

「カスタムタスクの定義」で何を学びますか？

GroovyまたはKotlin DSLを使って独自のGradleタスクを記述し、特定のビルド手順を自動化します。ブラウザで直接実行するハンズオンコードでGroovy & Gradle: JVM Automation and Build Engineeringを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Groovy & Gradle: JVM Automation and Build Engineeringを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのGroovy & Gradle: JVM Automation and Build Engineeringは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン1/4です。

「カスタムタスクの定義」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このGroovy & Gradle: JVM Automation and Build Engineeringレッスンでコードを書いて実行できますか？

はい。すべてのGroovy & Gradle: JVM Automation and Build Engineeringレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← Groovy & Gradle: JVM Automation and Build Engineeringに戻る