[Effective Java] Item 32. 제네릭과 가변인수를 함께 쓸 때는 신중하라

가변인수(varags) 메서드와 제네릭은 서로 잘 어우러지지 않는다.

 

1. 가변인수 메서드를 호출하면 가변인수를 담기 위한 배열이 자동으로 하나 만들어지는데 만약 varargs 매개변수에 제네릭이나 매개변수화 타입이 포함되면 컴파일러는 타입 안전하지 않다고 생각하여 컴파일 경고를한다.

 

2. 모든 제네릭과 매개변수화 타입은 실체화되지 않는데, 메서드를 선언할 때 실체화 불가 타입으로 varargs 매개변수를 선언하면 컴파일러가 경고를 보낸다.

 

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

다른 타입 객체를 참조하는 상황에서 컴파일러가 자동 생성한 형변환이 실패할 수 있어 제네릭의 타입 안전이 실패한다.

 

---

 

힙 오염

 

제네릭과 varargs를 혼용하면 타입 안정성이 깨진다.

 

 

마지막 코드에 컴파일러가 생성한 보이지 않는 형변환으로 인해 타입 안전성이 깨지니 제네릭 varargs 배열 매개변수에 값을 저장하는 것은 안전하지 않다.

 

---

하지만 제네릭이나 매개변수화 타입의 varargs 매개변수를 받는 메서드가 유용할 때도 있다.

대표적으로 Arrays.asList(T... a), Collections.addAll(Collection<? super T> c)등이 있는데 앞서 보여준 메서드와 달리 타입 안전하다.

 

 

@SafeVarargs

 

• 자바 7에서 @SafeVarargs 애너테이션이 추가되었다.
• @SafeVarargs는 메서드 작성자가 그 메서드가 타입 안전함을 보장하는 장치다.
• 컴파일러는 이 약속을 믿고 그 메서드가 안전하지 않다는 경고를 더 이상 하지 않는다.

 

메서드가 안전한게 확실할 때 @SafeVarargs를 달자.

 

어떻게 확신할까?

 

가변인수 메서드를 호출하면 varargs 매개변수를 담는 제네릭 배열이 만들어지는데,

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

 

이 두 조건을 만족하면 타입 안전하다.

 

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

 

---

 

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

 

 

아래 toArray 메서드는 자신의 제네릭 매개변수 배열의 참조를 노출하기 때문에 안전하지 않다.

 

 

toArray 메서드

제네릭 매개변수 T를 사용하여 가변인수를 받아 배열로 변환해주는 기능을 수행합니다. 이 메서드는 제네릭 배열을 반환하기 위해 사용될 수 있다.
메서드 내부에서 args 매개변수를 반환하고 있기 때문에, 메서드를 호출한 곳에서는 반환된 배열을 받아서 사용할 수 있다. 이렇게 배열을 반환함으로써, 메서드 외부에서도 해당 배열에 접근할 수 있다.

 

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

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

 

 

구체적인 예를 살펴보자.

 

toArray를 호출하는 pickTwo 메서드

 

 

1. 컴파일러는 toArray에 넘길 T 인스턴스 2개를 담을 varargs 매개변수 배열을 만드는 코드를 생성한다.
2. 이 코드가 만든 배열은 Object [ ]이다. (pickTwo에 어떤 타입의 객체를 넘기더라도 담을 수 있는 가장 구체적인 타입이기 때문에)
3. toArray 메서드가 돌려준 이 배열이 그대로 pickTwo를 호출한 클라이언트까지 전달된다.
4. pickTwo는 항상 Object[] 타입 배열을 반환한다.

 

 

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

Object []는 String []의 하위 타입이 아니므로 형변환 실패한다.

따라서 컴파일은 되지만 실행하면 ClassCastException을 던진다.

 

---

예외 두가지

1. @SafeVarargs로 제대로 애노테이트된 또 다른 varargs 메서드에 넘기는 것은 안전함.

2. 이 배열 내용의 일부 함수를 호출만 하는 일반 메서드에 넘기는 것도 안전함.

 

제네릭 varargs 매개변수를 안전하게 사용하는 예시

 

 

1.@SafeVarargs

 

flatten 메서드는 임의 개수의 리스트를 인수로 받아, 받은 순서대로 그 안의 모든 원소를 하나의 리스트로 옮겨 담아 반환한다.

 

 

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

 

두 조건을 만족했다면 @SafeVarargs를 달아 안전함을 보장하자.

 

 

 

2. varargs 매개변수를 List 매개변수로 바꾸자

 

 

매개변수 선언만 수정했다.

 

 

• 정적 팩터리 메서드인 List.of를 활용하면 위와 같이 flatten 메서드에 임의 개수의 인수를 넘길 수 있다.
• List.of에 @SafeVarargs가 이미 달려있기 때문에 가능하다.

 

 

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

단점 : 코드가 지저분해지거나 속도가 좀 느려질 수 있다.

 

 

앞서 작성한 pickTwo 메서드를 List로 안전하게 작성한 방법

 

 

---

 

결론

 

• 가변인수와 제네릭은 궁합이 좋지 않다.
• 제네릭 varargs 매개변수는 타입 안전하지는 않지만 혀용된다.
• 메서드에 제네릭 varargs 매개변수를 사용하고자 한다면, 먼저 그 메서드가 타입 안전한지 확인한 다음에 @SafeVarags 애너테이션을 달자.