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

• 가변인수 메서드 (varargs) 와 제네릭은 자바 5 때 함께 추가되었으니 서로 잘 어우러지리라 기대하겠지만, 그렇지 않다.
• 가변인수는 메서드에 넘기는 인수의 개수를 클라이언트가 조절할 수 있게 해주는데, 구현 방식에 허점이 있다.

 

 

• 가변인수 메서드를 호출하면 가변인수를 담기 위한 배열이 자동으로 하나 만들어지는데
• 내부로 감춰야 했을 이 배열을 그만 클라이언트에 노출하는 문제가 생겼고
• 그 결과 varargs 매개변수에 제네릭이나 매개변수화 타입이  포함되면 알기 어려운 컴파일 경고가 발생한다.

 

 

 

• 아이템 28에서 실체화 불가 타입은 런타임에는 컴파일타임보다 타입 관련정보를 적게 담고 있음을 배웠다.
• 그리고 거의 모든 제네릭과 매개변수화 타입은 실체화되지 않는다.
• 메서드를 선언할 때 실체화 불가 타입으로 varargs 매개변수를 선언하면 컴파일러가 경고를 보낸다.
• 다음 메서드를 예로 생각해보자.

 

 

 

• 이 메서드에서는 형변환하는 곳이 보이지 않는데도 인수를 건네 호출하면 ClassCastException을 던진다.
• 마지막 줄에 컴파일러가 생성한 형변환이 숨어 있기 때문이다. 
• 이처럼 타입 안정성이 깨지니 제네릭 varargs 배열 매개변수에 값을 저장하는 것은 안전하지 않다.
• 하지만 경고로 끝내는 이유는 뭘까?

 

 

 

• 그 답은 제네릭이나 매개변수화 타입의 varargs 매개변수를 받는 메서드가 실무에서 매우 유용하기 때문이다.
• 그래서 언어 설계자는 이 모순을 수용하기로 했다.
• 사실 자바 라이브러리도 이런 메서드를 여럿 제공하는데 Arrays.asList(T... a), Collections.addAll(Collection<? super T> c, T... elements ), EnumSet.of(E first, E... rest) 가 대표적이다.
• 다행히 점은 앞서 보인 위험한 메서드와 달리 이들은 타입 안전하다.

 

 

 

 

@SafeVarargs

---

• 자바 7에서는 @SafeVarargs 애너테이션이 추가되어 제네릭 가변인수 메서드 작성자가 클라이언트 측에서 발생하는 경고를 숨길 수 있게 되었다.
• @SafeVarargs 애너테이션은 메서드 작성자가 그 메서드가 타입 안전함을 보장하는 장치다.
• 컴파일러는 이 약속을 믿고 메서드가 안전하지 않을 수 있다는 경고를 더 이상 하지 않는다.

 

 

• 그렇다면 메서드가 안전한지는 어떻게 확신할 수 있을까?
• 가변인수 메서드를 호출할 때 varargs 매개변수를 담는 제네릭 배열이 만들어진다는 사실을 기억하자.
• 메서드가 이 배열에 아무것도 저장하지 않고 그 배열의 참조가 밖으로 노출되지 않는다면 타입 안전하다.
• 즉, 이 varargs 매개변수 배열이 호출자로부터 그 메서드로 순수하게 인수들을 전달하는 일만 한다면 그 메서드는 안전하다.

 

 

• 다음 코드는 가변인수로 넘어온 매개변수들을 배열에 담아 반환하는 제네릭 메서드다. 얼핏 보면 편리한 유틸리티로 보이지만, 보기와 달리 위험하다.

• 구체적인 예를 살펴보자. 이 메서드는 제네릭 가변인수를 받는 toArray 메서드를 호출한다는 점만 빼면 위험하지 않고 컴파일 경고도 내지 않을 것이다.
• 이 메서드를 본 컴파일러는 toArray에 넘길 T 인스턴스 2개를 담을 varargs 매개변수 배열을 만드는 코드를 생성한다.
• 이 코드가 만드는 배열의 타입은 Object[] 인데, pickTwo에 어떤 타입의 객체를 넘기더라도 담을 수 있는 가장 구체적인 타입이기 때문이다.
• 그리고 toArray 메서드가 돌려준 이 배열이 그대로 pickTwo를 호출한 클라이언트까지 전달된다.
• 즉 pickTwo는 항상 Object[] 타입 배열을 반환한다.

 

 

 

• 해당 코드를 실행하면 pickTwo의 반환값을 attributes에 저장하기 위해 String[]으로 형변환하는 코드를 컴파일러가 자동 생성하게 된다.
• Object[]는 String[]의 하위 타입이 아니므로 이 형변환은 실패한다.
• 이 예는 제네릭 varargs 매개변수 배열에 다른 메서드가 접근하도록 허용하면 안전하지 않다는 점을 다시 상기시킨다.

 

 

단 예외가 2가지 있다.

• 첫째로, @SafeVarargs로 제대로 애노테이트된 또 다른 varargs 메서드에 넘기는 것은 안전하다.
• 두번째, 이 배열 내용의 일부 함수를 호출만 하는 일반 메서드에 넘기는 것도 안전하다.

 

 

 

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

 

 

 

 

@SafeVarargs 애너테이션을 언제 사용해야 할까?

---

• 제네릭이나 매개변수화 타입의 varargs 매개변수를 받는 모든 메서드에 @SafeVarargs를 달라.
• 그래야 사용자를 헷갈리게 하는 컴파일러 경고를 없앨 수 있다.
• 다음 두 조건을 모두 만족하는 제네릭 varargs 메서드는 안전하다. 둘 중 하나라도 어겼다면 수정하라.

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

 

 

 

 

• @SafeVarargs 애너테이션이 유일한 정답은 아니다. varargs 매개변수를 List 매개변수로 바꿀수도 있다.
• 정적 팩터리 메서드인 List.of를 활용 시 이 메서드에 임의 개수의 인수를 넘길 수 있다.
• 이렇게 사용하는게 가능한 이유는 List.of에도 @SafeVarargs 애너테이션이 달려 있기 때문이다.

 

 

 

 

• 이 toArray의 List버전이 바로 List.of로 pickTwo에 적용하면 다음처럼 된다.
• 결과 코드는 배열 없이 제네릭만 사용하므로 타입 안전하다.

 

 

 

핵심 정리

---

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

 

 

 

참고 자료 

---

이펙티브 자바