제네릭 - 아이템 27. 비검사 경고를 제거하라

비검사 경고를 제거하라

비검사 경고란?

제네릭을 사용하기 시작하면 수많은 컴파일러 경고를 보게 될 것이다. 비검사 형변환 경고, 비검사 메서드 호출 경고, 비검사 매개변수화 가변인수 타입 경고, 비검사 변환 경고 등이다. 즉, 비검사 경고란 컴파일러 경고와 동일한 의미이다.

 

비검사 경고의 예시

Set<String> set = new HashSet();

위 코드와 같이 구현체의 타입을 명확히 주지 않은 채로 HashSet 객체를 생성할 수 있다.

 

Note: Recompile with -Xlint:unchecked for details.

그러면 컴파일러는 무엇이 잘못됐는지 위와 같이 친절하게 알려줄 것이다.

 

Set<String> set = new HashSet<>();

위 코드와 같이 다이아몬드 연산자(<>)를 붙여주면 타입을 추론할 수 있으므로, 경고가 사라진다. 이렇게, 할 수 있는 한 모든 비검사 경고를 제거하는 것이 좋다. 모두 제거한다면 그 코드는 타입 안전성이 보장된다. 즉, 런타임에 ClassCastException이 발생할 일이 없고, 의도대로 잘 동작하리라 확신할 수 있다.

 

@SuppressWarnings("unchecked") 애너테이션이란?

경고를 제거할 수 없지만 타입 안전하다고 확신할 수 있다면 @SuppressWarnings("unchecked") 애너테이션을 달아 경고를 숨길 수 있다. 단, 타입 안전함을 검증하지 않은 채 경고를 숨기면 스스로에게 잘못된 보안 인식을 심어주는 꼴이다. 그 코드는 경고 없이 컴파일되겠지만, 런타임에는 여전히 ClassCastException을 던질 수 있다.

@SuppressWarnings 애너테이션은 개별 지역변수 선언부터 클래스 전체까지 어떤 선언에도 달 수 있다. 하지만 @SuppressWarnings 애너테이션은 항상 가능한 좁은 범위에 적용해야 한다. 보통은 변수 선언, 아주 짧은 메서드, 혹은 생성자가 될 것이다. 자칫 심각한 경고를 놓칠 수 있기 때문에, 절대로 클래스 전체에 적용해서는 안 된다.

 

@SuppressWarnings("unchecked") 애너테이션의 사용

한 줄이 넘는 메서드나 생성자에 달린 @SuppressWarnings 애너테이션을 발견하면 지역변수 선언 쪽으로 옮겨야 한다.

 

public <T> T[] toArray(T[] a) {
    if (a.length < size) {
        return (T[]) Arrays.copyOf(elements, size, a.getClass());
    }
    System.arraycopy(elements, 0, a, 0, size);
    if (a.length > size)
        a[size] = null;
    return a;
}

위 코드는 ArrayList에서 가져온 toArray() 메서드이다. 위 코드를 컴파일하면 warning : [unchecked] unchecked cast 경고가 발생한다.

 

애너테이션은 선언에만 달 수 있기 때문에 return 문에는 @SuppressWarnings를 다는 게 불가능하다. 메서드 전체에 달수도 있지만, 범위가 필요 이상으로 넓어지기 때문에 이 방법은 자제해야 한다.

 

public <T> T[] toArray(T[] a) {
    if (a.length < size) {
        // 생성한 배열과 매개변수로 받은 배열의 타입이 모두 T[]로 같으므로 올바른 형변환
        @SuppressWarnings("unchecked") T[] result = 
            (T[]) Arrays.copyOf(elements, size, a.getClass());
        return result;
    }
    System.arraycopy(elements, 0, a, 0, size);
    if (a.length > size)
        a[size] = null;
    return a;
}

 

그 대신, 반환값을 담을 지역변수를 하나 선언하고 그 변수에 애너테이션을 달아주면 된다. 위 코드는 toArray() 메서드를 이러한 방식으로 수정한 예이다. 위 코드는 깔끔하게 컴파일되고 비검사 경고를 숨기는 범위도 최소로 좁혔다.

또한, @SuppressWarning("unchecked") 애너테이션을 사용할 때면 그 경고를 무시해도 안전한 이유를 항상 주석으로 남겨야 한다.

 

최종 정리

비검사 경고는 중요하니 무시하지 말아야 한다. 모든 비검사 경고는 런타임에 ClassCastException을 일으킬 수 있는 잠재적 가능성을 뜻하니 최선을 다해 제거해야 한다. 경고를 없앨 방법을 찾지 못하겠다면, 그 코드가 타입 안전함을 증명하고 가능한 범위를 좁혀 @SuppressWarnings("unchecked") 애너테이션으로 경고를 숨겨야 한다. 그런 다음 경고를 숨기기로 한 근거를 주석으로 남겨야 한다.

---

출처

ㆍ 이펙티브 자바 Effective Java 3/E. 조슈아 블로크 저자(글) · 개앞맵시(이복연) 번역