[effective java] item 27. 비검사 경고를 제거하라

결론

제네릭을 사용할 때, 가능한 한 모든 비검사 경고를 제거해야 합니다.
모든 비검사 경고는 런타임에 ClassCastException을 일으킬 수 있는 잠재적 가능성을 뜻하기 때문입니다. 
경고를 없앨 방법을 찾지 못했다면, 그 코드가 타입 안전함을 증명하고 가능한 한 범위를 좁혀 @SuppressWarning("unchecked") 애너테이션으로 경고를 숨깁시다. 그러고 경고를 숨기기로 한 근거를 주석으로 남깁시다.

 

 

설명

할 수 있는 한 모든 비검사 경고를 제거해라

제네릭을 사용하기 시작하면 수많은 컴파일러 경고를 보게 될 것입니다. 할 수 있는 한 모든 비검사 경고를 제거해야 합니다.

모두 제거한다면, 그 코드는 타입 안전성이 보장됩니다. 즉, 런타임에 ClassCastException이 발생할 일이 없고, 여러분이 의도한 대로 잘 동작하리라 확신할 수 있습니다. 

 

 

안전하다고 판단되면, @SuppressingWarnings("unchecked")

경고를 제거할 수 는 없지만, 타입 안전하다고 확신할 수 있다면 @SuppressWarnings("unchecked") 애너테이션을 달아 경고를 숨깁시다. 

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

 

적용 범위?

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

항상 가능한 한 좁은 범위에 적용합시다. 

보통은 변수 선언, 아주 짧은 메서드, 혹은 생성자가 됩니다. 자칫 심각한 경고를 놓칠 수 있으니, 절대로 클래스 전체에 적용해서는 안 됩니다. 

 

예제: unchecked cast 경고 발생

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

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

• 매개변수 a는 T[] 타입이 보장이 되지만, 컴파일러 입장에서 (T[]) 로 형변환 시 체크를 하지 않기 때문에 ClassCastException 발생 가능성 경고를 발생시킵니다.
  하지만 개발자 입장에서 안전하다고 보장할 수 있기 때문에, 해당 경고를 @SuppressWarings 애너테이션으로 숨기는 편이 깔끔합니다.
• return 문에는 @SuppressWarnings를 다는 것이 불가능합니다. 
• 그렇다고, 메서드 전체에 다는 것은 범위가 필요 이상으로 넓어집니다. 
• 그 대신 반환값을 담을 지역변수를 하나 선언하고, 그 변수에 애너테이션을 달아줄 수 있습니다.

 

@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;
}

 

주석

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

다른 사람이 그 코드를 잘못 수정하여 타입 안전성을 잃는 상황을 줄여줍니다.

 

 

---

출처

https://www.yes24.com/Product/Goods/65551284

이펙티브 자바 Effective Java 3/E - 예스24