Gradle’ı Anlamak (Tasks) - Jendrik Johannes (ÇEVİRİ) PART 4

Serinin Diğer İçerikleri:

Diğer içerikleri görüntülemek için linke tıklayın.

Benim Notum: Register and configure tasks:

Bir görev (task), bir build’in gerçekleştirdiği bazı bağımsız iş birimlerini temsil eder. Görevler (Tasks), sınıfların derlenmesi, JAR oluşturma, Javadoc oluşturma, birim testlerinin (unit tests) çalıştırılması veya bir WAR dosyasının sıkıştırılması (zipping up a WAR file) gibi bazı temel işleri gerçekleştirir. Görevler genellikle pluginlerde tanımlanmış olsa da, görevleri build script’lerde kaydetmeniz (register) veya yapılandırmanız gerekebilir. Özetle görevler ya build script’lerden ya da pluginlerden gelir. ^{1 2}

Bir kullanıcı komut satırında ./gradlew build komutunu çalıştırdığında Gradle, build görevini, bağlı olduğu diğer görevlerle birlikte yürütür.

Bir görevin kaydedilmesi (registering), görevi projenize ekler.

TaskContainer.register(java.lang.String) yöntemini kullanarak görevleri bir projeye kaydedebilirsiniz:

1
2
3
4
5
6
tasks.register<Zip>("zip-reports") {
  from 'Reports/'
  include '*'
  archiveName 'Reports.zip'
  destinationDir(file('/dir'))
}

Kaçınılması gereken TaskContainer.create(java.lang.String) yönteminin kullanımını görmüş olabilirsiniz:

1
2
3
4
5
6
tasks.create<Zip>("zip-reports") {
  from 'Reports/'
  include '*'
  archiveName 'Reports.zip'
  destinationDir(file('/dir'))
}

Görev yapılandırmasından kaçınmayı sağlayan “register()”, “create()” yerine tercih edilir.

Yapılandırmak için bir görevin yerini “TaskCollection.named(java.lang.String)” yöntemini kullanarak saptayabilirsiniz. İlgili görevi, oluşturulmasını veya yapılandırılmasını tetiklemeden ada (name) göre bulur; böyle bir nesne yoksa başarısız olur.

1
2
3
tasks.named<Test>("test") {
  useJUnitPlatform()
}

Aşağıdaki örnek, Javadoc görevini, Java kodundan otomatik olarak HTML belgeleri oluşturacak şekilde yapılandırır:

1
2
3
4
5
tasks.named("javadoc").configure {
  exclude 'app/Internal*.java'
  exclude 'app/internal/*'
  exclude 'app/internal/*'
}

Task registration and action

1
2
3
4
5
6
//build.gradle.kts
tasks.register("hello") {
  doLast {
    println("Hello world!")
  }
}

Örnekte, build script, TaskContainer API’yi kullanarak “hello” adlı tek bir görevi kaydeder (register) ve ona bir eylem (action) ekler. Aslında, TaskContainer, bir dizi Task örneğinin yönetilmesinden sorumludur. Bir TaskContainer örneğini Project.getTasks()‘ı çağırarak veya build script‘inizde tasks özelliğini (property) kullanarak elde edebilirsiniz. Bu link aracılığı ile tüm özellikleri (properties) görüntüleyebilirsiniz.

Projedeki görevler (tasks) listelenmişse, hello görevi Gradle tarafından kullanılabilir:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
$ ./gradlew app:tasks --all

> Task :app:tasks

------------------------------------------------------------
Tasks runnable from project ':app'
------------------------------------------------------------

Other tasks
-----------
compileJava - Compiles main Java source.
compileTestJava - Compiles test Java source.
hello
processResources - Processes main resources.
processTestResources - Processes test resources.
startScripts - Creates OS-specific scripts to run the project as a JVM application.

build script’deki görevi ./gradlew hello komutu ile yürütebilirsiniz:

1
2
$ ./gradlew hello
Hello world!

Gradle hello görevini yürüttüğünde, sağlanan eylemi (action) yürütür. Bu örnekte, eylem (action) basit bir kod içeren bir bloktur: println("Hello world!").

Task group and description

Az önce ele alınan hello görevi, bir açıklamayla (description) detaylandırılabilir ve aşağıdaki güncellemeyle bir gruba (group) atanabilir:

1
2
3
4
5
6
7
8
9
//build.gradle.kts

tasks.register("hello") {
  group = "Custom"
  description = "A lovely greeting task."
  doLast {
    println("Hello world!")
  }
}

Görev bir gruba atandığında “./gradlew tasks” tarafından listelenecektir.

1
2
3
4
5
6
7
$ ./gradlew tasks

> Task :tasks

Custom tasks
------------------
hello - A lovely greeting task.

Bir görevle ilgili bilgileri görüntülemek için “help --task <görev-adı>” komutunu kullanın:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
$./gradlew help --task hello

> Task :help
Detailed task information for hello

Path
:app:hello

Type
Task (org.gradle.api.Task)

Options
--rerun     Causes the task to be re-run even if up-to-date.

Description
A lovely greeting task.

Group
Custom

Gördüğümüz gibi hello görevi custom grubuna aittir.

Benim Notum:

Görüleceği üzere Help tasks‘lara ek olarak Build tasks, Verification tasks ve Rules‘un çıktıya eklendiğini görüyoruz. Bu ek görevler gradle core plugin olan “base” plugin aracılıyla gelmektedir.

“Base Plugin”, çoğu “build” için ortak olan bazı görevleri ve “kuralları (conventions)” sağlar ve build’e bunların çalıştırılma şekli konusunda tutarlılığı destekleyen bir yapı (structure) ekler. En önemli katkısı, diğer eklentiler ve “build” yazarları tarafından sağlanan daha spesifik görevler için bir “şemsiye (umbrella)” görevi gören bir dizi “yaşam döngüsü görevleri”dir (lifecycle tasks).

Base plugin’in bir başka kullanımı da bu şekildedir.

1
2
3
4
5
6
7
8
// kotlin
plugins {
    base
}
// groovy
plugins {
    id 'base'
}

Tasks (Görevler)

• clean — Delete “build” dizinini ve içindeki her şeyi, yani “layout.buildDirectory” proje özelliği tarafından belirtilen yolu (path) siler.
• check — lifecycle task Pluginler ve “build” yazarları, testleri çalıştıranlar gibi doğrulama görevlerini “check.dependsOn(task)” kullanarak bu yaşam döngüsü görevine eklemelidir.
• assemble — lifecycle task Pluginler ve “derleme” yazarları, bu “yaşam döngüsü (lifecycle)” görevine dağıtımlar (distributions) ve diğer tüketilebilir artifaktleri üreten görevleri eklemelidir. Örneğin, “jar”, Java kitaplıkları için tüketilebilir artifakt üretir. “assemble.dependsOn(task)” komutunu kullanarak görevleri bu yaşam döngüsü (lifecycle) görevine ekleyin.
• build — lifecycle task (check ve assemble görevlerine bağlıdır.) Tüm testlerin yürütülmesi, üretim artifaktlerinin (production artifacts) üretilmesi ve belgelerin (documentation) oluşturulması da dahil olmak üzere her şeyin build edilmesi amaçlanmaktadır. “assemble” ve “check” tipik olarak daha uygun olduğundan, muhtemelen somut görevleri doğrudan build’e nadiren ekleyeceksiniz.
• buildConfiguration — task rule İsimlendirilmiş konfigürasyona (named configuration) eklenen artifaktleri birleştirir. Örneğin, “buildRuntimeElements”, “runtimeElements” yapılandırmasına eklenen herhangi bir artifakti oluşturmak için gereken her görevi yürütecektir.
• cleanTask — task rule Bir görevin tanımlanmış çıktılarını (defined outputs) kaldırır; ör. “cleanJar”, “Java Plugin”in “jar” görevi tarafından üretilen “JAR” dosyasını silecektir.

BAĞIMLILIK YÖNETİMİ (Dependency management)

“Base Plugin” bağımlılıklar (dependencies) için hiçbir yapılandırma eklemez ancak aşağıdaki yapılandırmaları ekler:

• default “Bağımlılık çözümlemesi (dependency resolution)” istek öznitelikleri (request attributes) olmadan gerçekleştirildiğinde kullanılan bir “geri dönüş (fallback)” yapılandırmasıdır. Yeni build’ler ve plugin’ler, “default” yapılandırmayı kullanmamalıdır! Yalnızca geriye dönük uyumluluk (backwards compatibility) için varlığını sürdürür. Bağımlılık çözümlemesi (dependency resolution) istek öznitelikleriyle (request attributes) gerçekleştirilmelidir.
• archives “archives” yapılandırmasında tanımlanan tüm artifaktler, “assemble” görevi tarafından otomatik olarak oluşturulur (build edilir). Yeni “build’ler” ve “pluginler”, “archives” yapılandırmasını kullanmamalıdır! Yalnızca geriye dönük uyumluluk (backwards compatibility) için varlığını sürdürür. Bunun yerine, görev bağımlılıkları (task dependencies) doğrudan “assemble” görevinde bildirilmelidir.

KATKIDA BULUNAN UZANTILAR (Contributed extensions)

“Base Plugin”, projeye “base” uzantısını ekler. Bu, tahsis edilmiş (dedicated) bir DSL bloğu içinde aşağıdaki özelliklerin (properties) yapılandırılmasına olanak tanır.

build.gradle.kts

1
2
3
4
5
base {
    archivesName = "gradle"
    distsDirectory = layout.buildDirectory.dir("custom-dist")
    libsDirectory = layout.buildDirectory.dir("custom-libs")
}

• archivesName — default: $project.name “archive” görevleri için varsayılan “AbstractArchiveTask.getArchiveBaseName()” değerini sağlar.
• distsDirectory — default: layout.buildDirectory.dir(“distributions”) Dağıtım arşivlerinin (distribution archives), yani JAR olmayanların oluşturulduğu dizinin varsayılan adıdır.
• libsDirectory — default: layout.buildDirectory.dir(“libs”) Kütüphane arşivlerinin (library archives), yani JAR’ların oluşturulduğu dizinin varsayılan adıdır.

Plugin ayrıca “AbstractArchiveTask“ı genişleten herhangi bir görevde (task) aşağıdaki özellikler (properties) için varsayılan değerler sağlar:

• destinationDirectory JAR olmayan arşivler (non-JAR archives) için varsayılan olarak “distsDirectory”, JAR’lar ve WAR’lar gibi JAR türevleri için “libsDirectory“dir.
• archiveVersion Projenin sürümü (version) yoksa varsayılan olarak “$project.version” veya ‘belirtilmemiş (unspecified)’ olur.
• archiveBaseName Varsayılan olarak $archivesBaseName‘dir.

Benim Notum:

“Java Plugin”, görevlerinden bazılarını, Java Eklentisinin otomatik olarak uyguladığı “Base Plugin” tarafından tanımlanan “yaşam döngüsü (lifecycle)” görevlerine ekler ve ayrıca birkaç “yaşam döngüsü (lifecycle)” görevi daha ekler. ³ Benim anladığım üzere burada, tıpkı Java Library Plugin’in Java Plugin’i genişletmesi gibi bir durum var. Yani Java Plugin, Gradle Base Plugin’i genişletiyor.

Benim Notum:

Önceki “build run” sonuçlarını yeniden kullanın

Örneğin, projemizde yalnızca test kodunu değiştirip, üretim (production) koduna dokunmazsak, build’ı çalıştırmak yalnızca test kodunu yeniden derleyecektir, ancak Gradle tarafından “UP-TO-DATE” (yani güncel) olarak işaretlenen production kodunu değiştirmeyecektir.

Şimdi sırasıyla production kodunda sonrasında da test kodunda bir sınıf oluşturup çıktıları aşama aşama inceleyelim.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
% gradle :app:build --console=plain
> Task :my-build-logic:java-plugins:checkKotlinGradlePluginConfigurationErrors
> Task :my-build-logic:java-plugins:generateExternalPluginSpecBuilders UP-TO-DATE
> Task :my-build-logic:java-plugins:extractPrecompiledScriptPluginPlugins UP-TO-DATE
> Task :my-build-logic:java-plugins:compilePluginsBlocks UP-TO-DATE
> Task :my-build-logic:java-plugins:generatePrecompiledScriptPluginAccessors UP-TO-DATE
> Task :my-build-logic:java-plugins:generateScriptPluginAdapters UP-TO-DATE
> Task :my-build-logic:java-plugins:compileKotlin UP-TO-DATE
> Task :my-build-logic:java-plugins:compileJava NO-SOURCE
> Task :my-build-logic:java-plugins:pluginDescriptors UP-TO-DATE
> Task :my-build-logic:java-plugins:processResources UP-TO-DATE
> Task :my-build-logic:java-plugins:classes UP-TO-DATE
> Task :my-build-logic:java-plugins:jar UP-TO-DATE
- > Task :app:compileJava
> Task :app:processResources NO-SOURCE
> Task :app:classes
> Task :app:jar
> Task :app:assemble
- > Task :app:compileTestJava NO-SOURCE
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses UP-TO-DATE
> Task :app:test NO-SOURCE
> Task :app:check UP-TO-DATE
> Task :app:build

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 % gradle :app:build --console=plain
> Task :my-build-logic:java-plugins:checkKotlinGradlePluginConfigurationErrors
> Task :my-build-logic:java-plugins:generateExternalPluginSpecBuilders UP-TO-DATE
> Task :my-build-logic:java-plugins:extractPrecompiledScriptPluginPlugins UP-TO-DATE
> Task :my-build-logic:java-plugins:compilePluginsBlocks UP-TO-DATE
> Task :my-build-logic:java-plugins:generatePrecompiledScriptPluginAccessors UP-TO-DATE
> Task :my-build-logic:java-plugins:generateScriptPluginAdapters UP-TO-DATE
> Task :my-build-logic:java-plugins:compileKotlin UP-TO-DATE
> Task :my-build-logic:java-plugins:compileJava NO-SOURCE
> Task :my-build-logic:java-plugins:pluginDescriptors UP-TO-DATE
> Task :my-build-logic:java-plugins:processResources UP-TO-DATE
> Task :my-build-logic:java-plugins:classes UP-TO-DATE
> Task :my-build-logic:java-plugins:jar UP-TO-DATE
- > Task :app:compileJava UP-TO-DATE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar UP-TO-DATE
> Task :app:assemble UP-TO-DATE
- > Task :app:compileTestJava UP-TO-DATE
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses UP-TO-DATE
> Task :app:test UP-TO-DATE
> Task :app:check UP-TO-DATE
> Task :app:build UP-TO-DATE

Şekilde görüldüğü gibi sadece src/test/java/Test.java sınıfında bir değişiklik yapıyoruz.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
% gradle :app:build --console=plain
> Task :my-build-logic:java-plugins:checkKotlinGradlePluginConfigurationErrors
> Task :my-build-logic:java-plugins:generateExternalPluginSpecBuilders UP-TO-DATE
> Task :my-build-logic:java-plugins:extractPrecompiledScriptPluginPlugins UP-TO-DATE
> Task :my-build-logic:java-plugins:compilePluginsBlocks UP-TO-DATE
> Task :my-build-logic:java-plugins:generatePrecompiledScriptPluginAccessors UP-TO-DATE
> Task :my-build-logic:java-plugins:generateScriptPluginAdapters UP-TO-DATE
> Task :my-build-logic:java-plugins:compileKotlin UP-TO-DATE
> Task :my-build-logic:java-plugins:compileJava NO-SOURCE
> Task :my-build-logic:java-plugins:pluginDescriptors UP-TO-DATE
> Task :my-build-logic:java-plugins:processResources UP-TO-DATE
> Task :my-build-logic:java-plugins:classes UP-TO-DATE
> Task :my-build-logic:java-plugins:jar UP-TO-DATE
- > Task :app:compileJava UP-TO-DATE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar UP-TO-DATE
> Task :app:assemble UP-TO-DATE
- > Task :app:compileTestJava
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses
> Task :app:test
> Task :app:check
> Task :app:build

Değişiklik yapmadığım src/main/java/Test.java sınıfını derlemek için kullanılan task, compileJava UP-TO-DATE olarak etiketli kalırken, src/test/java/Test.java sınıfını derlemek için kullanılan compileTestJava görevi etiketsiz kalmaktadır. Bu, ilgili görevin yeniden çalıştırıldığının bir işaretidir.

Benim Notum:

Task dependencies

Diğer görevlere bağlı olan görevleri bildirebilirsiniz:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
//build.gradle.kts

tasks.register("hello") {
  doLast {
    println("Hello world!")
  }
}
tasks.register("intro") {
  dependsOn("hello")
  doLast {
    println("I'm Gradle")
  }
}

1
2
3
$ gradle -q intro
Hello world!
I'm Gradle

taskX‘in taskY‘ye bağımlılığı, taskY tanımlanmadan önce bildirilebilir:

1
2
3
4
5
6
7
8
9
10
11
12
13
//build.gradle.kts

tasks.register("taskX") {
  dependsOn("taskY")
  doLast {
    println("taskX")
  }
}
tasks.register("taskY") {
  doLast {
    println("taskY")
  }
}

1
2
3
$ gradle -q taskX
taskY
taskX

Önceki örnekteki hello görevi bir bağımlılık içerecek şekilde güncellendi:

1
2
3
4
5
6
7
8
9
10
//build.gradle.kts

tasks.register("hello") {
  group = "Custom"
  description = "A lovely greeting task."
  doLast {
    println("Hello world!")
  }
  dependsOn(tasks.assemble)
}

hello görevi artık assemble görevine bağlıdır; bu, Gradle’ın hello görevini yürütmeden önce assemble görevini yürütmesi gerektiği anlamına gelir:

1
2
3
4
5
6
7
8
9
10
11
12
13
$ ./gradlew :app:hello

> Task :app:compileJava UP-TO-DATE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar UP-TO-DATE
> Task :app:startScripts UP-TO-DATE
> Task :app:distTar UP-TO-DATE
> Task :app:distZip UP-TO-DATE
> Task :app:assemble UP-TO-DATE

> Task :app:hello
Hello world!