[이펙티브 자바] 아이템 27: 비검사 경고를 제거하자

본문은 Effective Java를 읽고 간단하게 정리한 글입니다. 필요에 따라 생략/수정된 부분이 있을 수 있으며, 내용이 추후 변경될 수 있습니다.

 

선요약

• 비검사 경고는 중요하므로 무시하면 안된다
• 모든 비검사 경고는 런타임에 ClassCastException을 일으킬 수 있는 잠재적인 가능성이 있으므로 최선을 다해 제거한다
• 경고를 없애기 어렵다면 @SuppressWarnings("unchecked") 애너테이션으로 경고를 숨기되, 다음의 사항을 따라야 한다
  • 코드의 타입 안전함을 증명하라
  • 범위를 최대한 좁혀 @SuppressWarnings("unchecked") 애너테이션으로 경고를 숨겨라
  • 경고를 숨기기로 한 근거를 주석으로 남겨라

 

비검사 경고

비검사 경고란?

• unchecked warning, 컴파일러가 발생시키는 경고이다(원문 참고)

public class Item27 {

    public static void main(String[] args) {
        Set<String> mySet = new HashSet(); // 비검사 경고 발생
    }
}

해당 명령어를 실행시키면 아래와 같은 경고가 발생한다.

javac -Xlint:unchecked Item27.java

Item27.java:10: warning: [unchecked] unchecked conversion
        Set<String> mySet = new HashSet();
                            ^
  required: Set<String>
  found:    HashSet
1 warning

컴파일러가 알려준 대로 수정하면 경고가 사라진다.

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

타입 매개변수를 명시하는 대신, 자바 7부터 지원하는 다이아몬드 연산자(<>)를 사용하여 해결할 수 있다. 컴파일러가 올바른 실제 타입 매개변수(String)을 추론해준다.

 

비검사 경고 제거

• 위의 예제보다 제거하기 어려운 경고도 있지만, 할 수 있는 한 모든 비검사 경고를 제거해야 한다
• 모두 제거한다면 그 코드는 타입 안정성이 보장된다

 

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

• 경고를 제거할 수는 없지만 타입 안전하다고 확신할 수 있다면 @SuppressWarnings("unchecked") 애너테이션을 달아 경고를 숨기자
  • 이 경우 반드시 타입 안전함을 검증해야 한다. 그렇지 않으면 런타임에 ClassCastException을 발생시킬 수 있다
  • 반대로 안전하다고 검증된 비검사 경고를 그대로 두면, 진짜 문제를 알리는 경고를 묵시하게 될 수 있다
  • 즉, @SuppressWarnings("unchecked") 애너테이션을 사용하여 불필요한 비검사 경고를 제거하되, 반드시 타입 안전함을 검증해야 한다
• @SuppressWarnings 애너테이션은 항상 가능한 한 좁은 범위에 적용하자
  • 보통은 변수 선언, 아주 짧은 메서드, 혹은 생성자가 될 것이다
  • 해당 애너테이션은 개별 지역변수 선언부터 클래스 전체까지 어떤 선언에도 달 수 있다
    • 자칫 심각한 경고를 놓칠 수 있으므로 절대로 클래스 전체에 적용해서는 안 된다

책에선 ArrayList의 toArray를 예시로 들고 있다

아래 메서드의 첫번째 return문에서 비검사 경고가 발생하지만, 애너테이션은 선언에만 달 수 있으므로 return문에 @SuppressWarnings를 다는 것은 불가능하다

// 생략
    public <T> T[] toArray(T[] a) {
        if (a.length < size)
            return (T[]) Arrays.copyOf(elementData, size, a.getClass()); // 비검사 경고 발생
        System.arraycopy(elementData, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;
        return a;
    }

 

반환값을 담을 지역변수를 하나 선언하고 해당 변수에 애너테이션을 달아주면 된다. 또한, 주석을 추가한다.

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

• 애너테이션이 적용되는 범위를 최소화했다(변수선언)
• @SuppressWarnings("unchecked") 애너테이션을 사용할 땐 반드시 비검사 경고를 무시해도 안전한 이유를 주석으로 남긴다

책에선 메서드 전체에 다는 것대신 변수 선언에 다는데, 실제 ArrayList엔 메서드 전체에 달려 있었다...

ArrayList.toArray