[이펙티브 자바] Item27. 비검사 경고를 제거하라.

 

[이펙티브 자바] Item27. 비검사 경고를 제거하라. 

제네릭을 이제 사용하기 시작하면 많은 컴파일러 경고를 보게 된다. 

비검사 형변환 경고, 비검사 메서드 호출 경고, 비검사 매개변수화 가변인수 타입 경고, 비검사 변환 경고 등이 있다. 

 

 

대부분의 비검사 경고는 컴파일러가 무엇이 잘못되었는지 설명해주기 때문에 쉽게 제거할 수 있다. 

위에서는 로 타입을 사용했다고 경고하는 것이다. 

 

 

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

 

 비검사 경고란, 컴파일 시에 컴파일러가 자바 코드를 컴파일하고 나서 잘못된 것들에 대해 경고하는 옵션을 의미한다.

모두 제거한다면 그 코드는 타입 안정성이 보장된다. 즉, 런타임에 ClassCastException이 발생할 일이 없다. 

그런데  경고를 제거할 수는 없지만 타입 안전하다고 확신할 수 있다면 @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;
      }
      System.arraycopy(elements, 0, a, 0, size);
      
      if (a.length > size) {
         a[size] = null;
      }
      return a;
   }
   
   public static void main(String[] args)
   {
   
   }
}

toArray 메서드는 ArrayList 에서 그대로 가져온 메서드인데 여기서는 경고를 제거할 수 없지만 타입이 안전하다고 확신할 수 있기 때문에 @SuppressWarnings 어노테이션을 붙여서 비검사 경고를 제거했다. 

 

❗ 근데 이때 타입 안전함을 검증하지 않은 채 경고를 숨기면 스스로에게 잘못된 보안 인식을 주는 꼴이다. 

어노테이션을 붙여서 경고를 숨기면 그 코드는 경고 없이 컴파일 되겠지만, 런타임에는 ClassCastException을 던질 수 있다. 

 

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

 

 

🚩 @SuppressWarnings 어노테이션은 항상 가능한한 좁은 범위에 적용해야 한다. 

변수 선언, 아주 짧은 메서드, 생성자 정도가 될 것인데 이 어노테이션을 클래스 전체에 적용하면 자칫 심각한 경고를 놓칠 수 있기 때문에 클래스 전체에 적용하면 안된다!! 

 

또한 @SuppressWarnings("unchekced") 어노테이션을 사용할 때면 그 경고를 무시해도 안전한 이유에 대해서 주석으로 남겨두면 좋다. 

다른 사람이 그 코드를 이해하는데 도움이 되고, 다른 사람이 그 코드를 잘못 수정하여 타입 안정성을 잃는 상황역시 줄어든다. 

 

 

 

 

📚 정리

비검사 경고는 중요하기 때문에 무시하면 안된다. 

모든 비검사 경고에는 런타임에 ClassCastException을 일으킬 수 있는 잠재적 가능성을 뜻하는 것이기 때문에 최선을 다해서 이 비검사 경고를 제거해야 한다. 

만약 제거하지 못하지만 안전하다면 그 코드가 타입 안전함을 증명하고, 가능한 한 범위를 좁혀서 @SuppressWarnings("unchecked") 애노테이션으로 경고를 숨기면 된다. 그리고 이 어노테이션을 사용한 이유에 대해서는 주석으로 남겨 다른 사람들이 코드를 보고 이해할 수 있도록 하면 된다!