[Spring] CollectionUtils 활용한 null, empty 체크

자바에서 프로그래밍할 때 언제나 조심해야 하는 것은 NullPointerException이다.

실제로 최근 실무에서 null 체크를 꼼꼼히 안했다가 운영에서 에러가 찍히는 사태가 발생했다😱

 

그리고 List의 null 인지와 객체가 비었는지를 모두 확인해줘야 할 일이 생겼는데, Spring에서 제공하는 CollectionUtils을 쓰면 한 번에 체크할 수 있다는 것을 알게 되었다. 그래서 그 내용을 정리하고자 한다.

 

 

 

 

 

 

 

 

 

 

1. null vs empty

우선 null과 empty의 차이에 대해 정리해보자.

아래 그림은 null과 empty의 차이를 아주 잘 설명해주는 짤이다.

 

 

 

 

 

왼쪽 칸을 보면 휴지의 주요 내용물인 흰 부분(데이터)가 없고, 휴지를 담고 있던 휴지심(객체)는 있는 상태이다.

오른쪽 칸을 보면 휴지심(객체) 조차 없는 상태이다.

 

 

 

 

 

null

• 어떤 객체 참조가 어떤 인스턴스도 가리키고 있지 않은 상태
• 실제 객체가 메모리에 존재하지 않음

 

String str = null;
System.out.println(str.length());  // NullPointerException 발생

List<String> list = null;
System.out.println(list.size()); // NullPointerException 발생
System.out.println(list.isEmpty()); // NullPointerException 발생

 

 

• null 상태에서 메서드를 호출하면 `NullPointerException`이 발생한다.

 

 

 

 

 

empty

• 객체는 존재하지만, 그 내용이 비어 있는 상태

 

String str = "";
System.out.println(str.length());  // 0

 

List<String> list = new ArrayList<>();
System.out.println(list.size()); // 0
System.out.println(list.isEmpty()); // true

 

 

 

 

 

2. CollectionUtils

예외 상황 방어를 위해 null 인 경우와 empty인 경우 둘 다 검사해야 하는 경우가 생기게 된다.

아래와 같이 많이 쓰게 될 것이다.

 

 

 

AS-IS

• null 인 경우와 empty인 경우 둘 다 검사해야 한다.
• null에 대해 .isEmpty()를 바로 호출하면 예외가 발생하므로, 아래처럼 순서를 주의해야 한다.

if (list != null && !list.isEmpty()) {
    ...
}

 

 

 

 

 

 

이걸 한 번에 처리할 수 있는 것이 있다. springframework에서 제공하는 CollectionUtils 클래스이다.

List, Set, Map 과 같은 Collection 자료 구조에 유용한 메소드들을 제공한다.

 

* 이미 Spring 프로젝트를 사용하고 있다면 별도로 추가할 필요가 없다.

 

import org.springframework.util.CollectionUtils;

 

 

CollectionUtils

 

 

 

 

• `isEmpty()` : null 이거나 empty인 경우 모두를 검사하여, 결과 값을 boolean으로 리턴하고 있다.

 

 

 

 

 

TO-BE

• null 인 경우와 empty인 경우를 한 번에 검사할 수 있다.
• NullPointerException을 방지할 수 있다.

List<String> list1 = null;
List<String> list2 = new ArrayList<>();

if (CollectionUtils.isEmpty(list1)) { // true
    ...
}

if (CollectionUtils.isEmpty(list2)) { // true
    ...
}

 

 

 

 

 

하지만 코드의 방어를 위해 ` CollectionUtils.isEmpty()`를 무지성으로 남발하면 안된다.

null만 확인하고 싶은 경우도 있기 때문에 잘 따져서 그럴 경우에는 `list != null`만 쓰는 것이 좋다.