DEV ℧ Developer Diary

[EffectiveJava] item54 - null이 아닌, 빈 컬렉션이나 배열을 반환하라

04 Jul 2023

null 반환 코드

먼저 예시를 살펴보자 주변에서 흔히 볼 수 있는 메서드 이다.

private final List<Cheese> cheesesInStock = ...;

/**
 * @return 매장 안의 모든 치즈 목록을 반환한다.
 *     단, 재고가 하나도 없다면 null을 반환한다.
 */
public List<Cheese> getCheeses() {
    return cheesesInStock.isEmpty() ? null
        : new ArrayList<>(cheesesInStock)
}

재고가 없다고 해서 특별히 취급할 이유는 없다. 그럼에도 이 코드처럼 null을 반환한다면, 클라이언트는 이 null 상황을 처리하는 코드를 항상 추가로 작성해야 한다.

List<Cheese> cheeses = shop.getCheeses();
if (cheese != null && cheese.contains(Cheese.STILTON))
    System.out.println("좋았어, 바로 그거야.");

컬렉션이나 배열같은 컨테이너(container)가 비었을 때 null을 반환하는 메서드를 사용할 때면 항시 이와 같은 방어 코드를 넣어줘야 한다. 방어 코드를 빼먹으면 오류가 발생할 수 있다.

null or 빈 컨테이너?

빈 컨테이너를 할당하는 데도 비용이 드니 null을 반환하는 쪽이 낫다는 주장이 있다. 이는 두 가지 면에서 틀린 주장이다.

첫 번째, 성능 분석결과 이 할당이 성능 저하의 주범이라고 확인되지 않는 한, 이 정도의 성능 차이는 신경 쓸 수준이 못된다. 두 번째, 빈 컬렉션과 배열은 굳이 새로 할당하지 않고도 반환할 수 있다.

빈 컬렉션을 반환하는 올바른 예

public List<Cheese> getCheeses() {
    return new ArrayList<>(cheesesInStock);
}

가능성은 작지만, 사용 패턴에 따라 빈 컬렉션 할당이 성능을 눈에 띄게 떨어뜨릴 수도 있다.

해법은 간단하다. 매번 똑같은 빈 ‘불변’컬렉션을 반환 하는 것이다. 알다시피 불변객체는 자유롭게 공유해도 안전하다.(Item17)

불변 컬렉션을 반환하는 메서드

  • List : Collections.emptyList
  • Set : Collections.emptySet
  • Map : Collections.emptyMap

아래의 코드와 같이 사용할 수 있다.

최적화 - 빈 컬렉션을 새로 할당하지 않도록 했다.

public List<Cheese> getCheese() {
    return cheesesInStock.isEmpty() ? Collections.emptyList()
        : new ArrayList<>(cheesesInStock);
}

배열의 빈 컨테이너 반환

배열을 쓸 때도 마찬가지다. 절대 null을 반환하지 말고 길이가 0인 배열을 반환하라.

길이가 0일 수도 있는 배열을 반환하는 올바른 방법

public Cheese[] getCheeses() {
    return cheesesInStock.toArray(new Cheese[0]);
}

이 방식이 성능을 떨어뜨릴 것 같다면 길이 0짜리 배열을 미리 선언해두고 매번 그 배열을 반환하면 된다. 길이 0인 배열은 모두 불변이기 때문이다.

최적화 - 빈 배열을 매번 새로 할당하지 않도록 했다.

private static final Cheese[] EMPTY_CHEESE_ARRAY = new Cheese[0];

public Cheese[] getCheeses() {
    return cheesesInStock.toArray(EMPTY_CHEESE_ARRAY);
}

최적화 버전에서는 getCHeeses는 항상 EMPTY_CHEESE_ARRAY를 인수로 넘겨 toArray를 호출한다. 따라서 cheesesInStock이 비었을 때면 언제나 EMPTY_CHEESE_ARRAY를 반환하게 된다.

<T> T[] List.toArray(T[] a) 메서드는 주어진 배열 a가 충분히 크면 a 안에 원소를 담아 반환하고, 그렇지 않으면 T[] 타입 배열을 새로 만들어 그 안에 원소를 담아 반환한다.
위의 예시에서는 원소가 하나라도 있다면 Cheese[] 타입의 배열을 생성해 반환하고, 원소가 0개면 EMPTY_CHEESE_ARRAY를 반환한다.

단순히 성능을 개선할 목적이라면 toArray에 넘기는 배열을 미리 할당하는 건 추천하지 않는다. 오히려 성능이 떨어진다는 연구 결과도 있다.

나쁜 예 - 배열을 미리 할당하면 성능이 나빠진다.

return cheesesInStock.toArray(new Cheese[cheesesInStock.size()]);

Related posts