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

가변인수 메서드

가변인수(varargs) 메서드와 제네릭은 함께 사용이 어렵다. 가변인수는 메서드에 넘기는 인수의 개수를 클라이언트가 조절할 수 있게 해준다. 가변인수 메서드를 호출하면 가변인수를 담기 위한 배열이 자동으로 하나 만들어진다. 그런데 내부로 감춰야 했을 이 배열을 클라이언트에 노출시키는 문제가 생겼다. 그 결과 varargs 매개변수에 제네릭이나 매개변수화 타입이 포함되면 알기 어려운 컴파일 경고가 발생한다.

 

실체화 불가 타입은 런타임에는 컴파일 타임보다 타입 관련 정보를 적게 담고 있다.  그리고 거의 모든 제네릭과 매개변수화 타입은 실체화되지 않는다. 메서드를 선언할때 실체화 불가 타입으로 varargs 매개변수를 선언하면 컴파일러가 경고를 보낸다. 가변인수 메서드를 호출할 때도 varargs 매개변수가 실체화 불가 타입으로 추론되면, 그 호출에 대해서도 경고가 발생한다.

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

참고로 가변인수의 매개변수는 1개만 가능하며, 맨 마지막에 위치해야한다.

 

제네릭과 varargs 를 혼용한 코드 : 타입 안정성 깨진다.

package com.java.effective.item32;

import java.util.ArrayList;
import java.util.List;

public class Main {
    public static void main(String[] args) {
        List<String> list = new ArrayList<>();
        list.add("1");
        list.add("2");

        dangerous(list);
    }

    static void dangerous(List<String>... stringLists) {
        List<Integer> intList = List.of(2);
        Object[] objects = stringLists;
        objects[0] = intList; // 힙 오염 
        /* stringList 는 Integer 타입으로 변경됨 */
        String s = stringLists[0].get(0); // ClassCastException 발생
    }
}

 

타입 안정성이 깨져버려서, 제네릭 varargs 배열 매개변수에 값을 저장하는 것은 안전하지 않다. 제네릭이나 매개변수화 타입의 varargs 매개변수를 받는 메서드가 실무에서 매우 유용하기 때문에 제네릭 varargs 매개변수를 받는 메서드 선언이 가능하다. 제네릭 배열을 직접 생성하는 것은 불가능하지만, 이는 수용하기로 했다. 

 

 

@SafeVarargs 애너테이션

해당 어노테이션을 사용하여 제네릭 가변인수 메서드 작성자가 클라이언트 측에서 발생하는 경고를 숨길 수 있게 되었다. @SafeVarargs 어노테이션은 메서드 작성자가 그 메서드가 타입 안전함을 보장하는 장치다. 메서드가 안전한게 확실하지 않다면 절대 @SafeVarargs 어노테이션을 달면 안된다.

 

 

제네릭 varargs 매개변수 에러

가변인수 메서드를 호출할때 varargs 매개변수를 담는 제네릭 배열이 만들어진다는 사실을 기억하자. 메서드가 이 배열에 아무것도 저장하지 않고(덮어쓰지않고) 그 배열의 참조가 밖으로 노출되지 않는다면(신뢰할 수 없는 코드가 배열에 접근할 수 없다면) 타입 안전하다. 이 varargs 매개변수 배열이 호출자로부터 그 메서드로 순수하게 인수들을 전달하는 일만 한다면 그 메서드는 안전하다.

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

 

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

static <T> T[] pickTwo(T a, T b, T c) {
    switch(ThreadLocalRandom.current().nextInt(3)) {
    // Unchecked generics array creation for varargs parameter
    case 0 : return toArray(a,b);
    case 1 : return toArray(a,c);
    case 2 : return toArray(b,c);
    }

    throw new AssertionError(); // 도달할 수 없음
}

 

제네릭 가변인수를 받는 toArray 메서드를 호출한다는 점만 빼면 위험하지 않은 코드다. 이유는, 이 메서드를 본 컴파일러는 toArray에 넘길 T 인스턴스 2개를 담을 varargs 매개변수 배열을 만드는 코드를 생성하고, 해당 배열의 타입은 Object[] 이며, pickTwo 에 어떤 타입의 객체를 넘기더라도 담을 수 있는 가장 구체적인 타입이기 때문이다.

 

prickTwo 는 항상 Object[] 타입 배열을 반환한다.

package com.java.effective.item32;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.ThreadLocalRandom;

public class Main2 {
    public static void main(String[] args) {
        String[] attributes = pickTwo("AA", "BB", "CC");
    }

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

    static <T> T[] pickTwo(T a, T b, T c) {
        switch(ThreadLocalRandom.current().nextInt(3)) {
            // Unchecked generics array creation for varargs parameter
            case 0 : return toArray(a,b);
            case 1 : return toArray(a,c);
            case 2 : return toArray(b,c);
        }

        throw new AssertionError(); // 도달할 수 없음
    }
}

 

pickTwo 메서드를 호출하는 main 메서드를 위와같이 생성하면 별다른 경고 없이 컴파일된다. 하지만 실행하려들면 형변환하는 곳이 보이지 않는데도 ClassCastException 이 발생한다. pickTwo의 반환값을 attributes 에 저장하기 위해 String[] 로 형변환하는 코드를 컴파일러가 자동 생성한다는 점을 놓쳤다. Object[] 는 String[]의 하위타입이 아니므로 이 형변환은 실패한다. 

 

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

1) @SafeVarargs 로 제대로 어노테이션된 또다른 varargs 메서드에 넘기는 것은 안전하다.
2) 그저 이 배열 내용의 일부 함수를 호출만하는(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;
}

 

flatten 메서드는 임의 개수 리스트를 인수도 받아, 받은 순서대로 그 안의 모든 원소를 하나의 리스트로 옮겨 담아 반환한다. 이 메서드는 제네릭 varargs 매개변수를 안전하게 사용하는 예다.  따라서 @SafeVarargs 어노테이션도 달아야한다.

 

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

 

아래 2가지를 꼭 지키자.

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

 

 

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()를 활용하여 이 메서드에 임의 개수의 인수를 넘길 수 있다.

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

 

List.of 메서드에도 @SafeVarargs 어노테이션이 달려있어서, 이렇게도 사용이 가능한 것이다.

...  
    @SafeVarargs
    @SuppressWarnings("varargs")
    static <E> List<E> of(E... elements) {
        switch (elements.length) { // implicit null check of elements
            case 0:
                return ImmutableCollections.emptyList();
            case 1:
                return new ImmutableCollections.List12<>(elements[0]);
            case 2:
                return new ImmutableCollections.List12<>(elements[0], elements[1]);
            default:
                return new ImmutableCollections.ListN<>(elements);
        }
    }
...

 

이 방식의 장점은 컴파일러가 이 메서드의 타입 안정성을 검증해 줄 수 있고, @SafeVarargs 어노테이션도 직접 달지 않아도 된다. 

 

List.of 사용

package com.java.effective.item32;

import java.util.List;
import java.util.concurrent.ThreadLocalRandom;

public class Main3 {
    public static void main(String[] args) {
        List<String> attributes = pickTwo("AA", "BB", "CC");
    }

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

    static <T> List<T> pickTwo(T a, T b, T c) {
        switch(ThreadLocalRandom.current().nextInt(3)) {
            // Unchecked generics array creation for varargs parameter
            case 0 : return List.of(a,b);
            case 1 : return List.of(a,c);
            case 2 : return List.of(b,c);
        }

        throw new AssertionError(); // 도달할 수 없음
    }
}