[Effective Java] item 32. 제네릭과 가변인수를 함께 쓸 때는 신중해라

[Effective Java] item 32. 제네릭과 가변인수를 함께 쓸 때는 신중해라

핵심 정리

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

---

가변인수

public static void display(String ...infos) {
    for (String info: infos) {
        System.out.println(s);
    }
}

• 가변인수는 메서드에 넘기는 인수의 개수를 클라이언트가 조절할 수 있게 해준다.

가변인수와 제네릭

• 가변인수(varargs) 메서드와 제네릭은 자바 5 때 함께 추가되었지만 잘 어우러지지 않는다.
• 가변인수 메서드를 호출하면 가변인수를 담기 위한 배열이 자동으로 하나 만들어진다.
• 그런데 내부로 감춰야 했을 이 배열을 그만 클라이언트에 노출하는 문제가 생겼다. 그 결과 varargs 매개변수에 제네릭이나 매개변수화 타입이 포함되면 알기 어려운 컴파일 오류가 발생한다.
• 메서드를 선언할 때 실체화 불가 타입으로 varargs 매개변수를 선언하면 컴파일러가 경고를 보낸다.
  

실체화 불가 타입: 아이템 28에서 소개된 내용. 거의 모든 제네릭과 매개변수화 타입은 실체화 불가 타입이다. 실체화 불가 타입은 런타임에는 컴파일 타임보다 정보를 적게 담고 있다.

Heap Pollution (힙 오염)

• 매개변수화 타입의 변수가 타입이 다른 객체를 참조하면 힙 오염이 발생한다. 이렇게 다른 타입 객체를 참조하는 상황에서는 컴파일러가 자동 생성환 형변환이 실패할 수 있으니, 제네릭 타입 시스템이 약속한 타입 안전성의 근간이 흔들려버린다.

제네릭과 varargs를 혼용하면 타입 안전성이 깨진다!

static void dangerous(List<String>... stringLists) {
        List<Integer> intList = List.of(42);
        Object[] objects = stringLists;
        objects[0] = intList; // Heap pollution
        String s = stringLists[0].get(0); // ClassCastException
    }
}

이 메서드에는 형변환하는 곳이 보이지 않는데도 인수를 건네 호출하면 ClassCastException을 던진다. 마지막 줄에 컴파일러가 생성한 (보이지 않는) 형변환이 숨어 있기 때문이다.

이처럼 타입 안전성이 깨지니 제네릭 varargs 배열 매개변수에 값을 저장하는 것은 안전하지 않다.

---

이 예를 보고 재미난 질문을 떠올려 보자. 제네릭 배열을 프로그래머가 직접 생성하는 건 허용하지 않으면서 제네릭 varargs 매개변수를 받는 메서드를 선언할 수 있게 한 이유는 무엇일까?

왜 List<String>... stringLists이 코드는 경고로 끝냈을까?

그 답은 제네릭이나 매개변수화 타입의 varargs 매개변수를 받는 메서드가 실무에서 매우 유용하기 때문이다. 그래서 언어 설계자는 이 모순을 수용하기로 했다.

사실 자바 라이브러리도 이런 메서드를 여럿 제공하는데, Arrays.asList(T... a), Collections.addAll(Collection<? super T> c, T...elements), EnumSet.of(E first, E... rest)가 대표적이다. 다행인 점은 앞서 보여준 위험한 메서드와는 달리 이들은 타입 안전하다.

---

@SafeVarags 애너테이션

@SafeVarargs 애너테이션은 메서드 작성자가 그 메서드가 타입 안전함을 보장하는 장치다.

자바 7 전에는 제네릭 가변인수 메서드의 작성자가 호출자 쪽에서 발생하는 경고에 대해서 해줄 수 있는 일이 없었다. 따라서 이런 메서드는 사용하기에 좀 꺼림칙했다. 사용자는 이 경고들을 그냥 두거나 (더 흔하게는) 호출하는 곳 마다 @SuppressWarnings("unchecked") 애너테이션을 달아 경고를 숨겨야 했다.

지루한 작업이고, 가독성을 떨어뜨리고, 대로는 진짜 문제를 알려주는 경고마저 숨기는 안좋은 결과로 이어졌다.

자바 7에서는 @SafeVarargs 애너테이션이 추가되어 제네릭 가변인수 메서드 작성자가 클라이언트 측에서 발생하는 경고를 숨길 수 있게 되었다.

@SafeVarargs 애너테이션은 메서드 작성자가 그 메서드가 타입 안전함을 보장하는 장치다. 컴파일러는 이 약속을 믿고 그 메서드가 안전하지 않을 수 있다는 경고를 더 이상 하지 않는다.

메서드가 안전한 게 확실하지 않다면 절대 @SafeVarargs 애너테이션을 달아서는 안 된다. 그렇다면 메서드가 안전한지는 어떻게 확신할 수 있을까? 가변인수 메서드를 호출할 때 varargs 매개변수를 담는 제네릭 배열이 만들어진다는 사실을 기억하자. 메서드가 이 배열에 아무것도 저장하지 않고 (그 매개변수들을 덮어쓰지 않고) 그 배열의 참조가 밖으로 노출되지 않는다면(신뢰할 수 없는 코드가 배열에 접근할 수 없다면) 타입 안전하다.

달리 말하면, 이 varargs 매개변수 배열이 호출자로부터 그 메서드로 순순하게 인수들을 전달하는 일만 한다면 (varargs의 목적대로만 쓰인다면) 그 메서드는 안전하다.

이때, varargs 매개변수 배열에 아무것도 저장하지 않고도 타입 안전성을 깰 수도 있으니 주의해야 한다. 다음 코드는 가변인수로 넘어온 매개변수들을 배열에 담아 반환하는 제네릭 메서드이다. 얼핏 보면 편리한 유틸같아 보이지만 보기와 달리 위험하다!

자신의 제네릭 매개변수 배열의 참조를 노출한다 - 안전하지 않다!

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

이 메서드가 반환하는 배열의 타입은 이 메서드에 인수를 넘기는 컴파일타임에 결정되는데, 그 시점에는 컴파일러에게 충분한 정보가 주어지지 않아 타입을 잘못 판단할 수 있다. 따라서 자신의 varargs 매개변수 배열을 그대로 반환하면 힙 오염을 이 메서드를 호출한 쪽의 콜 스택으로까지 전이하는 결과를 낳을 수 있다.

구체적인 예를 보자. 다음 메서드는 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 1: return toArray(a, c);
        case 2: return toArray(b, c);
    }
    throw new AssertionError(); // Can't get here
}

이 메서드는 제네릭 가변인수를 받는 toArray메서드를 호출한다는 점만 빼면 위험하지 않고 경고도 내지 않을 것이다. 이 메서드를 본 컴파일러는 toArray에 넘길 T 인스턴스 2개를 담은 varargs 매개변수 배열을 만드는 코드를 생성한다. 이 코드가 만드는 배열의 타입은 Object[]인데, pickTwo에 어떤 타입의 객체를 넘기더라도 담을 수 있는 가장 구체적인 타입이기 때문이다. 그리고 toArray 메서드가 돌려준 이 배열이 그대로 pickTwo를 호출한 클라이언트까지 전달된다. 즉, pickTwo는 항상 Object[] 타입 배열을 반환한다.

이제 pickTwo를 사용하는 main메서드를 볼 차례다.

public static void main(String[] args) {
    String[] attributes = pickTwo("Good", "Fast", "Cheap");
    System.out.println(Arrays.toString(attributes));
}

아무런 문제가 없는 메서드이니 별다른 경고 없이 컴파일된다. 하지만 실행하려 들면 ClassCastException을 던진다. 형변환 하는 곳이 보이지 않는데도 말이다. 무엇을 놓친 것일까? 바로 pickTwo의 반환값을 attributes에 저장하기 위해 String[]로 형변환하는 코드를 컴파일러가 자동 생성한다는 점을 놓쳤다. Object[]는 String[]의 하위 타입이 아니므로 이 형변환은 실패한다. 이 실패가 다소 황당하게 느껴질 수 있다. 힙 오염을 발생시킨 진짜 원인인 toArray로부터 두 단계나 떨어져 있고, varargs 매개변수 배열은 실제 매개변수가 저장된 후 변경된 적도 없으니 말이다.

이 예는 제네릭 varargs 매개변수 배열에 다른 메서드가 접근하도록 허용하면 안전하지 않다는 점을 다시 상기시킨다.

단, 예외가 두 가지 있다.

1. @SafeVarargs로 제대로 애노테이트된 또 다른 varargs 메서드에 넘기는 것은 안전하다.

2. 그저 이 배열 내용의 일부 함수 호출만 하는 (varargs를 받지 않는) 일반 메서드에 넘기는 것도 안전하다.

아래 코드는 제네릭 varargs 매개변수를 안전하게 사용하는 전형적인 예다. 다음의 flatten 메서드는 임의 개수의 리스트를 인수로 받아, 받은 순서대로 그 안의 모든 원소를 하나의 리스트로 옮겨 담아 반환한다. 이 메서드에는 @SafeVarargs 애너테이션이 달려 있으니 선언하는 쪽과 사용하는 쪽 모두에서 경고를 내지 않는다.

public class FlattenWithVarargs {
    @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;
    }

    public static void main(String[] args) {
        List<Integer> flatList = flatten(
                List.of(1, 2), List.of(3, 4, 5), List.of(6,7));
        System.out.println(flatList);
    }
}

@SafeVarargs 애너테이션을 사용해야 할 때를 정하는 규칙은 간단하다. 제너릭이나 매개변수화 타입의 varargs 매개변수를 받는 모든 메서드에 @SafeVarargs를 달라. 그래야 사용자를 헷갈리게 하는 컴파일러 경고를 없앨 수 있다. 이 말은 안전하지 않은 varargs 메서드는 절대 작성해서는 안된다는 뜻이기도 하다.

여러분이 통제할 수 있는 메서드 중 제네릭 varargs 매개변수를 사용하며 힙 오염 경고가 뜨는 메서드가 있다면, 그 메서드가 진짜 안전한지 점검하라.

아래 두 조건을 만족하는 제네릭 varargs 메서드는 안전하다.

• varargs 매개변수 배열에 아무것도 저장하지 않는다.
• 그 배열(혹은 복제본)을 신뢰할 수 없는 코드에 노출하지 않는다.

@SafeVarargs 애너테이션은 재정의할 수 없는 메서드에만 달아야 한다. 재정의한 메서드도 안전할지는 보장할 수 없기 때문이다. 자바 8에서 이 애너테이션은 오직 정적 메서드와 final 인스턴스 메서드에만 붙일 수 있고, 자바 9부터는 private 인스턴스 메서드에도 허용된다.

---

@SafeVarargs 애너테이션이 유일한 정답은 아니다. 아이템 28의 조언을 따라 (실체는 배열인) varargs 매개변수를 List 매개변수로 바꿀 수도 있다. 이 방식을 앞서의 flattern 메서드에 적용하면 다음과 같다. 매개변수 선언만 수정했음을 주목하자.

제네릭 varargs 매개변수를 List로 대체한 예 - 타입 안전하다.

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

정적 팩터리 메서드인 List.of를 활용하면 다음 코드와 같이 이 메서드에 임의 개수의 인수를 넘길 수 있다. 이렇게 사용하는 게 가능한 이유는 List.of에도 @SafeVarargs 애너테이션이 달려있기 때문이다.

audience = flatten(List.of(friends, romans, countrymen));

이 방식의 장점은 컴파일러가 이 메서드의 타입 안전성을 검증할 수 있다는 데 있다. @SafeVarargs 애너테이션을 우리가 직접 달지 않아도 되며, 실수로 안전하다고 판단할 걱정도 없다. 단점이라면 클라이언트 코드가 살짝 지저분해지고 속도가 조금 느려질 수 있다는 정도다.

또한 이 방식은 toArray처럼 varargs 메서드를 안전하게 작성하는게 불가능한 상황에서도 쓸 수 있다. 이 toArray의 List 버전이 List.of로, 자바 라이브러리 차원에서 제공하니 우리가 직접 작성할 필요도 없다. 이 방식을 pickTwo에 적용하면 다음처럼 된다.

public class SafePickTwo {
    static <T> List<T> pickTwo(T a, T b, T c) {
        switch(ThreadLocalRandom.current().nextInt(3)) {
            case 0: return List.of(a, b);
            case 1: return List.of(a, c);
            case 2: return List.of(b, c);
        }
        throw new AssertionError();
    }

    public static void main(String[] args) {
        List<String> attributes = pickTwo("Good", "Fast", "Cheap");
        System.out.println(attributes);
    }
}

결과 코드는 배열 없이 제네릭만 사용하므로 타입 안전하다.

---

참고 자료

• Effective Java 3/E