Adding KSP Support to Android Room: Challenges, Design Decisions, and Implementation

Room provides an abstraction over SQLite with compile‑time SQL verification via annotation processing, generating Java source code from annotated Kotlin.

KAPT adds significant build‑time overhead for Kotlin, so starting with Room 2.4 an experimental KSP backend was introduced, yielding roughly a two‑fold compilation speed improvement.

The article outlines three design options for adding KSP support—duplicating processors, creating an abstract layer, or replacing JavaAP entirely—and explains why the abstract‑layer approach (option B) was chosen to minimise risk.

Implementation involved building an X‑Processing API that maps Java model elements (e.g., TypeElement ) to X‑type equivalents ( XTypeElement , XMethodElement ), handling Kotlin‑specific constructs such as suspend functions and property accessors, and iteratively prototyping and testing each X class.

interface XTypeElement {
fun getAllFieldsIncludingPrivateSupers(): List
}

A comprehensive testing framework was built using Google Compile Testing for Java, Kotlin Compile Testing (later replaced by an internal implementation), and custom X‑Processing‑Testing utilities, allowing each processor to be exercised via runTest and runProcessorTest across both KAPT and KSP paths.

Despite the progress, limitations remain: Room still generates only Java code, nullability handling is incomplete, and support for Kotlin features like value classes is pending. The authors encourage annotation‑processor developers to add KSP support to improve the Kotlin developer experience.