KSP を使ってコード生成 関西モバイルアプリ研究会 A @takuji31

自己紹介 西林 拓志(にしばやし たくじ) Twitter/GitHub takuji31 株式会社はてな Android アプリケーションエンジ ニア Android (2009〜) Kotlin (2014〜) 2

KSP 使ってますか？ 3

今日は KSP のプロセッサーの作り方(≠ 使い方)について話 します 4

KSP? 5

Kotlin Symbol Processor 6

google/ksp 7

コードにつけられたアノテーションを処理する 8

Kotlin friendly 9

Incremental proccessing 10

KMP 対応 11

Supported libs Dagger / Hilt (alpha) Room Moshi Glide etc. 12

プロセッサーの 作り方 13

source code // これを @SimpleGeneration interface Hoge // こうだ abstract class AbstractHoge: Hoge 14

build.gradle.kts // ... dependencies { // KSP のAPI implementation("com.google.devtools.ksp:symbol-processing-api:1.9.21-1.0.15") // KotlinPoet implementation("com.squareup:kotlinpoet:1.15.3") // KotlinPoet のKSP 用拡張 implementation("com.squareup:kotlinpoet-ksp:1.15.3") } 15

SymbolProcessor class ExampleSymbolProcessor( private val codeGenerator: CodeGenerator, private val logger: KSPLogger ) : SymbolProcessor { override fun process(resolver: Resolver): List { resolver .getSymbolsWithAnnotation(SimpleGeneration::class.qualifiedName!!) .filterIsInstance() .forEach { it.accept(SimpleGenerationVisitor(codeGenerator, logger), Unit) } return emptyList() } } 16

Visitor class SimpleGenerationVisitor( private val codeGenerator: CodeGenerator, private val logger: KSPLogger ) : KSVisitorVoid() { override fun visitClassDeclaration(classDeclaration: KSClassDeclaration, data: Unit) { if (classDeclaration.classKind != ClassKind.INTERFACE) { logger.error("Only interface allowed", classDeclaration) return } val packageName = classDeclaration.packageName.asString() val className = ClassName(packageName, "Abstract" + classDeclaration.simpleName.asString()) val typeSpec = TypeSpec.classBuilder(className) .addModifiers(KModifier.ABSTRACT) .addSuperinterface(classDeclaration.toClassName()) FileSpec.builder(packageName, className.simpleName) .addType(typeSpec.build()) .build() .writeTo( codeGenerator, Dependencies( aggregating = false, classDeclaration.containingFile!! ) ) } } 17

SymbolProcessorProvider class ExampleSymbolProcessorProvider : SymbolProcessorProvider { override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor { return ExampleSymbolProcessor(environment.codeGenerator, environment.logger) } } 18

Service Provider // resources/META-INF/services/com.google.devtools.ksp.processing.SymbolProcessorProvider jp.takuji31.kotlinfest2022.compiler.ExampleSymbolProcessorProvider 19

Incremental Processing 20

生成するファイルの依存を定義すれば Processor 側で適 切に処理される 21

Isolated 22

1:N 23

Isolated Dependencies(aggregating = false, classDeclaration.containingFile!!) 24

Aggregated 25

N:1 26

Aggregated (集約) val dependencies: Array = // ... Dependencies(aggregating = true, *dependencies.mapNotNull { it.containingFile }) 27

依存をちゃんと指定しないと「なぜかコード生成されな い」みたいな事態になる 28

テスト 29

tschuchortdev/kotlin-compile-testing 30

テストコード val source = SourceFile.kotlin( "ExampleClass.kt", """ package jp.takuji31.kotlinfest2022.compiler import jp.takuji31.kotlinfest2022.compiler.annotation.SimpleGeneration @SimpleGeneration interface SimpleInterface { fun printHelloWorld() } """.trimIndent() ) 31

テストコード val compilation = KotlinCompilation().apply { sources = listOf(source) inheritClassPath = true symbolProcessorProviders = listOf(ExampleSymbolProcessorProvider()) kspWithCompilation = true } val result = compilation.compile() assertThat(result.exitCode) .isEqualTo(KotlinCompilation.ExitCode.OK) 32

ドキュメント/サンプルコード https://kotlinlang.org/docs/ksp-overview.html 公式ドキュメント https://github.com/google/ksp/tree/main/examples/playground 公式サンプル https://github.com/takuji31/kotlinfest2022-ksp-example 今回のスライドに出てきたソースコード https://github.com/takuji31/navigation-compose-screen 複雑な例 https://speakerdeck.com/takuji31/kotlin-symbol-processing-api-ksp-woshi-tute- kotlin-a-purikesiyonnokai-fa-woxiao-lu-hua-suru Kotlin Fest 2022 で発表した時のスライド もう少し踏み込んだ話はこちら 33

Enjoy KSP Life! 34