Support KSP (Kotlin Symbol Processing)

[natanfudge]

Currently ObjectBox supports using KAPT for processing annotations in Kotlin. KSP is a new Kotlin annotation processing framework by Google and supported by Jetbrains that processes annotations in a far more 'native' way than KAPT, resulting in improved performance and an API more suited for Kotlin. Consequently, KAPT has lost its focus from the Kotlin team (source). ObjectBox should seriously consider providing an implementation for processing annotations in Kotlin using KSP. For reference, see this recent build time analysis: A whopping 75.8% (24.2 seconds) of build time is spent on generating KAPT stubs, which supposedly KSP avoids completely. On the other hand, it appears only 0.8 seconds is spent doing actual Objectbox work.

Further reading:
What is KSP? Why KSP? KSP Github

[greenrobot-team]

Thanks for reporting! Funny enough, I stumbled upon the note regarding KSP while looking up some Kapt info and created an internal issue for this.

From a first look the main issue is that ObjectBox supports plain Java projects, so we likely would have to maintain two annotation processors.

[natanfudge]

@greenrobot-team Since that does seem like a big issue, I've done some research on it.
This very detailed article explains how Room (very similar to ObjectBox!) implemented KSP support while preserving Java support. They did it by implementing an abstraction layer called X-Processing that allows processing using KSP and JavaAP with a unified API, making the new code in Room itself be no less complex/long than the pure JavaAP equivalent, and even be simpler in some cases. Following this, Dagger, and Airbnb's Paris and DeeplinkDispatch have used Processing-X to provide their own KSP support, and contributed the things that they needed as well. Processing-X (now known as room-compiler-processing) is available on Google's Maven, but is not considered an official library.

[greenrobot]

@natanfudge Thanks for providing all the useful information here. :heart: Could you also indicate some rough numbers on your project's size, so we can relate the build time to it?

[natanfudge]

greenrobot It is a new project, so quite small. ~15 Kotlin files with an average of around 100 LOC. By the way, is the annotation processor closed source? I can't find the source anywhere, even the source jar is empty.

[woniu163]

The current android jetpack platform actively embraces kotlin, kotlin has a more positive attitude towards ksp, and many android libraries are compatible with ksp, so ObjectBox supporting ksp is a very correct decision

[andrew-ld]

@greenrobot-team with kotlin 2 kapt slow down too much the compilation time, can prioritize the switch from kapt to ksp, now as workaround i added objectbox classes as a gradle submodule so the compilation is fast because kapt should process only few small files