룸북(Lombok) 라이브러리란? InteliJ 설치/ 자주 사용되야 할, 지양되어야 할 룸북 어노테이션

Lombok 라이브러리

• java 코드를 컴파일 할 때 자동으로 추가 메소드를 만들어서 컴파일해주는 라이브러리
• 여러가지 어노테이션을 제공하고 이를 기반으로 코드를 컴파일과정에서 생성해 주는 방식으로 동작→ 즉 코딩 과정에서는 롬복과 관련된 어노테이션만 보이고 getter와 setter 메서드 등은 보이지 않지만 실제로 컴파일된 결과물(.class)에는 코드가 생성되어 있다는 뜻

 

인텔리제이 Lombok 라이브러리 설치

 

1. Lombok plugin 설치

File → Settings → Plugins → Marketplace에 lombok을 검색하고 설치/ IDE 재시작

 

2. Dependency 설정

 

(1) 수동추가 : 인텔리제이에서 룸북 어노테이션 사용했을 때 나오는 도움말로 세팅

(2) Maven 설정

pom.xml파일에 다음 태그 생성

    org.projectlombok
    lombok
    1.18.4
    provided

(3) Gradle 설정

build.gradle 파일에 다음 코드 추가

dependencies {
    # lombok plugin
    implementation('org.projectlombok:lombok')
    annotationProcessor('org.projectlombok:lombok')    

    # test 환경
    testImplementation('org.projectlombok:lombok')
    testAnnotationProcessor('org.projectlombok:lombok')    
}

 

3. Lombok 어노테이션 활성화

File(맥북은 InteliJ) > Setting > Build, Execution, Deployment > Compiler > Annotation Processors 에서 Enable annotation processing을 체크

 

자주 쓰는 Annotation

 

생성자 관련

 

@NoArgsConstructor : 매개 변수가 없는 기본 생성자를 생성

@RequiredArgsConstructor : final 필드만 포함된 생성자를 생성

@AllArgsConstructor : 모든 필드를 포함한 생성자를 생성

 

메소드 관련

 

@Getter : Getter를 자동으로 생성

@Setter : Setter를 자동으로 생성

@ToString : toString 메소드를 자동으로 생성

@EqualsAndHashCode : equals, hashCode 메소드를 자동으로 생성

@With : with 메소드를 자동으로 생성

 

통합 기능

 

@Data : 여러 어노테이션 통합

@ToString, @EqualsAndHashCode, @Getter, @Setter, @RequiredArgsConstructor 기능을 함께 제공

@Value : @Data의 변형된 기능

모든 필드를 private final로 설정, 클래스를 final로 설정, Setter를 생성하지 않는다.

• staticConstructor : final 변수로 이루어진 static 생성자를 만든다. (@RequiredArgsConstructor를 private로 생성)

빌더 패턴

 

@Builder : 메소드 체이닝을 이용하는 static 메소드 builder()를 생성한다.

생성자 대신 편리하게 사용

@Builder.Default : 명시적으로 기본값 설정

@Singular : 해당 필드를 컬렉션으로 처리하여 다수의 값을 할당할 수 있다.

그 외

@NonNull : null-check 로직을 자동으로 생성하여 null 값이 넘어온 경우 NulPointerException 발생

@Cleanup : 해당 영역을 벗어날 때 지정된 리소스의 close()를 호출

try-finally 구문이 적용된다.

@Synchronized : java의 synchronized의 더 안전하게 변형된 기능

static, instance 단위로 락을 거는 synchronized와 다르게 필드 단위로 락을 건다. (메소드에만 사용 가능)

@SneakyThrows(예외클래스) : try-catch 문법으로 해당 예외를 처리

Checked Exception 처리에 유용

@Log, @CommonsLog, @Log4j2, @Slf4j 등...

로그 프레임워크를 log라는 이름의 private static final 필드로 생성

 

Lombok 어노테이션 정리

 

지양해야 할 Annotation

@AllArgsConstructor

@Data

@NoArgsConstructor

@Builder

Lombok - 지양해야 할 annotation