[JAVA] Lombok

Lombok

getter, setter, 생성자, toString(), equals()와 hashCode() 메소드 같은 표준 자바 코드는 필수적이지만, 매번 작성하기는 번거롭다. 이런 문제를 해결하기 위해, Lombok 라이브러리는 자바 개발을 단순화하고, 보다 깔끔한 코드로 유지할 수 있도록 돕는 다양한 애노테이션을 제공한다.

이 애노테이션은 자바 개발자가 반복적인 코드를 줄이고, 가독성과 유지보수성을 향상시킬 수 있도록 설계된 도구이다. 아래는 Lombok에서 제공하는 몇 가지 중요한 애노테이션이다.

1. @Getter / @Setter

• 자동으로 필드에 대한 getter와 setter 메소드를 생성함
• 클래스 또는 필드 레벨에 적용할 수 있음

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class Employee {
    private String name;
    private int age;
}

2. @ToString

• toString 메소드를 자동으로 생성함
• 출력형식은 클래스 이름과 각 필드의 이름 및 값이 포함된 문자열임

import lombok.ToString;

@ToString
public class Employee {
    private String name;
    private int age;
}

3. @EqualsAndHashCode

• equals()와 hashCode() 메소드를 자동으로 생성함
• 객체의 동등성 비교와 해시 기반의 컬렉션에 객체를 사용하기 위해 필수적임

import lombok.EqualsAndHashCode;

@EqualsAndHashCode
public class Employee {
    private String name;
    private int age;
}

4. @NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

• 매개변수가 없는 생성자, 필수 필드(@NonNull필드)만 포함하는 생성자, 모든 필드를 매개변수로 갖는 생성자를 생성함

import lombok.*;

@NoArgsConstructor
@RequiredArgsConstructor
@AllArgsConstructor
public class Employee {
    @NonNull private String name;
    private int age;
}

5. @Data

• 이 애노테이션은 @Getter, @Setter, @RequiredArgsConstructor, @ToString, @EqualsAndHashCode를 한 번에 적용하는 애노테이션.
• DTO(Data Transfer Object)와 같은 간단한 모델 객체에 매우 유용

import lombok.Data;

@Data
public class Employee {
    private String name;
    private int age;
}

장점
1. 코드 간소화와 가독성 향상

• Lombok은 반복적인 코드 작성을 피하게 함으로써, 클래스의 가독성을 향상시킨다. 예를 들어 getter, setter, toString(), equals(), hashCode() 메소드등을 자동으로 생성하여 코드의 양을 줄일 수 있다.

2. 개발 시간 절약

• 반복적인 메소드를 수동으로 작성하는 데 소요되는 시간을 줄여주고, 이를 통해 개발자는 핵심 비즈니스 로직에 더 많은 시간을 할애할 수 있다.

3. 오류 감소

• 수동으로 코드를 작성할 때 발생할 수 있는 실수나 오류를 줄여준다. 예를 들어 equals()와 hashCode() 메소드를 직접 작성할 때 종종 발생하는 실수를 방지할 수 있다.

4. 유지 보수성 향상

• 클래스의 필드가 변경되거나 추가될 때 자동으로 생성된 메소드들이 업데이트되므로, 유지 보수 시간이 감소한다.

단점
1. 컴파일 의존성

• Lombok은 컴파일 타임에 코드를 조작한다. 이는 런타임 시 예상하지 못한 문제를 발생시킬 수 있으며, 디버깅을 어렵게 만들 수 있음

2. 툴과의 호환성 문제

• 모든 IDE나 빌드 툴에서 Lombok을 지원하는 것이 아니라서 지원하지 않는 경우에는 IDE에 플러그인 설치가 필요하며, 때로는 호환성이 되지 않는 문제가 발생할 수 있음

3. 학습 곡선

• 새로운 개발자나 lombok에 익숙하지 않는 개발자가 프로젝트에 참여할 경우, 코드의 자동 생성된 부분을 이해하고 디버깅하는 데 어려움을 겪을 수 있음

4. API 추상화

• Lombok은 코드 레벨에서 많은 것들을 추상화하고 숨김. 이는 코드의 직접적인 수정없이 자동으로 많은 것들이 처리되는 것을 의미하지만, 내부적으로 무슨 일이 일어나는지 이해하지 못할 수 있음

Lombok 은 자바 프로젝트에서 코드를 간소화하고 개발 효율성을 향상시키는 매우 유용한 도구이다. 이를 도입하기 전에 해당 프로젝트의 요구 사항과 환경을 고려하여 장담점을 충분히 평가해야한다. 팀원 간의 충분한 소통과 교육이 수반되어야 하며, 모든 개발자가 Lombok의 작동 방식과 그로 인한 코드의 변화를 이해할 수 있도록 해야 한다. Lombok의 사용이 적합한지 결정하기 전에 이러한 요소들을 신중하게 고려하는 것이 중요하다.