Gradle タスクについて
Gradle タスクを直接扱うことはめったになく、ほとんどの場合、新しいTaskはプラグインの一部として、またはライブラリの「開始方法」ガイドからコピーして貼り付けたコードとして追加されます。タスクの仕組み、構造、ライフサイクルを理解していない開発者は、たとえ改善の余地があるとしても、それらのタスクに変更を加えることを避ける可能性が高くなります。
この記事では、Gradle タスクとは何か、それらがどのように作成および使用されるか、どのような形式を取ることができるかを理解してみましょう。
について知っておくべき基本事項Task:
- A
Taskは一連のアクションを含む実行可能なコードです。 - アクションはおよびクロージャ
Taskを介してa に追加されます。doFirst{}doLast{} - を実行すると、使用可能なタスクのリストにアクセスできます
./gradlew tasks。
この記事では、Android プロジェクトまたは Gradle ラッパーを含むその他のプロジェクトでコードをテストしている場合、タスク X を実行することは./gradlew X、Mac またはgradlew.bat XWindows 上で実行することを意味します。
タスクはどのように見えますか?
既にご存知かもしれませんが、Gradle ではさまざまな形で物事が行われ、Task も例外ではありません。タスク定義はさまざまな方法で行うことができますが、最も一般的なのは次のような方法です。
上記から実行する taskName1と、出力はそれほど明白ではありません。
> Configure project :app
Why is this printed first?
> Task :app:taskName
First?
Last?
上記のコードはより説明的で、それ自体が物語っています。ご覧のとおりcreate()、プロジェクトのTaskContainerオブジェクトを呼び出してtasksから、新しく作成した のグループ プロパティを構成し、Taskアクションをリストに追加します。
taskName1もう一度実行して、出力を見てみましょう。
> Configure project :app
Why is this printed first?
Why is this printed first?
> Task :app:taskName
First?
Last?
ビルドのライフサイクルとフェーズ
上で宣言したタスクとは異なり、ほとんどのタスクは互いに依存しています。タスクを実行するには、Gradle はプロジェクトで使用可能なタスクと、タスクの依存関係を理解する必要があります。そのために、Gradle は有向非循環依存グラフを作成し、それに従ってタスクを実行します。
有向非循環依存グラフという用語にショックを受けないでください。それが意味するのは、次のことだけです。
- タスクとその依存関係は、ノードがタスクを表し、頂点/線が依存関係を表すグラフ構造に構成されます。
- 頂点の方向は、あるタスクが他のタスクにどのように依存しているかを表します。
- 非循環とは、タスク A と B が直接的または推移的に相互に依存するようなタスクがないことを意味します。
Settings初期化 — ファイルに従ってオブジェクトを作成することから始まりsettings.gradle、Gradle プロジェクトに含まれるサブプロジェクト (Android Studio ではモジュールと呼ばれる) の階層を構築します。- 構成 — 初期化フェーズで検出された各プロジェクトを構成し、それぞれの
build.gradleファイルに移動してProjectインスタンスを構成し、ターゲット タスクが直接的または推移的に依存するタスクのグラフを作成します。 - 実行 — タスクを実行し、すべてのタスクは実行されたタスクに依存します。これは、構成フェーズから認識されます。
これは回避できますか?
はい、そのために、Gradle には構成回避 APIがあります。Taskこれは、インスタンスを直接操作するのを避け、代わりに を使用して実行しTaskProvider、 への参照を作成することで構成時間を短縮するのに役立つタスクを作成するための推奨される方法ですTask。
を使用TaskContainer.register()すると、登録されたタスクが直接実行されるか、実行中のタスクの依存関係グラフに含まれていない限り、タスクが構成フェーズに含まれなくなります。
もう一度実行してみtaskName1て、出力が を追加する前と同じであることを確認してくださいtaskName3。同時に、 を実行するとtaskName3、ログの構成部分にもう 1 行追加されます。taskName2taskName1
> Configure project :app
Why is this printed first?
Why is this printed first?
Why is this printed first?
> Task :app:taskName
First?
Last?
Action を正しい実行順序に配置するだけでは十分でないのはなぜですか? なぜ and が必要なdoFirst{}のdoLast{}ですか?
ここで、これらのクロージャを X の前後に実行するものとして扱います。では、X とは何でしょう?
これに答えるために、簡単なタスク クラスを定義し、新しく作成したタスク クラスのタスクを実行して、タスクを定義するもう 1 つの方法を示します。
ログの構成関連の部分を脇に置くと、新しく定義されたタイプの両方のタスクの出力は次のようになります。
> Task :app:taskName5
First?
Before and after actions annotated with @TaskAction
Last?
コード スニペット 4 からわかるように、 CustomTaskTypeextendsDefaultTaskクラスは、カスタム タスク クラスを実装するために拡張できる基本クラスです。Gradle には、Gradle の Github で見つけることができる、すぐに使える便利なタスク タイプがいくつかあります。
Gradle タスクについて他に知っておくべきことはありますか?
Taskには、ビルド プロセス中にタスクで何が起こったかを示す結果があります。直観的に、タスクには 3 つの結果 (実行されない、キャッシュされた結果を使用して実行される、実行されるだけ) があると推測できます。
Gradle には、5 つのタスクの結果があります。
NO-SOURCE— タスクの実行に必要な入力データが見つからなかったため、タスクは実行されません。入力の例としては、 で注釈が付けられ、前のタスクによって生成されなかっ@InputFiles@SkipWhenEmptyたファイルが挙げられます。@IncrementalSKIPPED— 何らかの理由でスキップされました。そのような理由は、タスクの本体でタスクとしてマークされているか、コマンドライン引数やその他のいくつかenabled = falseを介して実行プロセスから除外されているタスクです。-xUP-TO-DATE— タスクの結果は最後のビルドから変更されておらず、再利用できます。これは、インクリメンタル ビルド機能の一部として発生します。FROM-CACHE— タスクは以前のビルドから取得できます。タスク出力キャッシュと呼ばれる機能を使用します。UP-TO-DATEこれは、CI からリモート キャッシュを取得することでリモート キャッシュを再利用できるため、で使用されるインクリメンタル ビルドの進歩です。タスクを実行するときにフラグを使用するか使用org.gralde.caching=trueしない限り、これはビルドに適用されません。タスクをキャッチ可能にするには、 として注釈を付ける必要があります。gradle.properties--build-cache@CacheableTaskEXECUTED— タスクが正常に実行されました。このラベルはログには表示されません。
./gradlew assembleDebug --console=plain
タスクの順序と依存関係
は他のタスクに依存する可能性があると述べられていTaskますが、コードではどのように見えるでしょうか? 以下のこれらの指標は、タスクが相互に依存していることを示しています。
2 つのタスク間の関係を明示的に定義します。
dependsOn—task X { dependsOn Y }、タスク X の実行にはタスク Y が必要であり、Y の実行に失敗した場合、X の実行は行われません。finalizedBy—task X { finalizedBy Y }タスク Y は、X が実行に失敗したりスキップされたりした場合でも、タスク X の後に実行されます。
@OutputFileそして@InputFile— タスクの入力と出力に注釈を付けることによって依存関係を作成する暗黙の方法です。このアプローチでは、入力と出力が一致するタスクを構成する必要があります。
タスクはさまざまな方法で定義できますが、すべてが同じように優れているわけではありません。設定時は設定回避APIを利用し、 を使ってタスクを登録しTaskContainer.register()ます。
結果を理解しTaskてビルドの弱点を特定し、タスク間の依存関係を適切に構造化し、インクリメンタル ビルドとタスク出力キャッシュ メカニズムを機能させることで、可能な場合はタスクの実行結果をキャッシュすることをお勧めします。
Want to Connect?
Connect with me on Twitter and LinkedIn.
![とにかく、リンクリストとは何ですか?[パート1]](https://post.nghiatu.com/assets/images/m/max/724/1*Xokk6XOjWyIGCBujkJsCzQ.jpeg)



































