스프링부트에서 롬복을 쓰는 이유

스프링부트 코드를 뜯어보다가 롬복을 발견하게 되었다. 롬복(Lombok)이 뭘까?

Lombok이란

Java 기반의 프로젝트 개발시 getter, setter, toString 등 반복적으로 작성하는 코드들이 존재한다.
이런 작성 코드를 줄여주는 라이브러리가 Lombok이다.

스프링 부트는 목적에 따라 여러 패키지를 생성하여 소스코드를 관리한다.

여기서 Lombok은 어노테이션 기반으로 코드를 자동완성 해주는 라이브러리이고
이를 이용하면 Getter, Setter, Equals, ToString 등과 같은 코드를 자동완성 시킬 수 있다.

Lombok의 장점

• 어노테이션 기반의 코드 자동 생성을 통한 생산성 향상
• 코드 가독성 및 유지보수성 향상
• Getter, Setter 외에 빌더 패턴이나 로그 생성 등 다양한 방면으로 활용 가능

public class Member{
    private String id;
    private String name;

    public Member(){}

    public String getId(){
    	return id;
    }
    public void setId(String id){
    	this.id = id;
    }
    public String getName(){
    	return name;
    }
    public void setName(String name){
    	this.name = name;
    }
}

위와 같이 VO 클래스 정의를 Lombok을 이용하면 아래와 같이 간단하게 작성할 수 있다.

@Getter
@Setter
@NoArgsConstructor
public class Member{
    private String id;
    private String name;
}

여기서 다양한 어노테이션이 있는데 간단히 살펴보자면,

Lombok 사용 예제

@Getter @Setter

Lombok에서 가장 자주 활용하는 어노테이션이다. @Getter와 @Setter를 클래스 이름 위에 적용시키면 모든 변수들에 적용이 가능하고, 변수 이름 위에 적용시키면 해당 변수들만 적용 가능하다.

@Getter
public class Member{
private String id;
@Setter
private String name;
}

@AllArgsConstructor

@AllArgsConstructor는 모든 변수를 사용하는 생성자를 자동완성 시켜주는 어노테이션이다.

@Getter
@AllArgsContructor
public class Member{
private String id;
 private String name;

    /* AllArgsContructor를 통해 아래와 같은 생성자를 자동 생성할 수 있다.
    public Member(String id, String name){
      this.id = id;
      this.name = name;
    }
    */

}

@NoArgsConstructor

@NoArgsConstructor는 어떠한 변수도 사용하지 않는 기본 생성자를 자동완성 시켜주는 어노테이션이다.

@Getter
@NoArgsContructor
public class Member{
private String id;
 private String name;

    /* NoArgsContructor를 통해 아래와 같은 생성자를 자동 생성할 수 있다.
    public Member(){}
    */

}

@RequiredArgsConstructor

@RequiredArgsConstructor는 특정 변수만을 활용하는 생성자를 자동완성 시켜주는 어노테이션이다.
생성자의 인자로 추가할 변수에 @NonNull 어노테이션 또는 변수에 final로 선언해서 의존성을 주입받을 수 있다.

@Getter
@RequiredArgsContructor
public class Member extends Common{
@NonNull
private String id;
 private final String name; // final 선언

    /* RequiredArgsContructor 를 통해 아래와 같은 생성자를 자동 생성할 수 있다.
    public Member(String id, String name){
    	this.id = id;
        this.name = name;
    }
    */

}

@Data

@Data 어노테이션을 활용하면 @ToString, @EqualsAndHashCode, @Getter, @Setter, @RequiredArgsConstructor를 자동완성 시켜준다.

@Builder

@Builder 어노테이션을 활용하면 해당 클래스의 객체의 생성에 Builder패턴을 적용시켜준다.
모든 변수들에 대해 build하기를 원한다면 클래스 위에 @Builder를 붙이면 되지만,
특정 변수만을 build하기 원한다면 생성자를 작성하고 그 위에 @Builder 어노테이션을 붙여주면 된다.

@NoArgsContructor
@Getter
//@Builder // 모든 변수를 초기화 하는 builder 생성시 클래스 레벨에 선언
public class Member extends Common{

    private String id;
    private String name;
    private String phone;

    // 특정 변수만을 초기화 하려면 특정 생성자에 선언
    @Builder
    public Member(String id, String name){
    	this.id = id; 
        this.name = name;
    }

    /*
    @Builder 선언시 Lombok에 의해 빌더생성을 위한 다음의 코드가 생성됨.
    public static Member.MemberBuilder builder() {
        return new Member.MemberBuilder();
    }

    public static class MemberBuilder {
        private String id;
        private String name;

        MemberBuilder() {
        }

        public Member.MemberBuilder id(final String id) {
            this.id = id;
            return this;
        }

        public Member.MemberBuilder name(final String name) {
            this.name = name;
            return this;
        }

        public Member build() {
            return new Member(this.id, this.name);
        }

        public String toString() {
            return "Member.MemberBuilder(id=" + this.id + ", name=" + this.name + ")";
        }
    }
    */

}

빌더를 생성했다면 아래와 같이 사용하면 된다.

public class MemberController{
 
    public ResponseEntity init(){

        // 빌더 패턴을 이용한 객체 생성
        Member member = Member.builder()
            .id("hong")
            .name("홍길동")
            .build();

        return ResponseEntity.ok(member);
    }

}