ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • Item 27: Eliminate unchecked warnings
    독서/Effective Java 2022. 1. 2. 15:22

    비검사 경고를 제거하라

     

    제네릭을 사용하기 시작하면 비검사 형변환 경고, 비검사 메서드 호출 경고, 비검사 매개변수화 가변인수 타입 경고, 비검사 변환 경고 등 수많은 컴파일러 경고를 보게 되고, 새로 작성하게 되는 코드들이 꼭 한번에 깨끗하게 컴파일될 것이라는 보장은 없다.

    하지만, 대부분의 Unchecked warning은 쉽게 제거할 수 있다.

    <>를 붙이지 않았을 때의 경고 예(굉장히 친절하다)

    해결책은 다음과 같다.

    @Test
    void ListTest(){
      // Intellij 자동 완성도 이렇게 만들어준다.
      List<String> strings = new ArrayList<>();
    }

    할 수 있는 한 이러한 종류의 모든 비검사 경고를 제거하자.

    모두 제거한다면 그 코드는 타입 안정성이 보장된다.

    즉, 런타임에 ClassCastException이 발생하지 않고, 의도한 대로 코드가 동작한다는 걸 확신할 수 있다.

     

    도저히 제거할 수 없을 때의 방법: SuppressWarnings

    경고를 제거할 수 없지만 타입 안전하다고 확신한다면 @SuppressWarnings("unchecked") 애너테이션을 달아 경고를 숨기자. 안전하다고 검증된 비검사 경고를 그대로 두면, 진짜 문제를 알리는 새로운 경고가 나와도 눈치채지 못할 수 있다(해당 경고에 대해 둔감해지기 때문).

    @SuppressWarnings는 개별 지역변수 선언부터 클래스 전체까지 어떤 선언에도 달 수 있지만, 항상 가능한 한 좁은 범위에 적용하자. 자칫 심각한 경고를 놓칠 수 있으니 절대로 클래스 전체에 적용해서는 안 된다.

    또한, 한 줄이 넘는 메서드나 생성자에 달린 @SuppressWarnings을 발견하면 지역변수 선언 쪽으로 옮기자.

    // ArrayList에서의 toArray Method
    public <T> T[] toArray(T[] a) {
      if (a.length < this.size) {
        return Arrays.copyOf(this.elementData, this.size, a.getClass());
      } else {
        System.arraycopy(this.elementData, 0, a, 0, this.size);
        if (a.length > this.size) {
          a[this.size] = null;
        }
    
        return a;
      }
    }

    result라는 지역 변수를 선언하고 그 변수에 @SuppressWarnings("unchecked") 애너테이션을 달아준다. 해당 어노테이션을 사용할 때에는 그 경고를 무시해도 안전한 이유를 항상 주석으로 남겨야 한다.

    public <T> T[] toArray(T[] a) {
      if (a.length < this.size) {
        // 생성한 배열과 매개변수로 받은 배열의 타입이 모두 T[]으로 같기에 올바른 형변환
        @SuppressWarnings("unchecked") T[] result = Arrays.copyOf(this.elementData, this.size, a.getClass());
        return result;
      } else {
        System.arraycopy(this.elementData, 0, a, 0, this.size);
        if (a.length > this.size) {
          a[this.size] = null;
        }
    
        return a;
      }
    }

     

    정리

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

    경고를 없앨 방법이 도저히 없다면 해당 코드가 타입 안전함을 증명하고 가능한 범위를 좁혀 @SuppressWarnings("unchecked") 애너테이션으로 경고를 숨긴 후 주석으로 해당 어노테이션에 대한 근거를 남기자.

    댓글

Designed by Tistory.