How does lombok work?

java annotations lombok
uuidcode picture uuidcode · May 24, 2011 · Viewed 40.9k times · Source

I met lombok today.
I'm very anxious to know how it works.
A Java Geek Article gives some clues but it's not perfectly clear to me:

Java 6 removes apt and make javac able to manage annotations, streamlining the process to obtain a simpler single step computing. This is the path taken by Lombok.

Maybe with Java 6 the compile process will be: javac -> apt -> lombok apt process -> read class files and add set/get methods using ASM?

Could you show me more details about the mechanism?

Answer

rzwitserloot picture rzwitserloot · May 25, 2011

Lombok does indeed code against internal API, as Sean Patrick Floyd said. However, as lombok is ONLY involved in the compilation phase, its misleading to claim Lombok will only run on a sun VM. It'll only compile on ecj or sun's javac. However, the vast majority of VMs out there, if they ship a compiler at all, are one of those two. For example, the Apple VM ships with stock sun javac, and as such lombok works just fine on macs. Same goes for the soylatte VM, for example.

While for javac we really do have to stick with their updates, partly because of a lot of ongoing work on their compiler right now, we've had to make just 1 minor adjustment to our eclipse support over many many versions of eclipse. So, while we do code against internal API, they are relatively stable bits.

If what lombok does could be done without resorting to internal API, we'd have done something else, but it can't be done, so we resort to internal API usage.

NB: I'm one of the lead developers of lombok, so, I'm probably a little biased :P

Related questions

Lombok's @NonNull or javax @Nonnull

Lombok's @NonNull VS javax.annotation.Nonnull Which one is better to use for method parameters and when? The answer here vaguely compares all annotations but has no inference on which one is best. I just to know the better of …

Read More
How can I get @getter and @setter?

I often see the following annotations in code: @Getter @Setter public int test = 1; I know I can create getter and setter methods using this annotations. But which classes/library do I need to use these annotations?

Read More
What's the difference between @Component, @Repository & @Service annotations in Spring?

Can @Component, @Repository and @Service annotations be used interchangeably in Spring or do they provide any particular functionality besides acting as a notation device? In other words, if I have a Service class and I change the annotation from @Service …

Read More