Using Lombok in Java

Using Lombok in Java | Generated by AI

Home PDF

To use Lombok in Java, you’ll need to set it up in your project to simplify your code by reducing boilerplate, like getters, setters, and constructors. Here’s how you can do it step-by-step:

First, you need to add Lombok as a dependency. If you’re using Maven, include this in your pom.xml:

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.32</version> <!-- Check for the latest version -->
    <scope>provided</scope>
</dependency>

For Gradle, add this to your build.gradle:

provided 'org.projectlombok:lombok:1.18.32'
// Also add this to ensure annotation processing works
annotationProcessor 'org.projectlombok:lombok:1.18.32'

Next, if you’re using an IDE like IntelliJ IDEA or Eclipse, you’ll need to enable annotation processing and install the Lombok plugin:

IntelliJ: Go to File > Settings > Plugins, search for “Lombok,” install it, and restart. Then ensure Enable annotation processing is checked under Settings > Build, Execution, Deployment > Compiler > Annotation Processors.
Eclipse: Download the Lombok JAR from the official site (projectlombok.org), run it with java -jar lombok.jar, and follow the installer to point it to your Eclipse installation.

Now, you can start using Lombok annotations in your Java code. Here’s a simple example:

import lombok.Getter;
import lombok.Setter;
import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    private String name;
    private int age;
}

In this example:

@Getter and @Setter automatically generate getter and setter methods for name and age.
@NoArgsConstructor creates a no-args constructor.
@AllArgsConstructor creates a constructor with all fields as parameters.

When you compile or run this, Lombok processes these annotations and adds the boilerplate code for you. You can test it like this:

public class Main {
    public static void main(String[] args) {
        Person person = new Person("Alice", 30);
        System.out.println(person.getName()); // Outputs: Alice
        person.setAge(31);
        System.out.println(person.getAge()); // Outputs: 31
    }
}

A few popular annotations you might also find useful:

@Data: A shortcut for @Getter, @Setter, @ToString, @EqualsAndHashCode, and a constructor for required fields (like final ones).
@Builder: Gives you a builder pattern for object creation.
@Slf4j: Adds a logger (e.g., from SLF4J) to your class.

For example, with @Data and @Builder:

import lombok.Data;
import lombok.Builder;

@Data
@Builder
public class User {
    private String username;
    private String email;
}

// Usage
public class Main {
    public static void main(String[] args) {
        User user = User.builder()
                        .username("john_doe")
                        .email("john@example.com")
                        .build();
        System.out.println(user); // Outputs: User(username=john_doe, email=john@example.com)
    }
}

Keep in mind:

Always check the latest version of Lombok on Maven Central or the official site.
If you’re working in a team, ensure everyone has Lombok set up in their IDE to avoid confusion with the generated code not being visible in the source.

Back 2025.02.27 Donate