Item32 - 제네릭과 가변인수를 함께 쓸 때는 신중하라

 

가변인수(varargs) 메서드와 제네릭은 자바 5 때 함께 추가되었으나 잘 어울리지 못한다.

 

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

static void varargs(String... strArr) {
    Object[] objects = strArr;
    String s = (String) objects[0];
    System.out.println(s);
}

public static void main(String[] args) {
    varargs("there", "will", "hi");
}

-> "there"

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

 => strArr

 

이 varargs 매개변수에 제네릭이나 개변수화 타입이 포함되면 알기 어려운 컴파일 경고가 발생한다.

    static void dangerous(List<String>... stringLists) {
        String s = stringLists[0].get(0);
        System.out.println(s);
    }

 

아이템 28에서 실체화 불가 타입은 런타임에는 컴파일타임보다 타입 관련 정보를 적게 담고 있음을 배웠다(타입 소거)

그리고 거의 모든 제네릭과 매개변수화 타입은 실체화 되지 않는다.

 

메서드를 선언할 때 실체화 불가 타입으로 varargs 매개 변수를 선언하면 컴파일러가 경고를 보낸다.

가변인수 메서드를 호출할 때도 varargs 매개변수가 실체화 불가 타입으로 추론되면, 그 호출에 대해서도 경고를 보낸다.

 

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

 

다음 예제를 보면서 이해해보자

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

 

List<String>[] 의 형태를 가진 stringLists는 당연히 Object[] 에 할당될 수 있다.

 => (배열은 공변이고 문자열 배열은 Object 배열의 하위 타입이다.)

 

Object 배열의 0 인덱스에 매개변수화 타입이 다른 List<Integer> intList 도 할당 가능하다.(공변!)

 => 이렇게 되면 List<String>[] 의 형태를 가진 StringLists의 내부 참조도 같이 바뀌게 된다.

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

       System.out.println(Arrays.toString(stringLists));
   }

   public static void main(String[] args) {
       dangerous(List.of("There be dragons!", "hi"), List.of("안녕 하세요"));
   }
   
   -> [[42], [안녕 하세요]]

 

만약 이 stringLists를 String 변수에 할당해 사용하려고 한다면 ClassCastException이 발생할 확률이 매우 높아질 것이다.

 

즉! 제네릭 가변인수를 배열에 값을 저장하는 것은 안전하지 않다.

 

그럼에도 자바 라이브러리에 종종 제네릭 가변인수 매개변수를 받는 메서드를 사용하는 예가 있는데 실무에서 유용하다고 한다.

(난 잘 모르겠다... 성능상 아주 약간의 손실이 있더라도 재네릭 varargs 매개변수를 list로 대체하는게 더욱 타입 안전하다고 생각한다.)

 

제네릭 가빈인수 메서드를 타입 안전함을 보장하려면

1. 메서드가 이 배열에 아무것도 저장하지 않고(매개변수들을 덮어쓰지 않고)

2. 그 배열의 참조를 밖으로 노출시키지 않는다면 타입 안전하다.

 

이 경우 @SafeVarargs 어노테이션을 사용해 경고를 제거할 수 있다.

 => 꼭 타입 안전을 보장하고 어노테이션을 붙일 것!

 

예제를 보자

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

 

flatten 메서드에서 매개변수화 타입 T가 생산자이므로 <? extends T>를 사용해 매개변수화 타입의 varargs 매개변수를 받았다.

 

@SafeVarargs 어노테이션을 붙일 수 있게 타입 안전을 보장하는 조건이다.

1. varargs 매개변수 배열에 아무것도 저장하지 않는다.

2. 그 배열을 (or 복제본)을 신뢰할 수 없는 코드에 노출하지 않는다.

 

 

 

@SafeVarargs 어노테이션이 유일한 해결책은 아니다.

아이템28의 조언에 따라 가변인수를 List로 바꾼다면 더욱 안전해진다.

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

 

 - 배열없이 제네릭만 사용하므로 컴파일러가 타입 안정성을 보장할 수 있다.

 - @SaveVarargs 어노테이션을 사용할 필요가 없다.

 - 실수로 안전하다고 판단할 걱정도 없다.