Effective Java

[Effective Java] 아이템32 - 제네릭과 가변인수를 함께 쓸 때는 신중하라

돌에 2022. 3. 9. 00:01

제네릭과 varargs가 함께한다는 사실 만으로도 컴파일 경고를 불러일으키기 쉽다.

 

거의 모든 제네릭과 매개변수화 타입은 실체화되지 않아 실체화 불가 타입으로 불린다.

 

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

→ 배열의 원소가 실체화 불가 타입일 경우 경고가 발생한다.

 

  1. 메서드를 선언할 때 실체화 불가 타입으로 varargs 매개변수를 선언하면 컴파일러가 경고를 보낸다.
  2. 가변인수 메서드를 호출할 때도 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
}

→ 제네릭 varargs 배열 매개변수에 값을 저장하는 것은 안전하지 않다.

 

하지만, 제네릭이나 매개변수화 타입의 varargs 매개변수를 받는 메서드가 매우 유용하기 때문에 허용된다.

 

자바 라이브러리도 해당 메서드를 제공하며, 이들은 타입 안전하다.

Arrays.asList(T... a), Collections. addAll(Collection c, T... elements), EnumSet.of(E first, E... rest)가 대표적이다.

 

 

@SafeVarargs 애너테이션을 사용하여 타입 안전함을 보장하라.

 

자바 7에서는 @SafeVarargs 애너테이션이 추가되어,

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

메서드 작성자가 그 메서드가 타입 안전함을 보장하며, 컴파일러도 경고를 보내지 않는다.

 

→ 메서드가 안전한 게 확실하지 않다면 절대 @SafeVarargs 애너테이션을 달아서는 안된다.

 

메서드가 안전한지는 어떻게 확신할 수 있을까?

 

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

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

 

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

 

이때, varargs 매개변수 배열에 아무것도 저장하지 않고도 타입 안전성을 깰 수 있으니 주의해야 한다.

 

#1

 

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

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

 

위 메서드가 반환하는 배열의 타입은 이 메서드에 인수를 넘기는 컴파일타임 에 결정되는데,

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

 

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

 

 

#2

 

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（"좋은", "빠른", "저렴한"）;
}

 

위 코드는 별다른 경고 없이 컴파일되지만, 실행하면 ClassCastExcaption이 발생한다.

 

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

하지만 pickTwo 메서드는 항상 Object 타입 배열을 반환하고,

Object[]는 String[]의 하위 타입이 아니기 때문에 형변환은 실패한다.

 

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

 

단,

  1. @SafeVarargs로 어노테이트된 또 다른 varargs 메서드에 넘기는 것은 안전하다.
  2. 제네릭 varargs 매개변수 배열 내용의 일부 함수를 호출만 하는(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 애너테이션은 재정의할 수 없는 메서드에만 달아야 한다. 재정의한 메서드도 안전할지는 보장할 수 없기 때문이다. 자바 8에서 이 애너테이션은 오직 정적 메서드와 final 인스턴스 메서드에만 붙일 수 있고, 자바 9부터는 private 인스턴스 메서드에도 허용된다.

 

 

제네릭 varargs 매개변수를 List로 대체하면 타입 안전하다.

 

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

실체는 배열인 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 res나It;
}

 

정적 팩터리 메서드인 List.of를 활용하면 다음 코드와 같이 임의 개수의 인수를 넘길 수 있다.

이렇게 사용하는 게 가능한 이유는 List.of에도 @SafeVarargs 애너테이션이 달려 있기 때문이다.

 

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

 

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

@SafeVarargs 애너테이션을 직접 달지 않아도 되며, 실수로 안전 하다고 판단할 걱정도 없다.

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

 

 

가변인수와 제네릭은 궁합이 좋지 않다. 가변인수 기능은 배열을 노출하여 추상화가 완벽하지 못하고, 배열과 제네릭의 타입 규칙이 서로 다르기 때문이다. 제네릭 varargs 매개변수는 타입 안전하지는 않지만, 허용된다. 메서드에 제네릭(혹은 매개변수화된) varargs 매개변수를 사용하고자 한다면, 먼저 그 메서드가 타입 안전한지 확인한 다음 @SafeVarargs 애너테이션을 달아 사용하는 데 불편함이 없게끔 하자.