Book/Effective Java 3E

Item 27. 비검사 경고를 제거하라

hanseom 2022. 11. 8. 23:00
반응형

  제네릭을 사용하기 시작하면 수많은 컴파일러 경고를 보게 될 것입니다. 비검사 형변환 경고, 비검사 메서드 호출 경고, 비검사 매개변수화 가변인수 타입 경고, 비검사 변환 경고 등입니다. 대부분의 비검사 경고는 쉽게 제거할 수 있습니다.

 

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

 

// warning 발생(javac 명령줄 인수에 -Xlint:uncheck 옵션 추가)
Set<Lark> exaltation = new HashSet();

// 비검사 경고 제거
Set<Lark> exaltation = new HashSet<>();

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

 

@SuppressWarnings("unchecked")

  경고를 제거할 수는 없지만 타입 안전하다고 확실할 수 있다면 @SuppressWarnings("unchecked") 애너테이션을 달아 경고를 숨깁니다. @SuppressWarnings 애너테이션은 개별 지역변수 선언부터 클래스 전체까지 어떤 선언에도 달 수 있습니다. 하지만 @SuppressWarnings 애너테이션은 항상 가능한 한 좁은 범위에 적용해야 합니다. 보통은 변수 선언, 아주 짧은 메서드, 혹은 생성자가 될 것입니다. 자칫 심각한 경고를 놓칠 수 있으니 절대로 클래스 전체에 적용해서는 안 됩니다.

 

  한 줄이 넘는 메서드나 생성자에 달린 @SuppressWarnings 애너테이션을 발견하면 지역변수 선언 쪽으로 옮깁니다. ArrayList에서 가져온 다음의 toArray 메서드를 예로 생각해 봅시다.

// ArrayList를 컴파일하면 이 메서드에서 경고가 발생한다.
public <T> T[] toArray(T[] a) {
  if (a.length < size)
    return (T[]) Arrays.copyOf(elements, size, a.getClass());
  System.arraycopy(elements, 0, a, 0, size);
  if(a.length > size)
    a[size] = null;
  return a;
}

  다음 코드는 깔끔하게 컴파일되고 비검사 경고를 숨기는 범위도 최소로 좁혔습니다.

// 코드 27-1 지역변수를 추가해 @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") 애너테이션을 사용할 때면 그 경고를 무시해도 안전한 이유를 항상 주석으로 남겨야 합니다.

 

비검사 경고는 중요하니 무시하지 말자.

모든 비검사 경고는 런타임에 ClassCastException을 일으킬 수 있는 잠재적 가능성을 뜻하니 최선을 다해 제거하라.

경고를 없앨 방법을 찾지 못하겠다면, 그 코드가 타입 안전함을 증명하고 가능한 한 범위를 좁혀 @SuppressWarnings("unchecked") 애너테이션으로 경고를 숨겨라.

그런 다음 경고를 숨기기로 한 근거를 주석으로 남겨라.

[참고 정보]

이펙티브 자바 Effective Java 3/E 도서 [조슈아 블로크 ]

이펙티브 자바 깃허브 저장소

<이펙티브 자바, 3판> 번역 용어 해설

반응형