How Lombok Simplifies Java Boilerplate—and What Pitfalls to Watch

1. Abstract

Java is a very popular programming language with rich features and strict object‑oriented design, but it is often criticized for being verbose. Developers must create classes, define variable types, and write many methods such as get, set, toString, hashCode, and equals. For an entity class with dozens of fields, the generated getter and setter methods can make the source file approach a thousand lines.

2. Lombok

Lombok is a widely used code‑simplification tool that, through its annotation features, can automatically generate the boilerplate get and set methods, making development very convenient.

In IntelliJ IDEA you can install Lombok via Preferences → Plugins → Search "lombok" → Install. Then add the Lombok dependency to your project:

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
    <scope>provided</scope>
</dependency>

After adding the dependency, annotate a class with @Data to generate getters, setters, hashCode, equals, and toString automatically:

import lombok.Data;

@Data
public class User {
    private String id;
    private String age;
    private String name;
    // No explicit get/set methods needed
}

Compiling this class produces a User.class file that contains the automatically generated methods, as shown in the following decompiled source:

public class User {
    private String id;
    private String age;
    private String name;

    public User() {}

    public String getId() { return this.id; }
    public String getAge() { return this.age; }
    public String getName() { return this.name; }
    public void setId(String id) { this.id = id; }
    public void setAge(String age) { this.age = age; }
    public void setName(String name) { this.name = name; }
    protected boolean canEqual(Object other) { return other instanceof User; }
    public int hashCode() { /* generated hash code */ }
    public String toString() { return "User(id=" + this.id + ", age=" + this.age + ", name=" + this.name + ")"; }
    public boolean equals(Object o) { /* generated equals */ }
}

The @Data annotation dramatically reduces code size, which is why many developers favor Lombok.

3. Drawbacks

3.1 Forced team adoption

If a project uses Lombok, every teammate must also install the Lombok plugin; otherwise the project will fail to compile.

3.2 Reduced debuggability

Because Lombok generates methods at compile time, it is difficult to trace which code path modifies a field, making debugging harder.

3.3 Inheritance pitfalls

The @Data annotation only generates hashCode and equals for the current class, ignoring superclass fields. This can cause unexpected behavior when the class is used as a key in collections. Adding @EqualsAndHashCode(callSuper=true) resolves the issue.

3.4 Encapsulation concerns

Using @Data on a class automatically exposes all fields via getters and setters, which may break intended encapsulation.

3.5 JDK compatibility risk

Lombok relies on non‑official Java APIs and bytecode manipulation. Future JDK releases may close these loopholes, rendering Lombok unusable unless it is updated, which is uncertain for a third‑party open‑source project.

4. Summary

Lombok is a powerful tool that can greatly reduce boilerplate code in Java projects, but teams should weigh its benefits against the potential drawbacks such as mandatory plugin installation, debugging difficulty, inheritance issues, encapsulation loss, and possible incompatibility with future JDK versions. Proper training and careful evaluation are recommended before adopting Lombok in production code.