Why Use Lombok?

To reduce boilerplate code in the entities layer (and other Java classes, such as POJOs or DTOs), you can add Lombok annotations. These annotations generate repetitive code (e.g., getters, setters, constructors) at compile time, making the code cleaner and more maintainable.

Good Reference: https://www.baeldung.com/intro-to-project-lombok

What is Lombok?

Lombok is a helper third-party library designed to reduce boilerplate code in Java classes, particularly in the POJO layer (e.g., entities, DTOs), by using annotations. It generates code for common tasks (e.g., constructors, getters/setters, toString, equals, hashCode) during compilation, improving developer productivity and code readability.

Steps to Use Lombok

1. Add Lombok Dependency in pom.xml:

   <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
       <version>1.18.34</version> <!-- Use the latest version, e.g., 1.18.34 -->
       <scope>provided</scope>
   </dependency>
   
   

2. Install Lombok Library to IDE:

   • Locate the Lombok JAR in your Maven repository:

     <home dir>\\\\.m2\\\\repository\\\\org\\\\projectlombok\\\\lombok\\\\1.18.34\\\\lombok-1.18.34.jar
     
     

   • Run the Lombok installer:

     • Open a terminal or command prompt (run as administrator).

     • Execute:

       java -jar lombok-1.18.34.jar
       
       

     • Specify the IDE location (e.g., Spring Tool Suite - STS):

       • Example: C:\\\\sts-bundle\\\\sts-4.x.RELEASE\\\\STS.exe

     • Follow the installer prompts to integrate Lombok with the IDE.

3. Maven Force Update and Cleaning:

   • In the IDE, update the Maven project:
     • Right-click project → Maven → Update Project.
     • Run mvn clean install to ensure dependencies are resolved.

4. Use Lombok Annotations:

   • Apply class-level or field-level annotations to generate boilerplate code.

Lombok Annotations

• @NoArgsConstructor: Generates a no-argument constructor.
  • Example: public Restaurant() {}.
• @AllArgsConstructor: Generates a constructor with all fields as parameters.
  • Example: public Restaurant(String name, String address, String city, String description, List<FoodItem> foodItems).
• @RequiredArgsConstructor: Generates a constructor for all final or @NonNull fields.
• @Getter: Generates getter methods for fields.
  • Example: public String getName() { return name; }.
• @Setter: Generates setter methods for fields.
  • Example: public void setName(String name) { this.name = name; }.
• @ToString(exclude = {...}, callSuper = true):
  • Generates a toString() method.
  • exclude: Excludes specified fields (e.g., exclude = {"foodItems"} to avoid printing collections).
  • callSuper = true: Includes the superclass’s toString() output (e.g., fields from BaseEntity).
• @Data:
  • Combines @Getter, @Setter, @ToString, @EqualsAndHashCode, and @RequiredArgsConstructor.
  • Caution: Not recommended for entity classes (e.g., Restaurant, FoodItem) due to potential issues with Hibernate (e.g., unintended equals/hashCode behavior affecting entity identity). Suitable for DTOs.
• @EqualsAndHashCode:
  • Generates equals() and hashCode() methods.
  • Use with caution in entities to avoid issues with Hibernate’s identity management.
• @Slf4j:
  • Provides a logger instance using SLF4J (Simple Logging Facade for Java).
  • Example: Adds a log field for logging (e.g., log.info("Message");).