[effective java 3rd - ch.05 제네릭] Item27 : 비검사 경고(unchecked warning)를 제거하라

제네릭을 사용하면서 컴파일러 경고를 마주하게 된다. 그 종류는 아래와 같다

• 비검사 형변환 경고
• 비검사 메서드 호출 경고
• 비검사 매개변수화 가변인수 타입 경고(참고 https://donghyeon.dev/%EC%9D%B4%ED%8E%99%ED%8B%B0%EB%B8%8C%EC%9E%90%EB%B0%94/2021/04/18/%EC%A0%9C%EB%84%88%EB%A6%AD%EA%B3%BC-%EA%B0%80%EB%B3%80%EC%9D%B8%EC%88%98%EB%A5%BC-%ED%95%A8%EA%BB%98-%EC%93%B8-%EB%95%8C%EB%8A%94-%EC%8B%A0%EC%A4%91%ED%95%98%EC%9E%90/)
• 비검사 변환 경고

 

제거하기 쉬운 경고의 예

대부분의 비검사 경고는 쉽게 제거 가능하다.

Set<Lark> exaltation = new HashSet();
/*
warning: [unchecked] unchecked conversion
Set<Lark> exltation = new HashSet();

required : Set<Lark>
found: HashSet

*/

/*
Raw use of parameterized class 'HashSet' 
Unchecked assignment: 'java.util.HashSet' to 'java.util.Set<com.example.ssiach2ex1.entity.Lark>'
insert '<>'
*/

 

컴파일러가 알려준 타입 매개변수를 명시하면 에러 사라짐.  또는 자바 7부터 지원하는 다이아몬드 연산자 '<>'만 사용하여 해결 가능하다. 그러면 컴파일러가 올바른 실제 타입 매개변수 Lark를 추론한다.

Set<Lark> exaltation = new HashSet<Lark>(); //자바 7 이전

Set<Lark> exaltation = new HashSet<>(); //자바 7 이후부터 가능

이처럼 가능한 한 모든 비검사 경고를 제거하라. 모두 제거한다면 그 코드는 타입안정성이 보장된다.

즉 런타임에 ClassCastException이 발생할 일이 없다. 

 

경고를 제거할 수 없지만 타입이 안전하다고 확신할 수 있다면!,

@SuppressWarnings("unchecked") 어노테이션을 달아 경고를 숨기자. 안전하다고 검증된 비검사 경고를 숨기지 않고 그대로 두면 진짜 문제를 알리는 경고가 발생해도 눈치채기 어려울 수 있다.

 

 

@SuppressWarnings 어노테이션

@SuppressWarnings 어노테이션은 개별 지역변수 선언부터 클래스 전체까지 어떤 선언에도 달 수 있다. 그러나 항상 가능한 한 좁은 범위에 적용하는 것이 좋다. 보통은 변수선언, 짧은 메서드 또는 생성자에 적용할 수 있다. 중대한 경고를 놓칠수 있으니 클래스 전체에 적용해서는 안 된다.

 

한 줄이 넘는 메서드나 생성자에 달린 @SuppressWarnings 어노테이션은 지역변수 선언 쪽으로 옮겨라. 이를 위해 지역변수를 새로 선언해야 할 수도 있다.

 

ArrayList에서 가져온 toArray의 예

• Arrays.copyOf()는 특정 배열의 원하는 길이만큼 새로운 배열로 복사하는 메소드 함수이다.
• 새로운 배열 = Arrays.copyof(원본 배열, 원본 배열에서 복사하고 싶은 요소들의 길이); 식으로 사용된다.

public <T> T[] toArray(T[] a) {
    if (a.length < size)
        return (T[]) Arrays.copyOf(elements, size, a.getClass());
    System.arraycopy(elements, 0, a, 0);
    if (a.length > size)
        a[size] = null;
    return a;
}
/*경고발생
warning: [Unchecked] unchecked cast
return (T[]) Arrays.copyOf(elements, size, a.getClass());

required: T[]
found: Object[]

 */

 

이 경우 unchecked이지만, 생성한 배열과 파라미터로 받은 배열의 타입이 모두 T[]로 같으므로 올바른 형변환이었다.

따라서 unchecked 경고가 발생하지 않도록 할 필요가 있다.

 

• 아래오 같이 result 지역변수를 선언하고 그 선언부에 어노테이션 추가.
• 이로서 컴파일에 문제가 일어나지 않았으며(경고가 발생하지 않았으므로), (지역변수를 선언함으로써) 비검사 경고를 숨기는 범위도 최소로 좁혔다.

public <T> T[] toArray(T[] a) {
    if (a.length < size) {
        //생성한 배열과 매개변수로 받은 배열의 타입이 모두 T[]로 같으므로 올바른 형변환이다.
        //따라서 지역변수를 추가하고 그 선언부에 @SuppressWarnings를 달아 범위를 좁힌다.
        @SuppressWarnings("unchecked") T[] result =
                (T[]) Arrays.copyOf(elements, size, a.getClass());
        
        return result;
    }
    System.arraycopy(elements, 0, a, 0);
    if (a.length > size)
        a[size] = null;
    return a;
}

 

@SuppressWarnings("unchecked") 어노테이션을 사용할 때는 경고를 무시하는 이유를 주석으로 남겨야 한다.

이는 타인이 그 코드를 수정하여 타입 안정성을 잃는 상황을 줄여준다.

 

--

 

정리

• 비검사 경고는 무시하지 말 것.
• 모든 비검사 경고는 런타임에 ClassCastException을 일으킬 수 있는 잠재적 가능성을 뜻하므로 제거에 최선을 다할 것.
• 경고를 없애지 못한다면 그 코드가 타입 안전함을 증명하고 가능한 한 범위를 좁혀 @SuppressWarnings("unchecked") 어노테이션으로 경고를 숨길 것.
• 경고를 숨겼다면 숨긴 근거를 주석으로 남길 것.