비검사 경고를 제거하라 - [5장. 제네릭(아이템27)]

1. 비검사 경고 개념 🦜

  '비검사(unchecked) 경고'란 컴파일러가 타입 안전성을 확인하는데 필요한 정보가 충분하지 않을 때 발생시키는 경고이다.

  비검사 경고의 예시 중에 하나로 다음과 같이 로 타입을 사용하는 경우를 들 수 있다.

public static void main(String[] args) {

    // 비검사 경고 발생
    // Raw use of parameterized class 'Set'
    Set names = new HashSet();

    // 비검사 경고 발생
    // Raw use of parameterized class 'HashSet'
    Set<String> strings = new HashSet();
}

 

2. 비검사 경고를 제거해야 하는 이유 🦚

  이번 아이템에서는 '비검사 경고를 제거하라'라고 말하고 있다. 그 이유는 다음과 같다.

1. 안전하다고 검증된 비검사 경고를 숨기지 않고 그대로 두면, 진짜 문제를 알리는 새로운 경고가 나와도 눈치채지 못할 수 있다.
2. 제거하지 않은 수많은 거짓 경고 속에 새로운 경고가 파묻힐 수 있다.

  그래서 할 수 있는 한 모든 비검사 경고를 제거해야 한다. 그리고 경고를 제거할 수는 없지만 타입이 안전하다고 확신하면 @SuppressWarnings("unchecked") 애너테이션을 달아서 경고를 숨기도록 해야 한다.

 

3. @SuppressWarnings("unchecked") 사용 방법 🦢

  @SuppressWarnings("unchecked") 애너테이션은 개별 지역변수 선언부터 클래스 전체까지 어떤 선언에도 모두 달 수 있다. 

// 비검사 경고가 발생하는 경우
public class ListExample {

    private int size;

    Object[] elements;

    public <T> T[] toArray(T[] a) {

        if(a.length < size) {
            
            // 비검사 경고 발생
            // Unchecked cast: 'java.lang.Object[]' to 'T[]'
            T[] result = (T[]) Arrays.copyOf(elements, size, a.getClass());
            return result;
        }

        if(a.length > size) {
            a[size] = null;
        }

        return a;
    }
}

// 1. 클래스에 @SuppressWarnings를 적용하는 경우
@SuppressWarnings("unchecked")
public class ListExample {

    private int size;

    Object[] elements;

    public <T> T[] toArray(T[] a) {

        if(a.length < size) {

            T[] result = (T[]) Arrays.copyOf(elements, size, a.getClass());
            return result;
        }

        if(a.length > size) {
            a[size] = null;
        }

        return a;
    }
}

// 2. 메서드에 @SuppressWarnings를 적용하는 경우
public class ListExample {

    private int size;

    Object[] elements;

    @SuppressWarnings("unchecked")
    public <T> T[] toArray(T[] a) {

        if(a.length < size) {

            T[] result = (T[]) Arrays.copyOf(elements, size, a.getClass());
            return result;
        }

        if(a.length > size) {
            a[size] = null;
        }

        return a;
    }
}

// 3. 변수 선언에 @SuppressWarnings를 적용하는 경우
public class ListExample {

    private int size;

    Object[] elements;
    
    public <T> T[] toArray(T[] a) {

        if(a.length < size) {

            @SuppressWarnings("unchecked")
            T[] result = (T[]) Arrays.copyOf(elements, size, a.getClass());
            return result;
        }

        if(a.length > size) {
            a[size] = null;
        }

        return a;
    }
}

 

  하지만 @SuppressWarnings 애너테이션은 항상 가능한 한 좁은 범위에 적용해야 한다. 가능한 한 좁은 범위에 적용해야 하는 이유는 넓은 범위에 @SuppressWarnings를 적용하게 된다면 해당 범위에서 우리가 인지하지 못한 비검사 경고가 숨겨질 수 있기 때문이다.

 

  또한, 애너테이션은 선언에만 달 수 있기 때문에 return 문에는 @SuppressWarnings를 다는 게 불가능하다. 반환값을 담을 지역변수를 하나 선언하고 그 변수에 애너테이션을 달아주자.

// return문에 @SuppressWarnings를 부착하는 경우
public class ListExample {

    private int size;

    Object[] elements;

    public <T> T[] toArray(T[] a) {

        if(a.length < size) {

            // 'Annotations are not allowed here' 라고 알려줌
            @SuppressWarnings("unchecked")
            return (T[]) Arrays.copyOf(elements, size, a.getClass());
        }

        if(a.length > size) {
            a[size] = null;
        }

        return a;
    }
}

// 반환값을 담을 지역변수 이용
public class ListExample {

    private int size;

    Object[] elements;
    
    public <T> T[] toArray(T[] a) {

        if(a.length < size) {

            @SuppressWarnings("unchecked")
            T[] result = (T[]) Arrays.copyOf(elements, size, a.getClass());
            return result;
        }

        if(a.length > size) {
            a[size] = null;
        }

        return a;
    }
}

 

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

public class ListExample {

    private int size;

    Object[] elements;

    public <T> T[] toArray(T[] a) {

        if(a.length < size) {

            /**
             * 경고를 무시해도 안전한 이유는 ~~~ 이다.
             */
            @SuppressWarnings("unchecked")
            T[] result = (T[]) Arrays.copyOf(elements, size, a.getClass());
            return result;
        }

        if(a.length > size) {
            a[size] = null;
        }

        return a;
    }
}

  이렇게 하면 다른 사람이 그 코드를 이해하는 데 도움이 되며, 더 중요하게는, 다른 사람이 그 코드를 잘못 수정하여 타입 안전성을 잃는 상황을 줄여주기 때문이다.

 

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