[Spring] 롬복을 사용한 Builder 패턴 Null체크 하며 사용하기

😒개요

기존 코드가 롬복의 @Builder를 사용하여 빌더 패턴을 구현했는데, 사용하다 보니 필드 값이 많아 질 때, 대충 맞겠지 하면서 값을 입력했더니, 개발하다 보니 Builder를 통해 인스턴스 생성시, 나중에 null이 들어가는 부분이 계속 생겨났다. 그냥 내 실수려니 하고 넘어가다가 반복되니, 이건 코드의 문제다 싶어서, 객체 초기화 할 때, 간단하게 필수 값을 검증해야겠다! 라는 생각부터 시작되게 되었다.

이런 식의 코드처럼.. title을 빼먹는다거나…

👍해결방법

1. 직접 Null 체크

가장 직접적인 방법은 Null체크 하는 메서드를 실제로 만들어서 체크하는 방법이다.

 	  
class Post {
    private final String title;
    private final String content;
		
    @Builder
    private Post(String title, String content) {
        checkNull(title, "title이 Null일 수 없습니다.");
        checkNull(content, "content가 Null일 수 없습니다.");
        this.title = title;
        this.content = content;
    }

    private void checkNull(Object o, String msg) {
        if (o == null) {
           throw new NullPointerException(msg);
        }
    }
}

우선 @AllArgsConstrucor는 인스턴스 선언 순서에 영향을 받기 때문에 직접 생성자를 생성하여 생성자 위에@Builder (lombok document 권장)를 붙이고 checkNull메서드를 만들어 Null일시 NullPointerException을 반환하도록 하였다..

더 나아가 파라미터가 많아지거나 , 검증 메서드를 분리하고 싶다면,

class Post {
    private final String title;
    private final String content;

    @Builder
    private Post(String title, String content) {
        checkNullParams(List.of(title, content));
        this.title = title;
        this.content = content;
    }

    private void checkNull(Object o) {
        if (o == null) {
           throw new NullPointerException();
        }
    }

    private void checkNullParams(List<Object> params) {
        params.forEach(this::checkNull);
    }
}

위와 같이 사용할 수도 있을 것이다.

2. 롬복의 @NonNULL사용

class Post {
    private final String title;
    private final String content;

    @Builder
    private Post(@NonNull String title, @NonNull String content) {
        this.title = title;
        this.content = content;
    }
}

 

생성자의 필수 값 파라미터 앞에 @NonNull을 붙여 생성될 때 변수의 null을 체크할 수 있다.

Post p = Post.builder()
                .title("t")
                .build();

위의 코드와 같이 content값을 빼먹는다면,

다음과 같이 NullPointerException을 띄울 것이다.

3. Assert 사용

class Post {
    private String title;

    private String content;

    @Builder
    private Post(String title, String content) {
        Assert.notNull(title, "title이 Null일 수 없습니다.");
        Assert.notNull(content, "content가 Null일 수 없습니다.");
        this.title = title;
        this.content = content;
    }
}

스프링 유틸에 있는 Assert의 notNull을 활용할 수도 있다. 위와 같이 필수 값에 Assert로 검증 해볼 수 있다. 

public static void notNull(@Nullable Object object, String message) {
		if (object == null) {
			throw new IllegalArgumentException(message);
		}
	}

Assert.notNull메서드가 다음과 같이 구현되어 있으며, 메시지를 설정할 수 있다. 사실 직접 구현한 코드와 다르지 않아 큰 차이는 없다.

content를 제외하고 생성했을 때 뜨는 오류 메시지는 다음과 같다.

👉정리

간단한 Null처리를 할 때에는 @NonNull을 사용하는 것이 코드 량을 줄일 수도 있고 간편해서 적합할 것이다.

원하는 오류 메시지를 출력하여 오류에 대한 가독성을 높일 때, Assert를 사용하여 구현하는 방법이 있다.

예외에 대한 추가적인 처리를 할 때(ex. 커스텀 예외를 띄워야 한다거나 등)에 직접 구현하는 방법도 생각해 볼 수 있을 것 같다.