아이템 27. 비검사 경고를 제거하라. - ksw6169/effective-java GitHub Wiki

할 수 있는 한 모든 비검사 경고는 제거해야 한다.

  • 제네릭을 사용하면 수많은 컴파일러 경고를 보게될 것이다.
  • 비검사 형변환 경고, 비검사 메소드 호출 경고, 비검사 매개변수화 가변인수 타입 경고 등이 그 예시다.
  • 대부분의 비검사 경고는 쉽게 제거할 수 있으므로 할 수 있는 한 모든 비검사 경고는 제거해야 한다.
  • 비검사 경고를 모두 제거한다면 그 코드는 타입 안전성이 보장된다.
  • 즉, 런타임에 ClassCastException 이 발생할 일이 없고, 의도한 대로 잘 동작하리라 확신할 수 있다.

@SuppressWarnings("unchecked")

  • 경고를 제거할 수는 없지만 타입 안전하다고 확신할 수 있다면 이 어노테이션을 사용해 경고를 숨기자.
  • 단, 타입 안전성을 검증하지 않은 채 경고를 숨기면 그 코드는 경고 없이 컴파일되겠지만, 런타임에는 여전히 ClassCastException 을 던질 수 있다. (즉, 타입 안전성을 보장할 수 없는 코드를 생성하게 되는 것이다.)
  • 반면에 안전하다고 검증된 비검사 경고를 그대로 두면 진짜 문제를 알리는 새로운 경고가 나와도 눈치채지 못할 수 있다.

@SuppressWarnings("unchecked") 는 가능한 한 좁은 범위에 적용해야 한다.

  • 이 어노테이션은 개별 지역변수 선언부터 클래스 전체까지 어떤 선언에도 달 수 있다.
  • 클래스 전체에 적용할 경우 자칫 심각한 경고를 놓칠 수 있으므로 가능한 좁은 범위에 적용해야 한다.
  • 한 줄이 넘는 메소드나 생성자에 달린 @SuppressWarnings 를 발견하면 지역변수 선언 쪽으로 옮기자.
  • 다음은 ArrayList의 toArray 메소드다. ArrayList를 컴파일하면 이 메소드에서 경고가 발생한다.
public <T> T[] toArray(T[] a) {
    if (a.length < size)
        return (T[]) Arrays.copyOf(elementData, size, a.getClass());

    ...
}
  • @SuppressWarnings 는 선언에만 달 수 있기 때문에 return 문에는 다는 게 불가능하다.
  • 따라서 반환값을 담을 지역변수를 하나 선언하고 그 변수에 어노테이션을 달아주자.
  • 다음은 toArray의 경고를 제거하기 위해 수정한 구문이다.
public <T> T[] toArray(T[] a) {
    if (a.length < size) {
        @SuppressWarnings("unchecked")
        T[] result = (T[]) Arrays.copyOf(elements, size, a.getClass());
				return result;
		}

    ...
}
  • 이 코드는 깔끔하게 컴파일되면서 비검사 경고를 숨기는 범위도 최소로 좁혔다.

@SuppressWarnings("unchecked") 를 사용할 때는 이유를 주석으로 남겨야 한다.

  • 이 어노테이션을 사용할 때는 그 경고를 무시해도 안전한 이유를 항상 주석으로 남겨야 한다.
  • 다른 사람이 코드를 이해하는 데 도움이 되며, 더 중요하게는 다른 사람이 그 코드를 잘못 수정하여 타입 안전성을 잃는 상황을 줄여준다.

참고 자료

  • Effective Java 3/E