objectbox / objectbox/objectbox-java

Support KSP (Kotlin Symbol Processing)

Open
#1,075 13 comments 64 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
4.6k
Forks
311
PR merge metrics
No merged PRs in 30d

Description

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:
image
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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no repository files, tests, or entry points. Start by studying the linked KSP documentation and the existing KAPT integration, then define completion as equivalent ObjectBox annotation processing through KSP with validation of build-time and generated-code behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.