Posts [이펙티브자바] 아이템27-비검사 경고를 제거하라
Post
Cancel

[이펙티브자바] 아이템27-비검사 경고를 제거하라

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

  • 모두 제거한다면 그 코드는 타입 안정성이 보장된다.
  • 즉, 런타임에 ClassCastException이 발생할 일이 없고, 개발자가 의도한 대로 잘 동작하리라 확신할 수 있다.

경고를 제거할 순 없지만 타입 안전하다고 확신할 수 있다면 @SupressWarnins(“unchecked”) 애너테이션을 달아 경고를 숨기자.

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

@SupressWarnins 애너테이션은 항상 가능한 좀은 범위에 적용하자.

  • 보통은 변수 선언, 아주 짧응ㄴ 메서드, 혹은 생성자가 될 것이다.
  • 절대로 클래스 전체에 적용해선 안된다.
  • 한 줄이 넘는 메서드나 생성자에 달린 @SuppressWarnins 애너테이션을 발견하면 지역변수 쪽으로 옮기자.
  • 이를 위해 지역수를 새로 선언하는 수고를 해야할 수도 있지만, 그만한 값어치가 있을 것이다.
1
2
3
4
5
6
7
8
public <T> T[] toArray(T[] a) {
        if (a.length < size)
            return (T[]) Arrays.copyOf(elementData, size, a.getClass());
        System.arraycopy(elementData, 0, a, 0, size);
        if (a.length > size)
            a[size] = null;
        return a;
}

ArrayList를 컴파일하면 이메서드에서 다음 경고가 발생한다.

1
2
3
ArrayList.java:305: warning: [unchecked] unchecked cast ...
required: T[]
found: Object[]

애너테이션은 선언에만 달 수 있기 때문에 return 문에는 @SupressWarnings를 다는게 불가능하다. 그 대신 반환값을 담을 지역변수를 하나 선언하고 그 변수에 애너테이션을 선언해주자.

1
2
3
4
5
6
7
8
9
10
11
// 깔끔하게 컴파일 + 비검사 경고를 숨기는 범위도 최소화
public <T> T[] to Array(T[] a){
  	if(a.length < size)
        @SupressWarnings("unchecked") // 지역션수로 추출후 @SupressWarnings 애노테이션 선언
        T[] result = (T[]) Arrays.copyOf(elements, 0, a, 0, size); 
        return result;
    System.arraycopy(elements, 0, a, 0, size);
    if (a.length > size)
  		a[size] = null;
    return a;
}

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

  • 다른 사람이 그 코드를 이해하는데 도움이 되며, 더 중요하게는 다른 사람이 그 코드를 잘못 수정하여 타입 안정성을 잃는 상황을 줄여준다.

핵심 정리: 비검사 경고는 중요하니 무시하지 말자. 모든 비검사 경고는 런타임에 ClassCastException을 일으킬 수 있는 잠재적 가능성을 뜻하니 최선을 다해 제거하라. 경고를 없앨 방법을 찾지 못하겠다면, 그 코드가 타입 안전함을 증명하고 가능한 한 범위를 좁혀 @SuppressWarnings("unchecked") 애너테이션으로 경고를 숨겨라. 그런 다음 경고를 숨기기로 한 근거를 주석으로 남겨라.

This post is licensed under CC BY 4.0 by the author.

[이펙티브자바] 아이템26-로 타입은 사용하지 말라

[이펙티브자바] 아이템28-배열보다는 리스트를 사용하라