아이템 49. 매개변수가 유효한지 검사하라

[yeGenieee]

아이템 49. 매개변수가 유효한지 검사하라

• 매개변수의 유효성 검사는 메서드 몸체가 시작되기 전에 이루어져야 한다
• 그리고, 이러한 매개변수에 대한 제약사항은 문서화가 필요하다

매개변수 검사를 제대로 하지 못하면 발생하는 문제

1. 메서드가 수행 중간에 모호한 예외를 던지며 실패할 수 있다
2. 메서드가 잘 수행되지만 잘못된 결과를 반환할 수 있다
3. 메서드는 문제 없이 수행되었지만, 미래의 알 수 없는 시점에 메서드와 관련 없는 오류를 낼 수 있다
   • 오류를 발생한 즉시 잡지 못하면, 해당 오류를 감지하기 어렵다

public과 protected 메서드는 예외를 문서화하자

• @throws javadoc 태그를 사용해 매개변수 값이 잘못되었을 때 던지는 예외를 문서화 하자
• 매개변수의 제약을 문서화한다면 그 제약을 어겼을 때 발생하는 예외도 함께 기술해야 한다

  /**
  * (현재 값 mod m) 값을 반환한다. 이 메서드는
  * 항상 음이 아닌 BigInteger를 반환한다는 점에서 remainder 메서드와 다르다.
  *
  * @param m 계수(양수여야 한다.)
  * @return 현재 값 mod m
  * @throws ArithmeticException m이 0보다 작거나 같으면 발생한다.
  */
  public BigInteger mod(BigInteger m) {
  if (m.signum() <= 0)
  throw new ArithmeticException("계수(m)은 양수여야 합니다. " + m);
  ... // 계산 
  }

• 이 메서드는 m이 null이면 m.signum() 호출 시 NullPointerException 을 던진다
• 그런데, m이 null일 때, NullPointerException 을 던진다는 말은 메서드 설명 어디에도 없다
• 그 이유는, 이 설명을 개별 메서드가 아닌 BigInteger 클래스 수준에서 기술했기 때문이다
• 클래스 수준 주석은 그 클래스의 모든 public 메서드에 적용되므로 훨씬 깔끔하다는 장점이 있다

Java 7에 추가된 java.util.Objects.requireNonNull 메서드

• null 검사를 수동으로 하지 않아도 되는 장점이 있다
• 원하는 예외 메시지도 지정할 수 있다
• 입력을 그대로 반환하므로 값을 사용하는 동시에 null 검사를 수행할 수 있다
• 반환값은 무시하고 null 검사를 수행할 수 있다

  this.strategy = Objects.requireNonNull(strategy, "전략");

공개되지 않은 (public 이 아닌) 메서드라면 단언문 (assert)을 사용하여 매개변수 유효성을 검증할 수 있다

• public이 아닌 메서드라면 assert를 사용하여 유효한 값만 메서드에 넘겨지리라는 것을 보증할 수 있다

  private static void sort(long a[], int offset, int length) {
  assert a != null;
  assert offset >= 0 && offset <= a.length;
  assert length >= 0 && length <= a.length - offset;
  ... // 계산 수행
  }

• assert문은 Java4부터 지원하며, 자신이 단언한 조건이 무조건 참이라고 선언한다
• 일반적인 유효성 검사와 다르게,
  1. 실행되는 문장이 true이면 그냥 지나가고, false이면 AssertionError를 던진다
  2. 런타임에 아무런 효과도 없고, 성능 저하도 없다

메서드가 직접 사용하지는 않는데, 나중에 사용하기 위해 저장하는 매개변수

// int 배열의 List 뷰를 반환하는 정적 팩터리 메서드
static List<Integer> intArrayAsList(int[] a){
    Objects.requireNonNull(a); // null 검사

    return new AbstractList<Integer>() {
        @Override
        public Integer get(int index) {
            return a[index]; // 0x124124 + index
        }

        @Override
        public int size() {
            return a.length;
        }
    };
}

• 위 메서드에서 Objects.requireNonNull 을 생략했다면, 클라이언트가 반환된 List를 사용하려할 때 NullPointerException 이 발생한다
• 이런 상환은 이 List를 어디서 가져왔는지 어려워서 디버깅이 힘들어진다

메서드 실행 전 매개변수 검사 예외의 경우

• 유효성 검사의 비용이 지나치게 높거나 실용적이지 않은 경우

[YunDaHyee]

public, protected는 예외를 문서화하고 private 매개변수의 유효성 검증에는 assert를 사용해봐야겠습니다.

[jioome]

공개되지 않은 매개변수 유효성 검증은 assert를 사용해야 하군요