cookpad.apk #4 令和に始めるcode generation 買物事業部 門田福男 

自己紹介 2016年 新卒入社 技術部モバイル基盤グループ→買物事業部 Android エンジニア Twitter: @_litmon_ GitHub : @litmon 

コード自動生成 使ってますか？ 

No content

（おもてたんとちがう・・・） 

No content

コード自動生成 作ってますか？ 

‍♂ （おもてたんとちがう・・・） 

今日のお話 (タイトルで風呂敷を広げてしまったが) 今日はannotationProcessor(kapt)についてしゃべります ● マートアプリで作ったannotationProcessor 

さっそくですがこちらをご覧ください GET /v1/product_tags/100?fields=name,products[id,name] 

さっそくですがこちらをご覧ください GET /v1/product_tags/100?fields=name,products[id,name] 

https://github.com/cookpad/garage 

マートのAPIはgarageで出来ている ● query parameter の fields で指定した値が返ってくる ○ 必要な分だけ取得するというのが出来る ○ (ちょっとGraphQLっぽい) ● JSONをクラスにマッピングするときにはmoshi-kotlinを利用している 

No content

マートのAPIはgarageで出来ている ● query parameter の fields で指定した値が返ってくる ○ 必要な分だけ取得するというのが出来る ○ (ちょっとGraphQLっぽい) ● JSONをクラスにマッピングするときにはmoshi-kotlinを利用している ● fields 文字列は、マッピング先のclassのプロパティと合わせる必要がある 

fields=name,products[id,name] 

fields=.... 

マートのAPIはgarageで出来ている ● query parameter の fields で指定した値が返ってくる ○ 必要な分だけ取得するというのが出来る ○ (ちょっとGraphQLっぽい) ● JSONをクラスにマッピングするときにはmoshi-kotlinを利用している ● fields は、マッピング先のclassのプロパティと合わせる必要がある ● fields をメンテナンスしていくのは非常にめんどくさい ○ fields とPOJOクラスのダブルメンテ…… 

脱線: fields=__default__ garageには fields に特別な文字列( __default__ )を指定できる (各Resourceの必須プロパティを返すようになる) メリット ● 全てのプロパティに対して fields を指定する必要がなくなる 

脱線: fields=__default__ garageには fields に特別な文字列( __default__ )を指定できる (各Resourceの必須プロパティを返すようになる) デメリット ● 必須プロパティが何なのか分からなくなる ○ fields のメンテナンスが困難になる(追加する必要があるのかないのかが分からない) ● 本来は不要なデータもあわせて返ってくるのでgarageのメリットが薄れる 

fields 文字列にはルールがある 非常にシンプルなルール ● 各プロパティ名を , 区切りで列挙していく fields=id,name,... ● ネストした構造のときは [] で囲む fields=id,name,product[id,name,...],... 

ルールがあるということは 機械で作れる 

生成後のコードをイメージする ● まずは、どんなコードが出来てほしいかイメージする ○ 利用シーンから考えてみる ● 生成後のコードを自分で書いてみるのが一番しっくり来る 

No content

● 各プロパティ名を , 区切りで列挙していく 

● ネストした構造のときは [] で囲む 

どう作るかを理解する ● annotationProcessor (kapt) ○ javax.annotation.processing.Processor ○ com.google.auto.common.BasicAnnotationProcessor (今回はこれを使います) ■ ラウンドなどいろいろな処理を簡素に提供してくれるラッパーProcessor ■ https://github.com/google/auto/blob/master/common/src/main/java/com/google/auto/common/BasicAnn otationProcessor.java ● Kotlinコードの生成 kotlinpoet ○ https://github.com/square/kotlinpoet 

● モジュール(generator)を作って、build.gradleを記述 

● 便利ライブラリ(AutoService)を追加 

● 今回はmoshi-kotlinのアノテーションを利用するので依存を追加 (アノテーションも自作する場合はモジュールを分けて定義して おくと良い) 

● Processorクラスを定義 

● AutoService でプロセッサーを自動登録 

● 各ステップを定義 

● ステップの定義 

● 処理を実行するアノテーションを設定 

● この部分にコード生成ロジックを記述していく 

No content

コード生成の流れをイメージする ● JsonClassアノテーションが付与されたクラスに対して ○ コンストラクタに含まれるプロパティの @Json アノテーションを取得する ■ @Json(name = “value”) <- name部分を取得する ○ @Json アノテーションが付与されたプロパティの型を見て ■ primitive タイプであれば => nameをそのまま使う ■ Array, List など => T の部分のプロパティを列挙して [] で囲う ■ その他 => (おそらくネストされたクラスとみなして)ネストしたプロパティを列挙して [] で囲う ○ <クラス名>_fields() メソッドを生成して、上で判定した文字列を返す ● 全ての <クラス名>_fields() メソッドをまとめる fields() メソッドを作る ○ 型引数を与えて、型引数によってメソッドの呼び出しを行う 

● こんな感じのコードを生成する部分の実装 

● @JsonClass アノテーションが付与されたクラスに対して 

● コンストラクタを取得 

● @Json アノテーションを取り出して、 name を取得 

● プロパティの型情報を取得 

● 型に応じて返す値を変える( [] を付けるか付けないか) 

● @JsonClass クラスが付いた子クラスがいると仮定して、生成さ れたメソッドを呼び出し 

● こんな感じのメソッドを生成する部分の実装 

● inline functionを定義 

● reified T はこんな感じでうまくいった 

● when式をガッと作っていく 

● 出来上がったメソッドたちをまとめてファイルに書き出す 

● 使うときは kapt で作ったモジュールを指定するだけ (ライブラリとして配布するとより一般的な形になる) 

● app/build/kaptKotlin/debug/ 辺りに生成されるようになる 

いかがでしたか？ ● 自分で作ってみて、思ったよりも簡単だった ● ルールさえハッキリしていればコード生成(annotationProcessor)は こわくない ● アプリモジュールと同列で作ると導入も簡単で良い ○ ※ときどきビルドツールでバグってコンパイルが通らなくなる ● この機会にレッツcode generation! 

おまけ 

こんなこともあった ● Android Gradle Plugin 3.5.0で Jetifier でエラーが出るようになった ● 3.5.3 で出なくなった模様なので、Jetifier のバグだった？ ● ↓エラー内容 ○ 17:36:54 Execution failed for task ':app:kaptGenerateStubsDebugKotlin'. 17:36:54 > Could not resolve all files for configuration ':app:kapt'. 17:36:54 > Failed to transform artifact 'generator.jar (project :generator)' to match attributes {artifactType=processed-jar, org.gradle.category=library, org.gradle.dependency.bundling=external, org.gradle.jvm.version=8, org.gradle.usage=java-runtime-jars, org.jetbrains.kotlin.localToProject=public, org.jetbrains.kotlin.platform.type=jvm}. 17:36:54 > Execution failed for JetifyTransform: /mnt/vol/jenkins/workspace/android-mart-pull-request/generator/build/libs/generator.jar. 17:36:54 > Failed to transform '/mnt/vol/jenkins/workspace/android-mart-pull-request/generator/build/libs/generator.jar' using Jetifier. Reason: Cannot open a library at 'FileMapping(from=/mnt/vol/jenkins/workspace/android-mart-pull-request/generator/build/libs/generator.jar, to=/mnt/vol/jenkins/workspace/android-mart-pull-request/generator/build/.transforms/7bd08867addf7e0e0c415bce6c5839ac/jetified-generator.jar)'. (Run with --stacktrace for more details.)