본문 바로가기
Effective Java

[Effective Java] 아이템32 제네릭과 가변인수를 함께 쓸 때는 신중하라

by byeongoo 2021. 5. 30.

■ 가변인수와 제네릭을 함께 사용할 경우 헛점

가변인수 메서드를 호출하면 가변인수를 담기 위한 배열이 자동으로 하나 만들어진다. 그런데 내부로 감춰야 했을 이 배열을 그만 클라이언트에 노출하는 문제가 생겼다. 그 결과 varargs 매개변수에 제네릭이나 매개변수화 타입이 포함되기 알기 어려운 컴파일 경고가 발생한다. 

warning: [unchecked] Possible heap pollution from 
    parameterized vararg type List<String>

 

매개변수화 타입의 변수가 타입이 다른 객체를 참조하면 힙 오염이 발생한다. 힙오염이란 객체가 특정 제네릭 타입 인스턴스에 속해야하지만 실제로는 다른 인스턴스에 속하는 현상을 의미한다. 다음 메서드를 통해서 확인해보자.

static void danferous(List<String>... stringLists) {
    List<Integer> intList = List.of(42);
    Object[] objects = stringLists;
    objects[0] = intList; // 힙 오염 발생
    String s = stringLists[0].get(0); // ClassCastException
}

 

위의 메서드에서는 형변환하는 곳이 보이지 않지만 호출 시 ClassCaseException을 던진다. 마지막줄에 컴파일러가 생성한 보이지 않는 형변환이 숨어 있기 때문이다.

 

제네릭과 varargs를 혼용하면 타입 안정성이 깨진다. 따라서 제네릭 varargs 배열 매개변수에 값을 저장하는 것은 안전하지 않다. 제네릭 배열을 프로그래머가 직접 생성하는 건 허용하지 않고 제네릭 varargs 매개변수를 받는 메서드를 선언할 수 있게 한 이유는 실무에서 매우 유용하기 때문이다.

 

사실 자바 라이브러리도 이런 메서드를 여럿 제공하는데, Arrays.asList(T... a), Collections.addAll(Collection<? super T> c, T... elements), EnumSet.of(E first, E...rest)가 대표적이다.

 

@SafeVarargs 애너테이션

자바 7전에는 제네릭 가변인수 메서드의 작성자가 호출자 쪽에서 발생하는 경고에대해서 해줄 수 있는 일이 없었다. 그래서 호출하는 곳에서 그대로 냅두거나 @SuppressWarnings("unchecked") 애너테이션을 달아 경고를 숨겨야했다.

 

자바7에서는 @SafeVarargs 애너테이션이 추가되어 제네릭 가변인수 메서드 작성자가 클라이언트 측에서 발생하는 경고를 숨길 수 있게됐다. @SafeVarargs 애너테이션은 메서드 작성자가 그 메서드가 타입 안정함을 보장하는 장치이다.

 

■ 메서드 안전 보장

메서드가 안전함을 확신할 수 있을 때는 해당 메서드가 순수하게 인수들을 전달하는 일만 할 때 안전하다.

  • 메서드가 varargs 매개변수를 담는 배열에 아무것도 저장하지 않을 때
  • varargs 배열의 참조가 밖으로 노출되지 않을 때

이 메서드가 반환하는 배열의 타입은 이 메서드에 인수를 넘기는 컴파일 타임에 결정되는데, 그 시점에는 컴파일러에게 충분한 정보가 주어지지 않아 타입을 잘못 판단할 수 있다.

static <T> T[] toArray(T... args) {
    return args;
}

 

구체적인 예시를 보자. 다음 메서드는 T타입 인수 3개를 받아 그중 2개를 무작위로 골라 담은 배열을 반환한다.

static <T> T[] pickTwo(T a, T b, T c) {
    switch(ThreadLocalRandom.current().nextInt(3)) {
    case 0: return toArray(a, b);
    case 0: return toArray(a, b);
    case 0: return toArray(a, b);
    }
    throw new AssertionError(); // 도달할 수 없다. 
}

 

이 메서드는 제네릭 가변인수를 받는 toArray 메서드를 호출한다는 점만 빼면 위험하지도 않고 경고도 내지 않는다. 하지만 실행하려 들면 ClassCastException을 던진다. Object[]는 String[]의 하위 타입이 아니므로 이 형변환은 실패하기 때문이다.

 

다음은 제네릭 varargs 매개변수를 안전하게 사용하는 전형적인 예다. 다음의 flattern 메서드는 임의 개수의 리스트를 인수로 받아, 받은 순서대로 그 안의 모든 원소를 하나의 리스트로 옮겨 담아 반환한다.

@SafeVarargs
static <T> List<T> flatten(List<? extends T>... lists) {
    List<T> result = new ArrayList<>();
    for (List<? extends T> list : lists)
    result.addAll(list);
    return result;
}

 

■ 정리

가변인수제네릭은 궁합이 좋지 않다. 가변인수 기능은 배열을 노출하여 추상화가 완벽하지 못하고, 배열제네릭의 타입 규칙이 서로 다르기 때문이다. 메서드에 제네릭 (혹은 매개변수화된) varags 매개변수를 사용하고자 한다면, 먼저 그 메서드가 타입 안전한지 확인한 다음 @SafeVarargs 애너테이션을 달아 사용하는 데 불편함이 없게끔 하자.