📌Lombok이란?

Java로 개발을 하다보면 getter, setter, constructor작성 등의 많은 코드를 작성해야한다. Lombok은 이러한 기계적인 코드들을 어노테이션을 기반으로 코드를 자동화하여 작성해주는 Java의 라이브러리이다.

• Lombok을 사용하면 코드의 길이를 줄여 코드를 단순화하고 코드의 가독성을 키울 수 있다.
• 코드 자동 생성을 통해 생산성이 향상된다.
• 반복되는 코드의 다이어트를 통한 가독성 및 유지보수성을 향상시킨다.

Lombok사용 설정

저는 IntelliJ환경에서 학습을 하고 있기에 IntelliJ기준으로 설명을 드리겠습니다.

IntelliJ에서 Lombok을 사용할 환경을 만들려면 프로젝트 생성시에 아래 사진과 같이 Developer Tools에 위치한 Lombok을 선택하여 프로젝트를 생성해주면 됩니다.

만약 프로젝트 생성시에 추가를 하지 못하였을 경우 build.gradle의 dependencies에 아래의 코드를 추가한 후 dependency update를 해주면 됩니다.

compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'

📌Lombok사용 예제

@Getter, @Setter

public class User {
    private String name;
    private String email;
    private LocalDateTime createdAt; // 생성된 시간
    private LocalDateTime updatedAt; // 업데이트된 시간

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public LocalDateTime getCreatedAt() {
        return createdAt;
    }

    public void setCreatedAt(LocalDateTime createdAt) {
        this.createdAt = createdAt;
    }

    public LocalDateTime getUpdatedAt() {
        return updatedAt;
    }

    public void setUpdatedAt(LocalDateTime updatedAt) {
        this.updatedAt = updatedAt;
    }
}

Lombok을 사용하지 않는다면 우리는 User class에서 getter와 setter 메서드를 구현하기 위해서는 위와 같이 변수 하나씩 선언을 해줘야한다. 위의 User class에서는 변수가 4개밖에 없어도 getter, setter를 만드는데에만 8개의 메서드가 만들어졌으나 실제 DTO를 생성하다보면 훨씬 더 많은 변수들을 만들게 될 것이고 그에 따라 선언하는 메서드의 수도 크게 늘어날 것이다.

이러한 코드들은 Lombok의 @Getter, @Setter 어노테이션을 사용하면 코드를 단순화 시킬 수 있다.

@Getter
public class User {
    
    @Setter
    private String name;
    
    private String email;
    private LocalDateTime createdAt; // 생성된 시간
    private LocalDateTime updatedAt; // 업데이트된 시간
}

@Getter, @Setter는 class전체에 할 수도 있으며 특정 변수에만 지정할 수도 있다.
특정 변수에 대해서만 지정할 경우 위의 name위에 위치한 @Setter처럼 변수 위에 지정하면 된다.

@ToString

public class User {
    private String name;
    private String email;
    private LocalDateTime createdAt; // 생성된 시간
    private LocalDateTime updatedAt; // 업데이트된 시간

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", email='" + email + '\'' +
                ", createdAt=" + createdAt +
                ", updatedAt=" + updatedAt +
                '}';
    }
}

toString의 경우도 Overriding을 하며 새로 지정해야하는 번거로움이 있었으나 Lombok을 사용하면 아래와 같이 @ToString 어노테이션을 붙임으로서 단순화시킬 수 있다.
@ToString(exclude = "regionMoneyName")와 같이 특정 변수를 제외시킬 수도 있다.

@ToString
public class User {
    private String name;
    private String email;
    private LocalDateTime createdAt; // 생성된 시간
    private LocalDateTime updatedAt; // 업데이트된 시간

}

@NoArgsConstructor

parameter없이 생성되는 기본 constructor를 생성해주는 annotation이다.

@NoArgsConstructor
public class User {
    private String name;
    private String email;
    private LocalDateTime createdAt; // 생성된 시간
    private LocalDateTime updatedAt; // 업데이트된 시간

    // public User() { }  해당 코드가 생략된다.
}


User user = new User();

@AllArgsConstructor

@NoArgsConstructor가 아무런 변수를 받지 않는 Constructor를 만들어주는 Annotation이었다면 @AllArgsConstructor은 객체가 갖고 있는 모든 변수를 받는 constructor를 만들어준다.

@AllArgsConstructor
public class User {
    private String name;
    private String email;
    private LocalDateTime createdAt; // 생성된 시간
    private LocalDateTime updatedAt; // 업데이트된 시간

//    아래의 constructor를 @AllArgsConstructor이 대신 만들어준다.
//    public User(String name, String email, LocalDateTime createdAt, LocalDateTime updatedAt) {
//        this.name = name;
//        this.email = email;
//        this.createdAt = createdAt;
//        this.updatedAt = updatedAt;
//    }
}

@RequiredArgsConstructor, @NonNull

꼭 필요한 변수만을 사용하는 construtor를 만들어주는 annotation이다. 필수적으로 사용되야하는 변수들은 @NonNull을 붙여서 설정한다. 아니면 해당 변수를 final로 선언해도 의존성을 주입받을 수 있다.

@RequiredArgsConstructor
public class User {
    @NonNull // @RequiredArgsConstructor에서 사용될 field들을 지정
    private String name;
    
    @NonNull
    private String email;
    
    private LocalDateTime createdAt; // 생성된 시간
    private LocalDateTime updatedAt; // 업데이트된 시간


//    public User(String name, String email) {
//        this.name = name;
//        this.email = email;
//    }
}

@EqualsAndHashCode

equals method와 hashcode method를 자동으로 생성해준다. 서로 다른 두 객체에서 특정 변수의 이름이 똑같은 경우 같은 객체로 판단을 하고 싶은 경우 사용하면 된다.

@EqualsAndHashCode(of = {"name", "email"})
public class User {
    private String name;
    private String email;
    private LocalDateTime createdAt; // 생성된 시간
    private LocalDateTime updatedAt; // 업데이트된 시간
}

위의 코드에서는 다른 객체에서도 name, email가 동일하다면 같은 객체로 인식하겠다~라는 의미를 가진다.

@Data

entity객체를 사용하며 실습을 할 때는 가장 많이 사용하게 된다.
@Data는 @Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode.를 모두 포함하는 annotaion이다. 하지만 실무에서는 너무 무겁고 객체의 안정성을 지키기 때문에 @Data의 활동을 지양한다고 한다.

@Builder

다수의 필드를 가지는 복잡한 클래스의 경우, 생성자 대신에 빌더를 사용하는 경우가 많다
@AllArgsConstructor와 비슷하게 객체를 생성하고 변수값을 주입해주는데 객체의 생성을 builder의 형식으로 제공해준다. @Builder도 모든 변수들에 대해서 build하기를 원하면 Class위에 붙이고 특정 변수에 대해 build하기를 원한다면 생성자를 작성하고 그 위에 annotation을 붙여준다.

Reference

• Fast Campas - 한번에 끝내는 Java/Spring 웹 개발 마스터 초격차 패키지 Online.
• https://mangkyu.tistory.com/78
• https://goddaehee.tistory.com/95