이왕이면 제네릭 타입으로 만들라 - [5장. 제네릭(아이템29)]

1. 들어가기 전 🏄‍♀️

  아래의 Object 기반으로 만들어진 Stack 클래스를 살펴보자.

public class Stack {
    private Object[] elements;
    private int size = 0;
    private static final int DEFAULT_INITIAL_CAPACITY = 16;

    public Stack() {
        elements = new Object[DEFAULT_INITIAL_CAPACITY];
    }

    public void push(Object e) {
        ensureCapacity();
        elements[size++] = e;
    }

    public Object pop() {
        if(size == 0)
            throw new EmptyStackException();

        Object result = elements[--size];
        elements[size] = null; // 다 쓴 참조 객체 해제
        return result;
    }

    public boolean isEmpty() {
        return size == 0;
    }

    private void ensureCapacity() {
        if(elements.length == size) {
            elements = Arrays.copyOf(elements, 2 * size + 1);
        }
    }
}

----------

public static void main(String[] args) {
    Stack stack = new Stack();
    for(String arg : List.of("a", "b", "c"))
        stack.push(arg);
    while (!stack.isEmpty()) {
        System.out.println(((String)stack.pop()).toUpperCase());
    }
}

  이 클래스는 제네릭 타입이어야 한다. 클라이언트는 스택에서 꺼낸 객체를 형변환해야 하는데, 이때 런타임 오류가 날 위험이 있기 때문이다.

 

  그래서 '클래스 선언에 타입 매개 변수를 추가하고', '코드에 쓰인 Object를 적절한 타입 매개변수로 바꾸면' 아래와 같다.

public class Stack<E> {
    private E[] elements;
    private int size = 0;
    private static final int DEFAULT_INITIAL_CAPACITY = 16;

    public Stack() {
        elements = new E[DEFAULT_INITIAL_CAPACITY]; // Type parameter 'E' cannot be instantiated directly
    }

    public void push(E e) {
        ensureCapacity();
        elements[size++] = e;
    }

    public E pop() {
        if(size == 0)
            throw new EmptyStackException();

        E result = elements[--size];
        elements[size] = null; // 다 쓴 참조 객체 해제
        return result;
    }

    public boolean isEmpty() {
        return size == 0;
    }

    private void ensureCapacity() {
        if(elements.length == size) {
            elements = Arrays.copyOf(elements, 2 * size + 1);
        }
    }
}

  해당 코드는 컴파일되지 않는다. 

  elements = new E[DEFAULT_INITIAL_CAPACITY];에서와 같이 E와 같은 실체화 불가 타입으로는 배열을 만들 수 없기 때문이다. 제네릭 배열 생성을 제거하는 두 가지 방법을 알아보면서 제네릭 타입으로의 변경을 완성해 보자.

 

 

2. [방법 1] Object 배열을 생성한 다음 제네릭 배열로 형변환하는 것 🏌️‍♀️

  제네릭 배열 생성 오류를 해결하는 첫 번째 방법은 Object 배열을 생성한 다음 제네릭 배열로 형변환을 하는 것이다.

// 기존
public Stack() {
    elements = new E[DEFAULT_INITIAL_CAPACITY];
}

// 변경
public Stack() {
    elements = (E[]) new Object[DEFAULT_INITIAL_CAPACITY]; // Unchecked cast: 'java.lang.Object[]' to 'E[]'
}

  이렇게 하면 일반적으로는 타입이 안전하지 않아서 컴파일러가 경고를 보낸다.

 

  하지만, 배열 elements는 private 필드에 저장되고, 클라이언트로 반환되거나 다른 메서드에 전달되는 일이 전혀 없다. 비검사 형변환은 확실히 안전하다.

  그래서 아래와 같이 @SuppressWarnings 애너테이셔으로 경고를 숨길 수 있다.

// 배열 elements는 push(E)로 넘어온 E 인스턴스만 담는다.
// 따라서 타입 안전성을 보장하지만,
// 이 배열의 런타임 타입은 E[]가 아닌 Object[]다!
@SuppressWarnings("unchecked")
public Stack() {
    elements = (E[]) new Object[DEFAULT_INITIAL_CAPACITY];
}

 

  제네릭 배열 생성을 제거하는 첫 번째 방법의 장단점은 아래와 같다.

• 장점
  가독성이 좋다.
  형변환을 배열 생성 시에만 해주면 된다.
• 단점
  E가 Object가 아닌 한 배열의 런타임 타입이 컴파일타임 타입과 달라 힙 오염(Heap Pollution)을 일으킨다.

 

 

3. [방법 2] elements 필드의 타입을 E[]에서 Object[]로 바꾸는 것 🏂

  제네릭 배열 생성 오류를 해결하는 두 번째 방법은 elements 필드의 타입을 E[]에서 Object[]로 바꾸는 것이다.

public class Stack<E> {

    private Object[] elements;
    private int size = 0;
    private static final int DEFAULT_INITIAL_CAPACITY = 16;

    public Stack() {
        elements = new Object[DEFAULT_INITIAL_CAPACITY];
    }

    public void push(E e) {
        ensureCapacity();
        elements[size++] = e;
    }

    public E pop() {
        if(size == 0)
            throw new EmptyStackException();

        E result = (E) elements[--size];
        elements[size] = null; // 다 쓴 참조 객체 해제
        return result;
    }

    public boolean isEmpty() {
        return size == 0;
    }

    private void ensureCapacity() {
        if(elements.length == size) {
            elements = Arrays.copyOf(elements, 2 * size + 1);
        }
    }
}

  pop() 메서드에서 배열이 반환한 원소를 E로 형변환하는 과정에서 경고가 뜬다.

public E pop() {
    if(size == 0)
        throw new EmptyStackException();

    E result = (E) elements[--size]; // Unchecked cast: 'java.lang.Object' to 'E'
    elements[size] = null; // 다 쓴 참조 객체 해제
    return result;
}

  E는 실체화 불가 타입이므로 컴파일러는 런타임에 이뤄지는 형변환이 안전한지 증명할 방법이 없다. 이번에도 마찬가지로 우리가 직접 증명하고 경고를 숨길 수 있다.

public E pop() {
    if(size == 0)
        throw new EmptyStackException();

    // push에서 E 타입만 허용하므로 이 형변환은 안전하다.
    @SuppressWarnings("unchecked")
    E result = (E) elements[--size];

    elements[size] = null; // 다 쓴 참조 객체 해제
    return result;
}

 

  제네릭 배열 생성을 제거하는 두 번째 방법의 장단점은 아래와 같다.

• 장점
  힙 오염을 걱정하지 않아도 된다.
• 단점
  배열에서 원소를 읽을 때마다 형변환을 해줘야 한다.

 

 

4. 마무리 🏇

  지금까지 설명한 방법이 이전 아이템 주제인 '배열보다는 리스트를 사용하라'와 모순된다고 생각할 수 있다. 하지만, 배열을 항상 리스트로 바꿀 수 있는 것은 아니다. 그리고 항상 좋은 것도 아니다. 또한, 자료구조는 성능에 민감하기 때문에 자료구조를 구현할 때에는 배열을 쓰는 경우가 많다.

  그렇기 때문에 이번 아이템에서 설명한 Stack 예제도 알아두도록 하자.

 

해당 글은 백기선 님의 '이펙티브 자바 완벽 공략'을 참고하였습니다.