이펙티브자바 Item32. 제네릭과 가변인수를 함께 쓸 때는 신중하라.

가변인수 메서드

가변인수?

가변인자는 메서드의 매개변수를 동적으로 처리할 수 있도록 해준다.

이를 사용하면 메서드 호출 시 전달되는 인자의 개수를 동적으로 변경할 수 있다.

메서드를 호출하고자 할때 인수의 갯수가 가변적일 때 가변인수를 처리하면 손 쉽게 처리할 수 있다.

public void exampleMethod(String... strings) {
    // 가변인자로 선언된 문자열 배열에 대한 처리
    // strings는 문자열 배열로 처리됨
}

void sum(String... str) {
    for(String a:str) {
        System.out.println(a);
    }
}

• 가변인수 메서드를 호출하면, 가변인수를 담기 위한 배열이 자동으로 만들어진다.
• 내부로 감춰야 했을 이 배열을 클라이언트에 노출하는 문제가 발생한다.
• 제네릭과 함께 사용하게 되면 제네릭 배열이 만들어지고, 아이템 28에서 본 힙 오염이 발생하며, 아래와 같은 컴파일 경고 발생

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

힙 오염 예시

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
}

• List<String>[] stringLists 생성된다.
• 해당 배열은 공변이기 때문에 Object[]로 참조가 가능하다.
• 제네릭은 런타임 시 타입정보가 소거되기 때문에 타입이 다른 List<Integer> intList의 할당이 가능하다. -> 힙오염 발생
• 이후 stringLists의 0번째 객체를 호출하면 ClassCastException이 발생하게 된다.

반응형

따라서 제네릭 가변인수 배열 매개변수에 값을 저장하는 것은 안전하지 않다.

제네릭 배열을 프로그래머가 직접 생성하는 것은 허용하지 않는다.

그런데 왜 제네릭 가변인수 매개변수를 받는 메서드를 선언하는 것은 가능할까?

제네릭이나 매개변수화 타입의 가변인수 매개변수를 받는 메서드가 실무에서 매우 유용하기 때문이다.

• 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
@SuppressWarnings("varargs")
public static <T> List<T> asList(T... a) {
    return new ArrayList<>(a);
}

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

안전한 경우

1. 메서드가 가변인수 배열에 아무것도 저장하지 않는 경우
2. 배열의 참조가 밖으로 노출되지 않는 경우 (신뢰할 수 없는 코드가 배열에 접근할 수 없는 경우)

가변인수 매개변수 배열이 호출자로부터 그 메서드로 순수하게 인수들을 전달하는 일만 하는 경우

제네릭 가변인수 매개변수를 안전하지 않게 사용하는 경우

varargs 매개변수 배열에 아무것도 저장하지 않아도 타입 안전성이 깨질 수 있는 예이다.

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

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

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

즉, 자신의 가변인수 매개변수 배열을 그대로 반환하면 힙 오염을 메서드를 호출한 곳까지 전이하는 결과를 낳을 수도 있다.

• 가변인수 매개변수 배열에 아무것도 저장하지 않고도 타입 안전성을 깰 수 있다.

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 (T[]) toArray(String.valueOf(a), String.valueOf(b));
            case 1: return (T[]) toArray(String.valueOf(a), String.valueOf(c));
            case 2: return (T[]) toArray(String.valueOf(b), String.valueOf(c));
        }
        throw new AssertionError();
    }

    public static void main(String[] args) {
        String[] tmp = pickTwo("좋은","빠른","저렴한");
    }
}

• 컴파일러는 toArray에 넘길 T 인스턴스 2개를 담을 가변인수 매개변수 배열을 만드는 코드를 생성한다.
  • 이 코드가 만드는 배열의 타입은 Object[]이다.
• toArray 메서드가 만든 이 배열을 그대로 pickTwo를 호출한 클라이언트까지 전달된다.
  • 즉, pickTwo는 항상 Object[] 타입 배열을 반환한다.
• Object[]는 String[]의 하위 타입이 아니므로 형변환에 실패하며 ClassCastException을 던진다.

제네릭 가변인수 매개변수 배열에 다른 메서드가 접근하도록 허용하면 안전하지 않다.

제네릭 가변인수 매개변수를 안전하게 사용하는 경우

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

• 임의 개수의 리스트를 인수로 받아, 받은 순서대로 그 안의 모든 원소를 하나의 리스트로 옮겨 담아 반환한다.
• 이 메서드에는 @SafeVarargs가 달려 있으므로 선언하는 쪽과 사용하는 쪽 모두에서 경고를 내지 않는다.

제네릭 가변인수 매개변수를 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가 달려있기 때문이다.
• 이 방식의 장점은 컴파일러가 이 메서드의 타입 안전성을 검증할 수 있다는 데 있다.
• @SafeVarargs를 직접 달지 않아도 되고, 실수로 안전하다고 판단할 걱정도 없다.
• 이 방식은 위의 toArray처럼 가변인수 메서드를 안전하게 작성하는 것이 불가능한 상황에서도 사용할 수 있다.

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) {
    String[] tmp = pickTwo("좋은","빠른","저렴한");
}

정리

• 메서드에 제네릭 가변인수 매개변수를 사용하고 싶다면 @SafeVarargs를 달자.
• 아니라면 List를 사용하자