아이템 33 - 타입 안전 이종 컨테이너를 고려하라

제네릭은 Set<E>, Map<K, V> 같은 컬렉션과 ThreadLocal<T>, AtomoicReference<T> 등의 단일 원소 컨테이너에도 흔히 쓰인다. 이런 모든 쓰임에서 매개변수화되는 대상은 컨테이너 자신이다. 따라서 하나의 컨테이너에서 매개변수화할 수 있는 타입의 수가 제한된다. 컨테이너의 일반적인 용도에 맞게 설계된 것이니 문제될 건 없다.

하지만 더 유연한 수단이 필요할 때도 종종 있다. 예를들어 데이터베이스의 행은 임의 개수의 열을 가질 수 있는데, 모두 열을 타입 안전하게 이용할 수 있다면 좋을 것이다. 다행히 컨테이너 대신 키를 매개변수화한 다음, 컨테이너에 값을 넣거나 뺄 때 매개변수화한 키를 함께 제공하면 쉽게 해결된다. 이렇게 하면 제네릭 타입 시스템이 값의 타입이 키와 같음을 보장해줄 것이다. 이러한 설계 방식을 타입 안전 이종 컨테이너 패턴(type safe heterogeneous container pattern)이라 한다.

예제로 타입별로 즐겨 찾는 인스턴스를 저장하고 검색할 수 있는 Favorites 클래스를 생각해본다. 각 타입의 Class 객체를 매개변수화한 키 역할로 사용하면 되는데, 이 방식이 동작하는 이유는 class의 클래스가 제네릭이기 때문이다. class 리터럴의 타입은 Class가 아닌 Class<T> 이다. 예컨대 String.class의 타입은 Class<String>이고 Integer.class는 Class<Integer>인 식이다. 한편, 컴파일타임 타입 정보와 런타임 타입 정보를 알아내기 위해 메서드들이 주고받는 class 리터럴을 타입 토큰(type token)이라 한다. Favorites 클래스의 API는 아래와 같이 단순하다. 키가 매개변수화되었다는 점만 빼면 일반 맵처럼 보일 정도다. 클라이언트는 즐겨찾기를 저장하거나 얻어올 때 Class 객체를 알려주면 된다.

public class Favorites {
    public <T> void putFavorite(Class<T> type, T instance);
    public <T> T getFavorite(Class<T> type);
}

그리고 다음은 앞의 Favorites 클래스를 사용하는 예시다. 즐겨 찾는 Spring, Integer, Class 인스턴스를 저장, 검색, 출력하고 있다.

public static void main(String[] args) {
    Favorites f = new Favorites();

    f.putFavorite(String.class, "Java");
    f.putFavorite(Integer.class, 0xcafebabe);
    f.putFavorite(Class.class, Favorites.class);

    String favoritesString = f.getFavorite(String.class);
    int favoriteInteger = f.getFavorite(Integer.class);
    Class<?> favoriteClass = f.getFavorite(Class.class);

    Sytstem.out.printf("%s %x %s%n", favoriteString, favoriteInteger, favoriteClass.getName());
}

| 출력 값: Java cafebabe Favorites

Favorites 인스턴스는 타입 안전하다. String을 요청했는데 Integer를 반환하는 일은 절대 없다. 또한 모든 키의 타입이 제각각이라, 일반적인 맵과 달리 여러 가지 타입의 원소를 담을 수 있다. 따라서 Favorites는 타입 안전 이종(heterogeneous) 컨테이너라 할 만하다.

Favorites의 구현은 간단하지만 이것이 전부이다!

public class Favorites {
    private Map<Class<?>, Object> favorites = new HashMap<>();

    public <T> void putFavorite(Class<T> type, T instance) {
        favorites.put(Objects.requireNull(type), instance);
    }

    public <T> T getFavorite(Class<T> type) {
        return type.cast(favorites.get(type));
    }
}

Favorites가 사용하는 private 맵 변수인 favorites의 타입은 Map<Class<?>, Object>이다. 비한정적 와일드카드 타입이라 이 맵 안에 아무것도 넣을 수 없다고 생각할 수 있지만, 사실은 그 반대다. 와일드카드 타입이 중첩되었다는 점을 깨달아야 한다. 맵이 아니라 키가 와일드카드 타입인 것이다. 이는 모든 키가 서로 다른 매개변수화 타입일 수 있다는 뜻으로 첫 번째는 Class<String>, 두 번째는 Class<Integer> 식으로 될 수 있다. 다양한 타입을 지원하는 힘이 여기서 나온다.

그 다음으로는 favorites 맵의 값 타입은 단순히 Object라는 뜻이다. 즉, 이 맵은 키와 값 사이의 타입 관계를 보증하지 않는다는 말이다. 사실 자바의 타입 시스템에서는 이 관계를 명시할 방법이 없다. 하지만 우리는 이 관계가 성립함을 알고 있고, 즐겨찾기를 검색할 때 그 이점을 누리게 된다.

putFavorite 구현은 아주 쉽다. 주어진 Class 객체에 해당하는 값을 favorites 맵에서 꺼낸다. 이 객체가 바로 반환해야 할 객체가 맞지만, 잘못된 컴파일타임 타입을 가지고 있다. 이 객체의 타입은 Object이나, 우리는 이를 T로 바꿔 반환해야 한다. 따라서 getFavorite 구현은 Class의 cast 메서드를 사용해 이 객체 참조를 Class 객체가 가리키는 타입으로 동적 형변환한다.

cast 메서드는 형변환 연산자의 동적 버전이다. 이 메서드는 단순히 주어진 인수가 Class 객체가 알려주는 타입의 인스턴스인지를 검사한 다음, 맞다면 그 인수를 그대로 반환하고, 아니면 ClassCastException을 던진다. 클라이언트 코드가 깔끔히 컴파일된다면 getFavorite이 호출하는 cast는 ClassCastException을 던지지 않을 것이다. 다시 말해 favorites 맵 안의 값은 해당 키의 타입과 항상 일치함을 알고 있다.

| 그런데 cast 메서드가 단지 인수를 그대로 반환하기만 한다면 굳이 이것을 사용해야할까?

다음 코드에서 보듯 cast의 반환 타입은 Class 객체의 타입 매개변수화 같다.

public class Class<T> {
    T cast(Object obj);
}

이것이 정확히 getFavorite 메서드에 필요한 기능으로, T로 비검사 형변환하는 손실 없이도 Favorites를 타입 안전하게 만드는 비결이다.

지금까지 만든 Favorites의 제약 두 가지는 아래와 같다.

• 악의적인 클라이언트가 Class 객체를 (제네릭이 아닌) 로우 타입으로 넘기면 Favorites 인스턴스의 타입 안정성이 쉽게 깨진다.
  (하지만 이렇게 짜여진 클라이언트 코드에서는 비검사 경고가 뜰 것이다..)Favorites가 타입 불변식을 어기는 일이 없도록 보장하려면 putFavorite 메서드에서 인수로 주어진 instance의 타입이 type으로 명시한 타입과 같은지 확인하면 된다. 그 방법은 이미 알고 있듯, 다음 코드와 같이 그냥 동적 형변환을 쓰면 된다.

public <T> void putFavorite(Class<T> type, T instance) {
    favorites.put(Objects.requireNonNull(type), type.cast(instance));
}

java.util.Collections에는 checkedSet, checkedList, checkedMap 같은 메서드가 있는데, 바로 이 방식을 적용한 컬렉션 래퍼들이다. 이 정적 팩터리들은 컬렉션과 함께 1개(혹은 2개)의 Class 객체를 받는다. 이 메서드들은 모두 제네릭이라 Class 객체와 컬렉션의 컴파일타임 타입이 같음을 보장한다. 또한 이 래퍼들은 내부 컬렉션들을 실체화한다. 이 래퍼들은 제니릭과 로우 타입을 섞어 사용하는 애플리케이션에서 클라이언트 코드가 컬렉션에 잘못된 타입의 원소를 넣지 못하게 추적하는 데 도움을 준다.

• 실체화 불가 타입에는 사용할 수 없다는 것이다.
  다시 말해 즐겨찾는 String이나 String[] 은 저장할 수 있어도 즐겨 찾는 List<String>은 저장할 수 없다. List<String>을 저장하려는 코드는 컴파일되지 않을 것이다. List<String>용 Class 객체를 얻을 수 없기 때문이다. List<String>.class라고 쓰면 문법 오류가 난다. List<String>과 List<Integer>는 List.class라는 Class 객체를 공유하므로, 만약 List<String>.class와 List<Integer>.class를 허용해서 둘 다 똑같은 타입의 객체 참조를 반환한다면 Favorites 객체의 내부는 아수라장이 될 것이다. 이 두 번째 제약에 대한 완벽히 만족스러운 우회로는 없다.

Favorites가 사용하는 타입 토큰은 비한정적이다. 즉, getFavorite과 put Favorite은 어떤 Class 객체든 받아들인다. 때로는 이 메서드들이 허용하는 타입을 제한하고 싶을 수 있는데, 한정적 타입 토큰을 활용하면 가능하다. 한정적 타입 토큰이란 단순히 한정적 타입 매개변수나 한정적 와일드카드를 사용하여 표현 가능한 타입을 제한하는 타입 토큰이다.

애너테이션 API는 한정적 타입 토큰을 적극적으로 사용한다. 예를 들어 다음은 AnnotationElement 인터페이스에 선언된 메서드로, 대상 요소에 달려 있는 애너테이션을 런타임에 읽어오는 기능을 한다. 이 메서드는 리플렉션의 대상이 되는 타입들, 즉 클래스, 메서드, 필드 같이 프로그램 요소를 표현하는 타입들에서 구현한다.

public <T extends Annotation> T getAnnotation(Class<T> annotationType);

여기서 annotationType 인수는 애너테이션 타입을 뜻하는 한정적 타입 토큰이다. 이 메서드는 토큰으로 명시한 타입의 애너테이션이 대상 요소에 달려 있다면 그 애너테이션을 반환하고, 없다면 null을 반환한다. 즉, 애너테이션된 요소는 그 키가 애너테이션 타입인, 타입 안전 이종 컨테이너인 것이다.

Class<?> 타입의 객체가 있고, 이를 한정적 타입 토큰을 받는 메서드에 넘기려면 어떻게 해야할까? 객체를 Class<? extends Annotation>으로 형변환할 수도 있지만, 이 형변환은 비검사이므로 컴파일하면 경고가 뜰 것이다. 운 좋게도 Class 클래스가 이런 형변환을 안전하게 수행해주는 인스턴스 메서드를 제공한다. 바로 asSubClass 메서드로, 호출된 인스턴스 자신의 Class 객체를 인수가 명시한 클래스로 형변환한다. 형변환에 성공하면 인수로 받은 클래스 객체를 반환하고, 실패하면 ClassCastException을 던진다.

다음은 컴파일 시점에는 타입을 알 수 없는 애너테이션을 asSubClass 메서드를 사용해 런타임에 읽어내는 예다. 이 메서드는 오류나 경고 없이 컴파일된다.

static Annotation getAnnotation(AnnotatedElement element, String annotationTypeName) {
    Class<?> annotationType = null; // 비한정적 타입 토큰 
    try {
        annotationType = Class.forName(annotationType);
    } catch (Exception ex) {
        throw new IllegalArgumentException(ex);
    }
    return element.getAnnotation(
        annotationType.asSubclass(Annotation.class)
    );
}