Share
Embed
Transcript
72 slides
-
About me • Kenji Abe • Google Developers Expert for
Android, Kotlin • AndroidDagashi • DeNA Co., Ltd. • @STAR_ZERO -
Kotlin Symbol Processing (KSP) • https://github.com/google/ksp • Kotlinの軽量コンパイラプラグインを開発できるツール • KAPTに似た機能を提供できる(コード生成)
• KAPTに比べて高速 • Kotlinのコードを直接解析できる • Kotlin Multiplatformのサポート -
plugins { id("com.google.devtools.ksp") version "1.5.30-1.0.0" // ... } dependencies {
ksp(project(":processor")) } -
class HelloWorldProcessorProvider : SymbolProcessorProvider { override fun create( environment: SymbolProcessorEnvironment
): SymbolProcessor { return HelloWorldProcessor( environment.codeGenerator, environment.options, environment.logger ) } } -
class HelloWorldProcessorProvider : SymbolProcessorProvider { override fun create( environment: SymbolProcessorEnvironment
): SymbolProcessor { return HelloWorldProcessor( environment.codeGenerator, environment.options, environment.logger ) } } -
class HelloWorldProcessorProvider : SymbolProcessorProvider { override fun create( environment: SymbolProcessorEnvironment
): SymbolProcessor { return HelloWorldProcessor( environment.codeGenerator, environment.options, environment.logger ) } } -
class HelloWorldProcessorProvider : SymbolProcessorProvider { override fun create( environment: SymbolProcessorEnvironment
): SymbolProcessor { return HelloWorldProcessor( environment.codeGenerator, environment.options, environment.logger ) } } -
class HelloWorldProcessorProvider : SymbolProcessorProvider { override fun create( environment: SymbolProcessorEnvironment
): SymbolProcessor { return HelloWorldProcessor( environment.codeGenerator, environment.options, environment.logger ) } } -
class HelloWorldProcessorProvider : SymbolProcessorProvider { override fun create( environment: SymbolProcessorEnvironment
): SymbolProcessor { return HelloWorldProcessor( environment.codeGenerator, environment.options, environment.logger ) } } // build.gradle.kts ksp { arg("key", "value") } -
class HelloWorldProcessorProvider : SymbolProcessorProvider { override fun create( environment: SymbolProcessorEnvironment
): SymbolProcessor { return HelloWorldProcessor( environment.codeGenerator, environment.options, environment.logger ) } } logger.logging("...") logger.info("...") logger.warn("...") logger.error("...") $ ./gradlew build --debug or $ ./gradlew build --info -
class HelloWorldProcessor( private val codeGenerator: CodeGenerator, private val options: Map<String,
String>, private val logger: KSPLogger ) : SymbolProcessor { override fun process(resolver: Resolver): List<KSAnnotated> { // } } -
class HelloWorldProcessor( private val codeGenerator: CodeGenerator, private val options: Map<String,
String>, private val logger: KSPLogger ) : SymbolProcessor { override fun process(resolver: Resolver): List<KSAnnotated> { // } } -
class HelloWorldProcessor( private val codeGenerator: CodeGenerator, private val options: Map<String,
String>, private val logger: KSPLogger ) : SymbolProcessor { override fun process(resolver: Resolver): List<KSAnnotated> { // } } -
class HelloWorldProcessor( private val codeGenerator: CodeGenerator, private val options: Map<String,
String>, private val logger: KSPLogger ) : SymbolProcessor { override fun process(resolver: Resolver): List<KSAnnotated> { // } } -
override fun process(resolver: Resolver): List<KSAnnotated> { val files = resolver.getAllFiles()
val newFiles = resolver.getNewFiles() val symbols = resolver.getSymbolsWithAnnotation("com.example.Factory") val ksClass = resolver.getClassDeclarationByName("com.example.Hoge") // ... } -
override fun process(resolver: Resolver): List<KSAnnotated> { val files = resolver.getAllFiles()
val newFiles = resolver.getNewFiles() val symbols = resolver.getSymbolsWithAnnotation("com.example.Factory") val ksClass = resolver.getClassDeclarationByName("com.example.Hoge") // ... } -
override fun process(resolver: Resolver): List<KSAnnotated> { val files = resolver.getAllFiles()
val newFiles = resolver.getNewFiles() val symbols = resolver.getSymbolsWithAnnotation("com.example.Factory") val ksClass = resolver.getClassDeclarationByName("com.example.Hoge") // ... } -
override fun process(resolver: Resolver): List<KSAnnotated> { val symbols = resolver.getSymbolsWithAnnotation("com.example.Factory")
symbols.forEach { when (it) { is KSClassDeclaration -> { } is KSFunctionDeclaration -> { } is KSPropertyDeclaration -> { } } } // ... } -
override fun process(resolver: Resolver): List<KSAnnotated> { val file = codeGenerator.createNewFile(
Dependencies(false), "com.example.generated", "Hello" ) val code = """ ... """.trimIndent() file.write(code.toByteArray()) file.close() // ... } -
override fun process(resolver: Resolver): List<KSAnnotated> { val file = codeGenerator.createNewFile(
Dependencies(false), "com.example.generated", "Hello" ) val code = """ ... """.trimIndent() file.write(code.toByteArray()) file.close() // ... } -
override fun process(resolver: Resolver): List<KSAnnotated> { val file = codeGenerator.createNewFile(
Dependencies(false), "com.example.generated", "Hello" ) val code = """ ... """.trimIndent() file.write(code.toByteArray()) file.close() // ... } -
override fun process(resolver: Resolver): List<KSAnnotated> { val file = codeGenerator.createNewFile(
Dependencies(false), "com.example.generated", "Hello" ) val code = """ ... """.trimIndent() file.write(code.toByteArray()) file.close() // ... } -
// Hoge.kt @Factory class Hoge // Foo.kt @Factory class Foo
// etc... // SymbolProcessor#process resolver.getSymbolsWithAnnotation("...") // => -
// Hoge.kt @Factory class Hoge // Foo.kt @Factory class Foo
// etc... // SymbolProcessor#process resolver.getSymbolsWithAnnotation("...") // => [Hoge, Foo] -
// Hoge.kt @Factory class Hoge // Foo.kt @Factory class Foo
// etc... // SymbolProcessor#process resolver.getSymbolsWithAnnotation("...") // => [Hoge, Foo] // HogeFactory.kt class HogeFactory // FooFactory.kt class FooFactory コード生成 -
// Hoge.kt @Factory class Hoge // Foo.kt @Factory class Foo
// etc... // SymbolProcessor#process resolver.getSymbolsWithAnnotation("...") // => // HogeFactory.kt class HogeFactory // FooFactory.kt class FooFactory コード生成 -
// Hoge.kt @Factory class Hoge // Foo.kt @Factory class Foo
// etc... // SymbolProcessor#process resolver.getSymbolsWithAnnotation("...") // => [] // HogeFactory.kt class HogeFactory // FooFactory.kt class FooFactory コード生成 -
// Hoge.kt @Factory class Hoge // Foo.kt @Factory class Foo
// etc... // SymbolProcessor#process resolver.getSymbolsWithAnnotation("...") // => [] // HogeFactory.kt class HogeFactory // FooFactory.kt class FooFactory コード生成 Finish -
override fun process(resolver: Resolver): List<KSAnnotated> { val symbols = resolver.getSymbolsWithAnnotation("...")
val result = symbols.filter { !it.validate() }.toList() symbols.filter { it.validate() }.forEach { symbol -> // コード生成 } return result } -
override fun process(resolver: Resolver): List<KSAnnotated> { val symbols = resolver.getSymbolsWithAnnotation("...")
val result = symbols.filter { !it.validate() }.toList() symbols.filter { it.validate() }.forEach { symbol -> // コード生成 } return result } -
override fun process(resolver: Resolver): List<KSAnnotated> { val symbols = resolver.getSymbolsWithAnnotation("...")
val result = symbols.filter { !it.validate() }.toList() symbols.filter { it.validate() }.forEach { symbol -> // コード生成 } return result } -
override fun process(resolver: Resolver): List<KSAnnotated> { val symbols = resolver.getSymbolsWithAnnotation("...")
val result = symbols.filter { !it.validate() }.toList() symbols.filter { it.validate() }.forEach { symbol -> // コード生成 } return result } -
Resolver • getAllFiles ◦ 全てのラウンドでの処理対象となったファイル • getNewFiles ◦ ラウンドごとに処理対象となっているファイル •
getSymbolsWithAnnotation ◦ ラウンドごとに処理対象となっているものから、該当の Annotationがあるもの • getClassDeclarationByName ◦ クラスパスから指定したクラス名を探す -
Hoge.kt Foo.kt SymbolProcessor HogeFactory.kt FooFactory.kt Hoge.kt Foo.kt SymbolProcessor HogeFactory.kt FooFactory.kt
Bar.kt BarFactory.kt Changed New Clean Build 差分 Build -
val symbols = resolver.getSymbolsWithAnnotation("...") symbols.forEach { val file = codeGenerator.createNewFile(
Dependencies(aggregating = false, it.containingFile!!), "...", "..." ) // コード生成 } -
val symbols = resolver.getSymbolsWithAnnotation("...") symbols.forEach { val file = codeGenerator.createNewFile(
Dependencies(aggregating = false, it.containingFile!!), "...", "..." ) // コード生成 } -
KSP対応状況 • Room ◦ https://developer.android.com/jetpack/androidx/releases/room#2.3.0-beta02 • Moshi ◦ https://github.com/ZacSweers/MoshiX/tree/main/moshi-ksp •
Kotshi ◦ https://github.com/ansman/kotshi