제네릭과 가변인수를 함께 쓸 때는 신중하라 - [5장. 제네릭(아이템32)]

1. 가변인수 & 제네릭 💪

  가변인수(varargs)란 매개변수로 들어오는 값의 개수와 상관없이 동적으로 인수를 받아서 기능하도록 해주는 문법을 말한다.

public PrintStream printf(String format, Object ... args) {
    return format(format, args);
}

  가변인수 메서드를 호출하면 가변인수를 담기 위한 배열이 자동으로 하나 만들어진다.

 

  만약 다음과 같이 제네릭과 가변인수를 함께 사용하면 어떻게 될까?

static void dangerous(List<String>... stringLists) { }

  이 경우에도 가변인수 메서드가 호출되기 때문에 가변인수를 담기 위한 배열이 자동으로 만들어진다. 즉, 제네릭 배열이 만들어지는 것이다.

 

  일반적으로는 제네릭 배열을 만들려고 할 때 컴파일러가 컴파일 에러를 내기 때문에 우리가 직접 제네릭 배열을 만들 수는 없다.

public static void main(String[] args) {

    // 컴파일 에러
    // Generic array creation
    List<String>[] myList = new ArrayList<String>[10];
}

  하지만 가변인수라는 것을 사용하면 자바가 내부적으로 제네릭의 배열을 만들게 된다. 물론, 컴파일 에러는 아니지만 경고가 뜨긴 한다.

// 경고 발생
// Possible heap pollution from parameterized vararg type
static void dangerous(List<String>... stringLists) { }

 

  아이템 28에서 살펴본 것처럼 만약 제네릭 배열을 허용하면 타입 안전성에 문제가 생긴다. 그래서 컴파일러가 제네릭 배열을 아예 생성하지 못하게 막았는데, 지금처럼 가변인수를 사용하면 제네릭 배열을 허용하게 되어서 상당히 위험한 코드가 되게 된다.

 

  그러면 '제네릭과 가변인수를 함께 쓰지 못하도록 막아놓는데 맞지 않을까?'라는 의문을 품을 수 있다. 하지만, 제네릭과 매개변수화 타입의 varargs 매개변수를 받는 메서드가 실무에서 매우 유용하기 때문에 허용을 해놓은 것이다.

  언어 설계자가 이 모순을 수용하기로 한 것이다. 자바 라이브러리에도 이런 메서드를 여럿 제공하고 있다.

Arrays.asList(T... a)
Collections.addAll(Collection<? super T> c, T... elements)
EnumSet.of(E first, E... rest)

 

  제네릭 varargs 메서드를 다음 두 조건을 모두 만족해야 안전하다.

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

  두 개의 조건에 대해서 구체적으로 알아보자.

 

 

2. 조건 (1). varargs 매개변수 배열에 아무것도 저장하지 않는다. 🦾

  varargs 매개변수 배열에 무엇인가를 저장하면 varargs 메서드가 안전해지지 않게 된다.

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

  배열은 공변이므로 문자열 배열을 오브젝트 배열에 할당할 수 있다. 그리고 컴파일러가 제네릭 타입을 알고 있으므로, String s= stringLists[0].get(0);를 컴파일할 때 자바가 String으로 캐스팅을 하는 코드를 넣어준다. 이때 Integer를 String으로 캐스팅하는 것이므로 문제가 생기게 된다.

 

  제네릭을 쓴 가장 큰 이유는 컴파일 타임부터 런타임까지 타입 안전성을 확보하기 위해서다. 그런데 위와 같이 런타임에 타입 안전성이 깨지는 문제가 생긴다. 물론 컴파일 타임에도 확인이 되지 않는다.

 

  하지만, 아래 코드와 같이 varargs 매개변수 배열에 아무것도 저장하지 않으면 제네릭 varargs 메서드는 안전하다.

@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;
}

  안전하게 쓰는 경우에 @SuppressWarnings를 사용할 수 있다. 하지만 이렇게 하면 메서드 전체가 @SuppressWarings에 영향을 받게 된다.

  이런 경우 @SafeVarargs라는 것을 사용하면 가변인수는 안전하게 사용되고 있다고 한정할 수 있다. 즉, 가변인수 이외의 경고에 대해서는 체크를 할 수 있다는 것이다.

 

 

3. 조건 (2). 그 배열(혹은 복제본)을 신뢰할 수 없는 코드에 노출하지 않는다. 🦵

  아래의 코드는 가변인수로 넘어온 매개변수들을 배열에 담아 반환하는 제네릭 메서드다.

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

  컴파일러는 toArray의 return 타입을 Object라고 판단한다. Object가 가장 추상적이기 때문이다. 결과적으로 return 하는 것은 Object의 배열이다.

 

  toArray를 다음과 같은 상황에서 쓴다고 생각해 보자.

public class PickTwo {

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

    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(); // 도달할 수 없음
    }
}

----------

public static void main(String[] args) {
    String[] attributes = pickTwo("great", "best", "good"); // ClassCastException
    System.out.println(Arrays.toString(attributes));
}

  pickTwo를 할 때에는 제네릭을 사용하였고, String으로 타입을 설정하였기 때문에 컴파일러는 String으로 타입캐스팅을 하려고 한다.

  toArray에서 Object를 return 해주었고, 이것을 다시 pickTwo에서 return 하는 것이므로 현재는 Object 타입이다. 그러므로 Object를 String으로 타입캐스팅을 하는 것이기 때문에 당연히 문제가 발생한다.

 

  즉, 그 배열(혹은 복제본)을 신뢰할 수 없는 코드에 노출하지 않아야지 제네릭 varargs 메서드를 안전하게 사용할 수 있다.

 

 

4. 다른 해결책 - varargs 매개변수를 List 매개변수로 바꿔라. 🦿

  제네릭 varargs 메서드를 안전하게 만들고 @SafeVarargs 애너테이션을 다는 게 유일한 정답은 아니다.

  아이템 28(배열보다는 리스트를 사용하라)의 조언에 따라 실체는 배열인 varargs 매개변수를 List 매개변수로 바꿀 수도 있다.

// 기존 코드
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); // [1, 2, 3, 4, 5, 6, 7]
}

// 변경된 코드
public class FlattenWithList {

    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;
    }
}

----------

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

    System.out.println(flatList); // [1, 2, 3, 4, 5, 6, 7]
}

  이 방식의 장점은 컴파일러가 이 메서드의 타입 안전성을 검증할 수 있다는 데 있다. @SafeVarargs 애너테이션을 우리가 직접 달지 않아도 되며, 실수로 안전하다고 판단할 걱정도 없다.

  단점이라면 클라이언트 코드가 살짝 지저분해지고 속도가 조금 느려질 수 있다는 정도이다.

 

  또한, pickTwo에도 적용이 가능하다.

// 기존 코드
public class PickTwo {

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

    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(); // 도달할 수 없음
    }
}

----------

public static void main(String[] args) {
    String[] attributes = pickTwo("great", "best", "good"); // ClassCastException
    System.out.println(Arrays.toString(attributes));
}

// 변경된 코드
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("great", "best", "good");
    System.out.println(attributes);
}

 

해당 글은 백기선 님의 '이펙티브 자바 완벽 공략'을 참고하였습니다.