study/springboot

004. 롬복(lombok)

까오기 2022. 5. 11. 11:17

롬복(Lombok 홈페이지

- projectlombok.org/

 

Project Lombok

 

projectlombok.org

Download

- 롬복 사이트에 가서 상단 download 페이지로 이동 후 다운로드 받으면 됩니다. 

- projectlombok.org/download

 

Download

 

projectlombok.org

Install

- 다운로드 받은 디렉토리로 이동 후 실행합니다. 

java -jar lombok.jar

Specify location에서 설치하려는 이클립스 디렉토리를 설정하고 install / update 버튼을 클릭하면 끝납니다. 

 

프로젝트에서 이용하기 위한 Dependencies 추가 

- spring boot이라면 build.gradle에서 사용하는 프로젝트 추가해주면 됩니다. 

dependencies {
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
}

롬복 주요 API

롬복을 이용하면 불필요한 code를 많이 줄여 줘서 가독성이 좋아집니다. 

API DESC REMARK
@Getter, @Setter Getter, Setter 자동 생성   
@NoArgsConstructor 기본 생성자 생성   
@RequiredArgsConstructor final, not null field를 파라미터로 하는 생성자를 자동 생성  
@AllArgsConstructor 모든 프라퍼티를 파라미터로 하는 생성자 생성  
@ToString toString()을 자동으로 생성  @ToString(exclude = "[제외항목]")
@EqualsAndHashCode equals, hashCode 자동 생성 @EqualsAndHashCode(callSuper = true)
@EqualsAndHashCode(exclude = "[제외항목]")
@Data @Getter, @Setter, @RequiredArgsConstructor, @ToString, @EqualsAndHashCode를 모두 포함한다.  비추 : 꼭 필요한거만 쓰는게 좋습니다. 
@Builder 빌더 패턴 자동 생성.  아주 쉽게 적용해서 사용 가능합니다. 
@UtilityClass 유틸 클래스인 경우 설정시 기본 생성자를 private으로 해서 생성 못하게 막아 주고 properties, method는 static이 된다.   
@Slf4j 로거 자동 생성  log.info("test....");

자세한 내용은 롬복 사이트에 가면 자세히 설명이 되어 있습니다.  

참고

- projectlombok.org/features/all

- projectlombok.org/features/experimental/all

 

Stable

 

projectlombok.org