Gradleまなびなおし

■ イベント
After Kotlin Fest 2024 LT Night
https://sansan.connpass.com/event/320810/

■ 発表者
Bill One Engineering Unit
江川 綾

■ Bill One 開発エンジニア 採用情報
https://media.sansan-engineering.com/billone-engineer

Transcript

1. Sansan株式会社 部署 名前 Gradleまなびなおし Sansan技術本部 Sansan技術本部 Bill One Engineering Unit 江川 綾
2. 写真が入ります 江川 綾 Sansan株式会社 技術本部 Bill One Engineering Unit 2021年 Sansan新卒⼊社。 ⼊社以来、Webアプリケーション開発エンジニアとして インボイス管理サービス「Bill One」の開発に従事。 現在は、Bill Oneにおける請求書受領領域の開発に加えて、 フロントエンドの技術的な改善をリードしている。 @erm1116_ @erm1116
3. Kotlin Festに参加して、 Server-Side Kotlinをやりたくなった！！ そんな⽅も多いのではないでしょうか
4. Ktorのサンプルプロジェクトを作る 3 Ktor: Project Generator
5. すると、⼤量のコードが⽣成される 4
6. 俺たちは雰囲気でGradleを使っている 5
7. - Gradleの基礎をおさえる - Gradleの読み⽅を理解して、 ⾃⾝で簡単なプロジェクトを構築できるようになる 本⽇のLTのゴール
8. - Gradleとは - Gradleの基本的な概念 - Gradleのビルドを理解する - Gradleの構成⽅法を学ぶ アジェンダ
9. Gradleとは
10. “Gradle Build Tool is a fast, dependable, and adaptable open-source build automation tool with an elegant and extensible declarative build language.” Gradle User Manual - オープンソースのビルド⾃動化ツール - JVM系の⾔語（Java, Kotlinなど）のビルドツールとして利⽤される - プラグインシステムが充実しており、任意のビルドフローを構築できる - 設定ファイルをKotlin DSL / Groovy DSLにて記述できる - インクリメンタルビルド、ビルドキャッシュ、並列実⾏などにより ビルドを⾼速化できる Gradleとは
11. Gradleの基本的な概念
12. Gradleの基本的な概念 - Projects - Build Scripts - Dependency Management - Tasks - Plugins
13. Gradleの基本的な概念 - Projects - Gradleによるビルド対象となるアプリケーション・ライブラリのこと - ビルド対象は単⼀・複数のいずれでもOK - Build Scripts - Dependency Management - Tasks - Plugins
14. Gradleの基本的な概念 - Projects - Build Scripts - build.gradle(.kts)のこと - 各プロジェクトは1つ以上のBuild Scriptを含んでいる - Dependency Management - Tasks - Plugins
15. Gradleの基本的な概念 - Projects - Build Scripts - Dependency Management - プロジェクトにおける外部への依存を管理する - 依存とはプラグイン・ライブラリなどのことを指す - Version Catalogを利⽤してマルチモジュール構成や パッケージ間のバージョン同期などの管理を実現しやすくする - Tasks - Plugins
16. Gradleの基本的な概念 - Projects - Build Scripts - Dependency Management - Tasks - コンパイル、テスト、ビルドなどの実⾏単位 - 各プロジェクトにおいてはプラグインを利⽤するか、⾃⾝でタスクの定義を ⾏うなどする - Plugins
17. Gradleの基本的な概念 - Projects - Build Scripts - Dependency Management - Tasks - Plugins - プロジェクトに任意のタスクを組み込むことができる - 例） - `application` : アプリケーションの起動 (run) タスクなどを組み込める - `detekt` : detektを⽤いた静的解析タスクを組み込める
18. Gradleのビルドを理解する
19. 3つのフェーズに分けて実⾏される 1. Initialization - settings.gradle(.kts)の特定 → Settings インスタンスを作成 - ビルド対象となるプロジェクトの特定 → Projectインスタンスを作成 1. Configuration - Projectにおけるビルドスクリプト（build.gradle(.kts)）の評価 → タスクの依存グラフを構築 1. Execution - 依存グラフに則り、並列でタスク実⾏ Gradleのビルドライフサイクル
20. buildタスク⾃体は Base プラグイン にて登録されている ここに Java Plugin や Kotlin JVM Plugin が必要なタスクを追加することで ビルドを実現している buildタスクを理解する Java Pluginによるタスクの依存グラフ（The Java Plugin）
21. - Gradleは、前回のタスク実⾏から⼊⼒が変化していない場合に タスク実⾏⾃体をskipしてくれる（前回ビルド時の結果をリプレイする） - --console=verboseオプションで各タスクの実⾏結果が確認できる インクリメンタルビルド (Incremental Build) インクリメンタルビルドにより出⼒を復元できている(UP-TO-DATE)
22. - Cache keyに対してタスクの実⾏結果を保持しており、 結果の復元が可能な場合はタスク実⾏をskipする - 例えば、ブランチ切り替えでローカルの状態が変わるときに実⾏skipできる - CLIオプション or gradle.propertiesから明⽰的に有効にする必要あり ビルドキャッシュ (Build Cache) ビルドキャッシュから出⼒を復元できている(FROM-CACHE)
23. - Configurationフェーズで⽣成されるタスクの依存グラフに関する情報を キャッシュとして保存し、その後の実⾏時にConfigurationフェーズをskip する - CLIオプション or gradle.propertiesから明⽰的に有効にする必要あり - ⼀部未対応のプラグインがあるので有効にできない場合もある コンフィギュレーションキャッシュ (Configuration Cache) Incremental Buildに加え、Configuration Cacheを有効にすることでタスクの実⾏時間が減っている
24. Gradleの構成⽅法を学ぶ
25. - Kotlin / Ktorのサーバーアプリケーション（app）と 共通ライブラリ（lib）のマルチモジュール構成 - Gradleの設定ファイルにはKotlin DSLを利⽤ - サンプルリポジトリ: gradle-relearning-sample-repo 今回構成するアプリケーション
26. 全体の構成 Root Project: ktor-sample setting.gradle.kts app lib build.gradle.kts build.gradle.kts 依存
27. 全体の構成 Root Project: ktor-sample setting.gradle.kts app lib build.gradle.kts build.gradle.kts プロジェクトの全体構成を管理 ビルドスクリプトを管理 タスクや依存関係はここで管理される 依存
28. 全体の構成 Root Project: ktor-sample setting.gradle.kts app lib build.gradle.kts build.gradle.kts 依存
29. settings.gradle.kts Root Project: ktor-sample setting.gradle.kts app lib build.gradle.kts build.gradle.kts 依存 読み込むプロジェクトを宣⾔
30. app/build.gradle.kts Root Project: ktor-sample setting.gradle.kts app lib build.gradle.kts build.gradle.kts 依存 libを依存先として指定
31. アプリケーションコード
32. - appモジュールからlibモジュールを利⽤する、Ktorアプリケーションが起 動できた - 実際には、各モジュールのタスクをどう定義するかだったり、 マルチモジュールにおいて共通のロジックをどう定義するかなどは 考える必要がある Ktor Serverを動かしてみる
33. まとめ
34. - Gradleの基本的な概念と構成をおさえることでGradleファイルの読み⽅ を理解した - 今回の内容は Authoring Guide にまとまってあるので、Gradleの環境構築 する⼈は⼀度⽬を通しておくと良さそう - Gradleを理解して、みんなでKotlinはじめていきましょう！！ まとめ
35. Sansan 技術本部 募集ポジション紹介 https://media.sansan-engineering.com/