KSPで自動生成コードを作る

KSPの概要、使い方について簡単に説明したスライドです。

Transcript

1. KSPで 自動生成コードを作る 起塚　亮
2. 起塚　亮 自己紹介 岡山大学工学部 24卒 Androidエンジニア 趣味：刀鑑賞、麻雀、プログラミング @bugdog24
3. KSPとは
4. - Kotlin Symbol Processingの略 - コンパイラプラグイン用API - コードの自動生成プログラムを 書くときに利用
5. コンパイル
6. コンパイル etc…
7. etc… コンパイル 既存ファイル 読み取り
8. コンパイル etc… コード生成して ファイル追加
9. コンパイル etc… 生成しなくなるまで ラウンドを回す
10. etc… 全てのファイルを コンパイル コンパイル
11. コンパイル etc…
12. KSPの利点 高速 Kaptよりも2倍近い速度で動作可能 実装コスト シンプルなAPIセットで構成 バージョン間の互換性 Kotlinのバージョンが違っても動作可能
13. 作ってみる
14. Compose用ViewModelFactory 生成プログラム
15. 一見便利だが引数があると・・・
17. - ボイラーコードを書く必要がある - 引数を追加するたびに書き直す必要あり - コンパイル時に気づけない
18. これを付けることで対応する Factoryを生成するようにする
19. 1. 依存関係を追加 2. SymbolProcessorを実装 3. SymbolProcessorProviderを実装 4. Meta-INFに登録
20. 2. SymbolProcessorを実装 3. SymbolProcessorProviderを実装 4. Meta-INFに登録 1. 依存関係を追加
22. 1. 依存関係を追加 3. SymbolProcessorProviderを実装 4. Meta-INFに登録 2. SymbolProcessorを実装
24. 毎ラウンド呼ばれる処理 引数のResolverから各ファイルにアクセス可能
25. 生成終了時の処理を記述
26. プロセッサーがエラーを投げた時の処理を記述 ＊他のプロセッサーがエラーを投げても 呼び出される
27. 今回の用途だと process関数だけ実装でOK!
29. 指定されたアノテーションのついた要素を取得
30. 処理出来るものと出来ないものを分ける
31. 依存
32. 依存 自動生成されるコードだとすると？
33. 依存 スーパークラスを参照できない😭
34. 依存 次のラウンドだと存在するかも？ ?
35. 直接関連する要素が参照可能かどうか 検証してくれる
36. 生成コードを作る
37. ファイルに書き出す
38. どのファイルが変更されたら コードの再生成を行うか指定
39. 生成
40. 生成 変更 再生成
41. 生成 変更
42. ビルド時間を短縮
43. 関連するファイル群 可変長引数で指定
44. aggregating？🤔
45. 生成 変更
46. 生成 変更 aggregating = trueの時 関係ないファイルの変更 でも再生成される
47. 生成 変更 aggregating = falseの時 関係ないファイルの変更 では再生成されない（isolate）
48. 基本はfalseでOK!
49. 他のファイル変更時に 再生成するかどうか
50. パッケージ名、ファイル名の指定
51. コードを出力（outputStream）
52. 処理しなかった要素を返す
54. 2. SymbolProcessorを実装 1. 依存関係を追加 4. Meta-INFに登録 3. SymbolProcessorProviderを実装
56. 先ほど作ったクラスを インスタンス化するだけ
57. 2. SymbolProcessorを実装 1. 依存関係を追加 3. SymbolProcessorProviderを実装 4. Meta-INFに登録
60. 完成🤩 動かしてみる
65. 自動生成された関数
66. 対応状況
67. - Room - RxHttp - Koin Annotations - Epoxy 対応済み
68. - Room - RxHttp - Koin Annotations - Epoxy 対応済み Dagger Hiltは未対応
69. そのうちKaptからKSPに完全移行されるはず
70. ご清聴 ありがとうございました！