Kotlin Symbol Processing API

Kotlin Symbol Processing(KSP)는 경량 컴파일러 플러그인을 개발하는 데 사용할 수 있는 API입니다. KSP는 Kotlin의 강력한 기능을 활용하면서도 학습 곡선을 최소화하는 간소화된 컴파일러 플러그인 API를 제공합니다. kapt와 비교했을 때, KSP를 사용하는 어노테이션 프로세서는 최대 2배 더 빠르게 실행될 수 있습니다.

KSP가 kapt와 어떻게 비교되는지 자세히 알아보려면 KSP의 장점을 확인하세요.
KSP 프로세서 작성을 시작하려면 KSP 퀵스타트를 살펴보세요.

개요

KSP API는 Kotlin 프로그램을 관용적으로 처리합니다. KSP는 확장 함수, 선언 위치 분산 및 로컬 함수와 같은 Kotlin 관련 기능을 이해합니다. 또한 명시적으로 유형을 모델링하고 동등성 및 할당 호환성과 같은 기본 유형 검사를 제공합니다.

API는 Kotlin 문법에 따라 기호 수준에서 Kotlin 프로그램 구조를 모델링합니다. KSP 기반 플러그인이 소스 프로그램을 처리할 때 클래스, 클래스 멤버, 함수 및 관련 매개변수와 같은 구성 요소를 프로세서에서 액세스할 수 있지만 if 블록 및 for 루프와 같은 항목은 액세스할 수 없습니다.

개념적으로 KSP는 Kotlin 리플렉션의 KType와 유사합니다. API를 통해 프로세서는 클래스 선언에서 특정 유형 인수가 있는 해당 유형으로, 그 반대로 탐색할 수 있습니다. 또한 유형 인수를 대체하고, 분산을 지정하고, 스타 프로젝션을 적용하고, 유형의 null 가능성을 표시할 수 있습니다.

KSP를 Kotlin 프로그램의 전처리 프레임워크로 생각할 수도 있습니다. KSP 기반 플러그인을 심볼 프로세서 또는 간단히 _프로세서_로 간주하면 컴파일의 데이터 흐름을 다음 단계로 설명할 수 있습니다.

프로세서는 소스 프로그램 및 리소스를 읽고 분석합니다.
프로세서는 코드 또는 기타 형태의 출력을 생성합니다.
Kotlin 컴파일러는 생성된 코드와 함께 소스 프로그램을 컴파일합니다.

완전한 기능을 갖춘 컴파일러 플러그인과 달리 프로세서는 코드를 수정할 수 없습니다. 언어 의미 체계를 변경하는 컴파일러 플러그인은 때때로 매우 혼란스러울 수 있습니다. KSP는 소스 프로그램을 읽기 전용으로 처리하여 이를 방지합니다.

이 비디오에서 KSP에 대한 개요를 확인할 수도 있습니다.

KSP가 소스 파일을 보는 방법

대부분의 프로세서는 입력 소스 코드의 다양한 프로그램 구조를 탐색합니다. API 사용법을 자세히 살펴보기 전에 KSP의 관점에서 파일이 어떻게 보이는지 살펴보겠습니다.

KSFile
  packageName: KSName
  fileName: String
  annotations: List<KSAnnotation>  (File annotations)
  declarations: List<KSDeclaration>
    KSClassDeclaration // class, interface, object
      simpleName: KSName
      qualifiedName: KSName
      containingFile: String
      typeParameters: KSTypeParameter
      parentDeclaration: KSDeclaration
      classKind: ClassKind
      primaryConstructor: KSFunctionDeclaration
      superTypes: List<KSTypeReference>
      // contains inner classes, member functions, properties, etc.
      declarations: List<KSDeclaration>
    KSFunctionDeclaration // top level function
      simpleName: KSName
      qualifiedName: KSName
      containingFile: String
      typeParameters: KSTypeParameter
      parentDeclaration: KSDeclaration
      functionKind: FunctionKind
      extensionReceiver: KSTypeReference?
      returnType: KSTypeReference
      parameters: List<KSValueParameter>
      // contains local classes, local functions, local variables, etc.
      declarations: List<KSDeclaration>
    KSPropertyDeclaration // global variable
      simpleName: KSName
      qualifiedName: KSName
      containingFile: String
      typeParameters: KSTypeParameter
      parentDeclaration: KSDeclaration
      extensionReceiver: KSTypeReference?
      type: KSTypeReference
      getter: KSPropertyGetter
        returnType: KSTypeReference
      setter: KSPropertySetter
        parameter: KSValueParameter

이 보기에는 파일에 선언된 일반적인 항목(클래스, 함수, 속성 등)이 나열되어 있습니다.

SymbolProcessorProvider: 진입점

KSP는 SymbolProcessor를 인스턴스화하기 위해 SymbolProcessorProvider 인터페이스의 구현을 기대합니다.

interface SymbolProcessorProvider {
    fun create(environment: SymbolProcessorEnvironment): SymbolProcessor
}

SymbolProcessor는 다음과 같이 정의됩니다.

interface SymbolProcessor {
    fun process(resolver: Resolver): List<KSAnnotated> // Let's focus on this
    fun finish() {}
    fun onError() {}
}

Resolver는 SymbolProcessor에 기호와 같은 컴파일러 세부 정보에 대한 액세스를 제공합니다. 최상위 클래스에서 모든 최상위 함수와 비로컬 함수를 찾는 프로세서는 다음과 같이 보일 수 있습니다.

class HelloFunctionFinderProcessor : SymbolProcessor() {
    // ...
    val functions = mutableListOf<KSClassDeclaration>()
    val visitor = FindFunctionsVisitor()

    override fun process(resolver: Resolver) {
        resolver.getAllFiles().forEach { it.accept(visitor, Unit) }
    }

    inner class FindFunctionsVisitor : KSVisitorVoid() {
        override fun visitClassDeclaration(classDeclaration: KSClassDeclaration, data: Unit) {
            classDeclaration.getDeclaredFunctions().forEach { it.accept(this, Unit) }
        }

        override fun visitFunctionDeclaration(function: KSFunctionDeclaration, data: Unit) {
            functions.add(function)
        }

        override fun visitFile(file: KSFile, data: Unit) {
            file.declarations.forEach { it.accept(this, Unit) }
        }
    }
    // ...
    
    class Provider : SymbolProcessorProvider {
        override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor = TODO()
    }
}

리소스

지원되는 라이브러리

이 표에는 Android의 인기 있는 라이브러리와 KSP에 대한 다양한 지원 단계가 나와 있습니다.

Library	Status
Room	공식 지원
Moshi	공식 지원
RxHttp	공식 지원
Kotshi	공식 지원
Lyricist	공식 지원
Lich SavedState	공식 지원
gRPC Dekorator	공식 지원
EasyAdapter	공식 지원
Koin Annotations	공식 지원
Glide	공식 지원
Micronaut	공식 지원
Epoxy	공식 지원
Paris	공식 지원
Auto Dagger	공식 지원
SealedX	공식 지원
Ktorfit	공식 지원
Mockative	공식 지원
DeeplinkDispatch	airbnb/DeepLinkDispatch#323을 통해 지원
Dagger	Alpha
Motif	Alpha
Hilt	진행 중
Auto Factory	아직 지원되지 않음

개요​

KSP가 소스 파일을 보는 방법​

SymbolProcessorProvider: 진입점​

리소스​

지원되는 라이브러리​

개요

KSP가 소스 파일을 보는 방법

SymbolProcessorProvider: 진입점

리소스

지원되는 라이브러리