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

Java/Effective Java 3E

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

잭피 2020. 10. 23. 20:14

이번장의 핵심은...

가변 인수와 제네릭은 궁합이 좋지 않다

가변 인수 기능은 배열을 노출하여 추상화가 완벽하지 못하고,

배열과 제네릭의 타입 규칙이 서로 다르기 때문이다

제네릭 varargs 매개변수는 타입 안전하지는 않지만 허용된다

메서드에 제네릭 varargs 매개변수를 사용하고자 한다면,

먼저 그 메서드가 타입 안전한지 확인한 다음 @Safevarargs 애너테이션을 달아 사용하는 데 불편함이 없게끔 하자.

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

// 제네릭과 varargs(가변인수)를 혼용하면 타입 안정성이 깨진다
static void dangerous(List<String> ... stringLists) {
	List<Integer> inList = List.of(42);
	Object[] objects = stringLists;
	obejcts[0] = intList; // 힙 오염 발생 (List<Integer>가 들어감)
	String s = stringLists[0].get(0); // ClassCastException  
}(

매개변수화 타입의 변수가 타입이 다른 객체를 참조하면 힙 오염이 발생

제네릭이나 매개변수화 타입의 varargs 매개변수를 받는 메서드는 실무에서 매우 유용함

Arrays.asList(T...a), Collections.addAll(Collection<? super T> c, T ... elements),

EnumSet.of(E first, E...rest)

→ 앞 예제와 달리 타입이 안전

@SafeVarargs

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

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

(이전엔 호출하는 곳마다 @SuppressWarnings("unchecked") 애너테이션을 달아 경고를 숨겨야 했다)

메서드가 안전한지는 어떻게 확신?

가변 인수 메서드를 호출할 때, varargs 매개변수를 담는 제네릭 배열이 만들어진다는 사실을 기억

이 배열에 아무것도 저장하지 않고 그 배열의 참조가 밖으로 노출되지 않는다면 타입이 안전하다

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

안전하지 않은 예

// 자신의 제네릭 매개변수 배열의 참조를 노출한다 -> 안전하지 않음
static <T> T[] toArray(T... args) {
	return args;
}

- 메서드 반환 배열 타입은 이 메서드에 인수를 넘기는 컴파일 타임에 결정

- 그 시점에는 컴파일러에게 충분한 정보가 주어지지 않아 타입을 잘못 판단할 수 있다

- 자신의 varargs 매개변수 배열을 그대로 반환하면 힙 오염을 이 메서드를 호출한 쪽의 콜 스택으로까지 전이하는 결과도 생길 수 있음

좀 더 구체적인 예

- T 타입 인수 3개를 받아 그중 2개를 무작위로 골라 담은 배열을 반환

// 코드 32-2 자신의 제네릭 매개변수 배열의 참조를 노출한다. - 안전하지 않다! (193쪽)
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(); // 도달할 수 없다
}

pickTwo 메서드를 호출하는 main 메서드

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

→ ClassCastException 발생

pickTwo의 반환 값을 attributes에 저장하기 위해 String []로 형 변환하는 코드를 컴파일러가 자동 생성

하지만, Object[]는 String[]의 하위 타입이 아니므로 이 형변환은 실패

힙 오염을 발생시킨 진짜 원인은 toArray로부터 2단계나 떨어져 있고,

varargs 매개변수 배열은 실제 매개변수가 저장된 후 변경된 적도 없다

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

단, 2가지 예외가 있음

@SafeVarargs로 제대로 애노테이트된 또 다른 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;
}

@SafeVarargs 애너테이션을 사용해야 할 때를 정하는 규칙은
제네릭이나 매개변수화 타입의 varargs 매개변수를 받는 모든 메서드에 @SafeVarargs를 달자 그 조건은 1. varargs 매개변수 배열에 아무것도 저장하지 않는다 2. 그 배열(혹은 복제본)을 신뢰할 수 없는 코드에 노출하지 않는다

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

다른 방법

@SafeVarargs 애너테이션이 유일한 정답은 아니다

varargs 매개변수를 List 매개변수로 바꿀 수 있다

이 방식을 앞서의 flatten 메서드에 적용하면 다음과 같음 (매개변수 선언만 수정했음을 주목)

// 제네릭 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;
}

// 정적 팩터리 메서드인 Lists.of 활용 (Lists.of에 @SafeVarargs 애너테이션이 달려있음)
audience = flatten(Lists.of(friends, romans, countrymen));

→ 이 방식의 장점은 컴파일러가 이 메서드의 타입 안정성을 검증할 수 있다

그리고 우리가 직접 애너테이션을 추가하지 않아도 된다

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

또한, 위의 toArray처럼 varargs 메서드를 안전하게 작성하는 게 불가능한 상황에서도 쓸 수 있다

toArray의 List 버전이 바로 List.of로, 자바 라이브러리 차원에서 제공

// 배열 대신 List를 이용해 안전하게 바꿘 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("좋은", "빠른", "저렴한");
        System.out.println(attributes);
    }
}

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

이 글은 “이펙티브 자바 3판” 책 내용을 정리한 글입니다.

만약 저작권 관련 문제가 있다면 “shk3029@kakao.com”로 메일을 보내주시면, 바로 삭제하도록 하겠습니다.

저작자표시