[Java] - Project Lombok(롬복)

• 안녕하세요~ 이전에 운영하던 블로그 및 GitHub, 공부 내용을 정리하는 Study-GitHub 가 있습니다!

• 네이버 블로그

• GitHub

• Study-GitHub

• 🐔

---

📎 Lombok(롬복)

 

안녕하세요! 이번에 정리할 내용은 Project Lombok(롬복) 입니다.

Lombok은 Java 라이브러리로, 자바 개발자라면 대부분 한 번쯤은 사용해보지 않았을까 하는 정~말 많이 사용하는 라이브러리입니다.

저 또한 평소에 개발을 할 때 Lombok 라이브러리 없이는 개발을 못 할 정도로(?) 많이 사용을 하는데요.. ㅎㅎ

 

이번 시간에는 Lombok 이란 무엇인지, 어떻게 사용하는지와 장단점에 대해 살펴보겠습니다 :)

 

간략하게 목차를 나타내면 다음과 같습니다!

• Lombok 이란?
• Lombok 설치
• Lombok 다양한 어노테이션
• Lombok은 무조건 좋을까요?

 

 

 

🎯  Lombok 이란?

먼저 Lombok 이 무엇인지 알아보겠습니다!

Lombok의 공식문서에는 다음과 같이 설명을 하고 있습니다.

 

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

 

=> Project Lombok은 Java 개발의 속도를 높이고, 편집기와 빌드 도구에 자동으로 연결되는 자바 라이브러리의 플러그인이다.

getter나 equals 같은 메서드를 다시는 사용하지 말아라, 단 하나의 어노테이션으로 클래스는 완벽한 기능을 가진 빌더, 로깅 변수 자동화, 기타 등등의 기능이 있다.

 

즉, getter, setter, equals 등의 메소드와 동등하게 작동하는 기능을 어노테이션만으로 적용할 수 있는 강력한 기능인데요. 

간단하게 코드로 살펴보면 다음과 같습니다.

 

 

(Lombok의 작동 원리에 대해 궁금하시면 아래 사이트를 참조해주세요 !)

https://free-strings.blogspot.com/2015/12/lombok.html

Lombok은 어떻게 동작되나? 간단정리

https://docs.oracle.com/javase/8/docs/api/javax/annotation/processing/Processor.html

Processor (Java Platform SE 8 )

 

 

 

Lombok 없이 사용하는 기존 자바 코드

public class InflearnModel {

    private Long id;            // PK
    private String imageUrl;    // 썸네일
    private String title;       // 강의 제목
    private int price;          // 정가
    private int salePrice;      // 할인 가격
    private float rating;       // 평점
    private String instructor;  // 강의자
    private String url;         // 강의 페이지 링크
    private int viewCount;      // 수강자 수
    private String platform;    // 플랫폼 이름
    private int sessionCount;   // 강의 세션 개수
    private String currency;    // 원화
    private String description; // 강의 부연설명
    private String skills;      // 강의 스택

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getImageUrl() {
        return imageUrl;
    }

    public void setImageUrl(String imageUrl) {
        this.imageUrl = imageUrl;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public int getPrice() {
        return price;
    }

    public void setPrice(int price) {
        this.price = price;
    }

    public int getSalePrice() {
        return salePrice;
    }

    public void setSalePrice(int salePrice) {
        this.salePrice = salePrice;
    }

    public float getRating() {
        return rating;
    }

    public void setRating(float rating) {
        this.rating = rating;
    }

    public String getInstructor() {
        return instructor;
    }

    public void setInstructor(String instructor) {
        this.instructor = instructor;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public int getViewCount() {
        return viewCount;
    }

    public void setViewCount(int viewCount) {
        this.viewCount = viewCount;
    }

    public String getPlatform() {
        return platform;
    }

    public void setPlatform(String platform) {
        this.platform = platform;
    }

    public int getSessionCount() {
        return sessionCount;
    }

    public void setSessionCount(int sessionCount) {
        this.sessionCount = sessionCount;
    }

    public String getCurrency() {
        return currency;
    }

    public void setCurrency(String currency) {
        this.currency = currency;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getSkills() {
        return skills;
    }

    public void setSkills(String skills) {
        this.skills = skills;
    }
    
    ...
}

위 코드를 살펴보면 다른 기능은 일절없이 필드와 getter, setter 메소드만 존재하는 클래스인데요,

필드가 늘어남에 따라 getter, setter 메소드도 같이 작성을 해야하기 때문에 중복 코드가 너무나 많아지는 단점이 존재합니다.

(물론, 이런 많은 필드를 가진 클래스를 생성하는 것은 지양하는게 좋다고 생각합니다.)

 

위 코드만으로도 충분히 장황하기 때문에 생성자나 equals, HashCode, toString 등등의 메소드는 제외했습니다.

물론 InflearnModel 클래스 자체에 필드가 많기는 하지만, 전부 비슷 비슷한 getter, setter 메소드를 추가하다 보니 배보다 배꼽이 더 커진(?) 상황이 된 것 같습니다.

 

위와 같은 장황한 코드에 Lombok을 사용하면 마법같은(?) 일이 일어나게 됩니다.

 

 

 

Lombok을 사용한 (마법의) 자바 코드

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class InflearnModel {

    private Long id;            // PK
    private String imageUrl;    // 썸네일
    private String title;       // 강의 제목
    private int price;          // 정가
    private int salePrice;      // 할인 가격
    private float rating;       // 평점
    private String instructor;  // 강의자
    private String url;         // 강의 페이지 링크
    private int viewCount;      // 수강자 수
    private String platform;    // 플랫폼 이름
    private int sessionCount;   // 강의 세션 개수
    private String currency;    // 원화
    private String description; // 강의 부연설명
    private String skills;      // 강의 스택

}

Lombok을 사용하게 되면 코드가 정~~~~~~말 간결해지는데요, 개인적으로 자바 코드가 장황하다고 느끼는 이유 중 하나가 위와 같은 보일러 플레이트 코드성의 getter, setter와 같은 메소드 때문이라고 생각합니다.

 

위에서 작성한 모든 getter, setter 메소드를 단 2줄의 @Getter, @Setter 어노테이션을 통해 간략하게 나타낼 수 있습니다.

(더 심플하게 한줄로 나타내려면 @Getter @Setter로 나타낼수도 있습니다 ㅎㅎ..)

 

그럼 이런 Lombok은 장점만 있는걸까요? 아래에서 좀 더 살펴보겠습니다 !

 

 

 

🎯  Lombok 설치

IntelliJ 기반으로 Lombok을 설치하는 방법에 대해 알아보겠습니다!

(호옥시 Eclipse에서 Lombok을 설치하시는 분은 여기 를 참고해주세요 !)

 

먼저 라이브러리를 추가합니다.

build.gradle

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter'

	//lombok 라이브러리 추가 시작
	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.projectlombok:lombok'
	testCompileOnly 'org.projectlombok:lombok'
	testAnnotationProcessor 'org.projectlombok:lombok'
	//lombok 라이브러리 추가 끝

	testImplementation('org.springframework.boot:spring-boot-starter-test') {
		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
	}
}

 

 

pom.xml

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.16</version>
            <scope>provided</scope>
        </dependency>

 

 

Plugins에서 lombok을 검색한 후 Lombok 을 설치합니다.

File > Settings > Plugins 에서 lombok 검색 후 설치

 

 

Annotation Processors 설정

File > Settings > Annotation Processors 검색 후 Enable annotation processing 체크

위 과정이 끝나면 Lombok 을 사용할 수 있는 환경이 구축되었습니다.

 

 

 

 

🎯  Lombok의 다양한 어노테이션

Lombok에서 주로 사용하는 어노테이션은 다음과 같습니다.

@Getter   // getter() 메소드 
@Setter   // setter() 메소드
@Builder  // Builder 패턴
@ToString // Object의 toString() 구현 
@EqualsAndHashCode // Object의 equals() & hashCode() 구현
@NoArgsConstructor // 매개변수 없는 생성자(디퐅트 생성자)
@RequiredArgsConstructor // 필수 값만 가지는 생성자
@AllArgsConstructor // 모든 필드를 가지는 생성자
@Data // @ToString, @Getter, @Setter, @EqualsAndHashCode, @RequiredArgsConstructor 어노테이션을 포함
public class InflearnModel {
    ...

사실 Lombok의 어노테이션의 경우 네이밍이 잘되어있기 때문에, 이름만 보더라도 무슨 기능을 하는지 유추할 수 있습니다 😊

특히 @Data 어노테이션의 경우, 위에 정의한 @Getter, @Setter, @ToString ... 등등의 어노테이션을 모두 포함하고 있는 기능입니다.

 

다양한 Lombok 의 기능들을 살펴보고 싶으면 아래 공식문서를 참조해주시면 됩니다 :)

https://projectlombok.org/features/all

Stable

 

 

---

🧐 그럼 다른 어노테이션들을 포함하고 있는 @Data 어노테이션만 사용하면 되는게 아닌가요?

※ 아래는 제 개인적인 생각입니다 :)

언뜻보기에 @Data는 많은 어노테이션을 포함하고 있기 때문에 이 어노테이션이 만능인 것 처럼 보이지만, 실제로는 그렇지 않습니다.

그렇게 생각하는 이유는 @Setter 어노테이션으로 인해 객체의 불변성을 보장하지 못하기 때문입니다.

 

이펙티브 자바 3/E 도서에 다음과 같은 내용이 있습니다.

아이템 15 - 클래스와 멤버의 접근 권한을 최소화하라

아이템 17- 변경 가능성을 최소화하라

 

위 주제에서 얘기하는 내용으로 클래스를 가능한 immutable(불변) 하게 만들고,

변경 가능성을 최소화하라 라고 저자는 말을 하고 있는데요,

책의 아이템에는 다음과 같은 내용들이 있습니다.

• 객체의 상태를 변경하는 메소드를 제공하지 않는다. -> setter() 메소드 등
• (가능한) 모든 필드를 final로 선언
• 모든 필드를 private로 선언

하지만 @Data 어노테이션을 사용하게 되면 해당 클래스에는 @Setter 어노테이션이 자동으로 적용되고,

객체가 불변을 보장하지 못하기 때문에 해당 객체가 무분별하게 수정될 가능성이 존재합니다.

 

따라서 해당 어노테이션(@Data)의 사용은 지양하는게 좋다고 생각합니다.

---

 

마지막으로 Lombok을 무조건 사용하는게 좋은지, 다른 사이드 이펙트 등은 없는지에 대해 간략히 살펴보겠습니다.

(JPA를 사용할 경우, 양방향 관계에서 @ToString 어노테이션을 적용하면 순환참조로 인해 Stack over flow가 발생할 수 있기 때문에 유의해서 사용해야 합니다)

 

 

 

 

🎯  Lombok은 무조건 좋을까요?

사실 이전에 일부 글들과 몇몇 분들에게 "Lombok의 사용은 최대한 지양하라" 라는 내용을 들은적이 있습니다.

 

위에서 정리한 내용만 봤을때는 코드도 단순해지고, 생산성도 높아간다고 나와있는데 왜 지양하라고 했었을까요?

개인적인 생각으로는, Lombok을 잘못 사용하게 되면 몇몇 사이드 이팩트가 있기 때문이라고 생각합니다.

또한 다른 분의 강의에서 "Lombok의 마법은 언젠가 댓가를 치루게 됩니다." 라는 강의를 들은적이 있습니다.

(저는 아직 다행히(?) Lombok 사용의 댓가를 치루지는 않았습니다..😂)

• JPA에서 연관관계의 엔티티에 @ToString() 어노테이션을 적용하게 되면 무한 순환 참조 문제 ..
• JPA에서 엔티티에 @Getter을 적용하고, boolean 자료형의 변수명이 is로 시작하는 경우(?)
• 자바 <--> 코틀린 변환 문제(?)

 

위 2번째와 3번째는 얼핏 들어보았던 내용인지라 확실하지는 않지만, 기타 Lombok의 기능에 대해 정확히 알지 못한 체 사용한다면 위와 같이 사이드 이펙트가 발생할 수 있습니다.

저는 코딩 경력이 얼마 안되기에 Lombok을 사용하며 발생했던 사이드 이펙트는 존재하지 않지만, 개인적으로는 최대한 Lombok을 지양하자고 생각은 하지만 실제 편리한 어노테이션이 너무나 많기에 개발을 할 때 종종 사용을 할 것 같습니다 🤔

 

물론 추후에 개발을 하면서 Lombok으로 인한 엄청난 손해 비용을 겪게된다면,

그때는 이 글이 Lombok에 대한 비판과 함께 사용을 지양하라고 변경될 수도 있습니다 ... 😂

 

 

 

Lombok의 사용에 대한 다른 분들의 의견을 좀 더 확인해보고싶으면 아래 링크들을 확인해보시면 좋을 것 같습니다!

(저는 Lombok을 사용하는게 편리하기 때문에 링크들은 대부분 Lombok을 사용을 지양하라는 포스팅이 많습니다.)

• https://artofcode.wordpress.com/2018/12/18/dont-use-lombok/
• https://ppbruna.medium.com/why-you-should-not-use-lombok-f7556662e8c3
• https://medium.com/@vgonzalo/dont-use-lombok-672418daa819
• https://stackoverflow.com/questions/3852091/is-it-safe-to-use-project-lombok
• https://blogg.itverket.no/to-lombok-or-not-to-lombok/

 

아래 글은 여러 사례를 통해 Lombok의 사용을 지양하라고 나와있는 좋은 글인것 같습니다.

• https://levelup.gitconnected.com/be-careful-with-lombok-2e2edfc01110

 

 

 

 

🎯  References

• https://projectlombok.org/
• https://www.daleseo.com/lombok-popular-annotations/
• https://free-strings.blogspot.com/2015/12/lombok.html