Lombok Best Practices

lombok-best-practices.md

Lombok Best Practices

Entities

• Do not use @Data and @EqualsAndHashCode
• Use @Getter and @Setter
• Don't forget to exclude lazy attributes if you use @ToString
• Don't forget to add @NoArgsConstructor if you use @Builder or @FullArgsConstructor or @RequiredArgsConstructor
• Explanation for rules above: Lombok and JPA: What may go wrong?
• Use @Builder if setting lots of different fields

DTOs/POJOs/Classes with just member variables to store data

• Use @Data
  • Most pojos can benefit from all the features of @Data with no notable side effects
  • @Data is a convenient shortcut annotation that bundles the features of @ToString, @EqualsAndHashCode, @Getter / @Setter
• Use @Builder if setting lots of different fields
• Explanation of DTOs,POJOs

Services

• Use @RequiredArgsConstructor
  • Make dependency injected class variables private final
    • This makes them required cuasing them to be included in the constructor and therefore injection
  • Make @Value class variables private
    • These values are not constuctor injected
• Do not use @Data , @Getter , @Setter data in services should not be used by anyone else
  • For testing use ⁠ReflectionTestUtils