@Builder를 통해 안전하게 객체 생성하기

문제상황

member 객체 생성 시 편한 방식으로 객체를 생성하기 위해 lombok의 @Builder을 사용하였다.

member 클래스에 필요한 필드를 대상으로 생성자 생성 후 @Builder을 붙여 builder 객체를 생성하게 하였다.

@Builder
public Member(String id, String password, String userName, String email) {
    this.id = id;
    this.password = password;
    this.userName = userName;
    this.email = email;
}

하지만 필드에 null이 들어왔을 경우가 고려되지 않았다.

 

@Builder에 의해 컴파일 시 생성된 어노테이션 프로세싱 결과를 확인해 보자

public static class MemberBuilder {
    private String id;
    private String password;
    private String userName;
    private String email;

    MemberBuilder() {
    }

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

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

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

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

    public Member build() {
        return new Member(this.id, this.password, this.userName, this.email);
    }

    public String toString() {
        return "Member.MemberBuilder(id=" + this.id + ", password=" + this.password + ", userName=" + this.userName + ", email=" + this.email + ")";
    }
}

@Builder으로는 생성자 매개변수에 대해 final로 선언되어 재할당에는 안전하지만, null에 대한 체크는 없기에 개발자가 추가적인 null 체크 로직을 추가해야 한다.

 

해결 방법

1. 필수로 값이 세팅되어야 하는 필드는 builder 생성자 매개변수 앞에 @NotNull을 붙인다.

@Builder
public Member(@NotNull String id, @NotNull String password, String userName, String email) {
    this.id = id;
    this.password = password;
    this.userName = userName;
    this.email = email;
}

 

2. Assert 구문으로 null에 대한 검사를 한다.

@Builder
public Member(String id, String password, String userName, String email) {
    Assert.notNull(password,"id는 필수값 입니다.");
    Assert.notNull(password,"password는 필수값 입니다.");

    this.id = id;
    this.password = password;
    this.userName = userName;
    this.email = email;
}

Assert

Spring에서 제공하는 매개변수 유효성 검사 유틸 클래스로, runtime시 프로그래머가 에러를 일찍 인식할 수 있게 도와준다. Assert 구문에 맞지 않을 경우 exception을 발생시킨다.

notNull(object)는 스프링 6.1 버전에서 제거 예정이므로 notNull(object, message) 메서드를 사용할 것을 권장한다.

코드의 길이를 간결하게 해 주고 필드가 많아도 안전하게 객체를 생성할 수 있는 @Builder 지만 편하게 쓰는 만큼 안전성에도 유의하며 사용해야겠다.

 

---

[참고]

https://projectlombok.org/features/Builder

https://lemontia.tistory.com/913

https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/util/Assert.html