독서찰기(讀書札記)/이펙티브 자바

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

NoodleMan 2022. 3. 11. 01:01

[Why]  

  • 메서드 몸체가 실행되기 전에 매개변수를 확인한다면 잘못된 값이 넘어왔을 때 즉각적이고 깔끔한 방식으로 예외를 던질 수 있다.
  • 매개변수 검사를 제대로 하지 못하면 실패 원자성(failure atomicity, 아이템76)을 어기는 결과를 낳을 수 있다.
    • 메서드가 수행되는 중간에 모호한 예외를 던지며 실패할 수 있다.
    • 더 나쁜 상황은, 메서드가 잘 수행되지만 잘못된 결과를 반환할 때다.
    • 이보다 더 나쁜 상황은, 메서드는 문제없이 수행됐지만 어떤 객체를 이상한 상태로 만들어놓아서 미래의 알 수 없는 시점에 이 메서드와는 관련 없는 오류를 낼 때다.

 

[When]

메서드가 직접 사용하지는 않으나 나중에 쓰기 위해 저장하는 매개변수는 특히 더 신경 써서 검사해야 한다.

  • 입력받은 int 배열의 List 뷰(view)를 반환하는 정적 팩터리 메서드를 생각해보자. (아이템20)
  • 만약 null 검사를 생략했다면 새로 생성한 List 인스턴스를 반환하는데, 클라이언트가 돌려받은 List를 사용하려 할 때 비로소 NullPointerException이 발생한다.
  • 이때가 되면 이 List를 어디서 가져왔는지 추적하기 어려워 디버깅이 상당히 괴로워질 수 있다.

생성자 매개변수의 유효성 검사는 클래스 불변식을 어기는 객체가 만들어지지 않게 하는 데 꼭 필요하다.

 

메서드 몸체 실행 전에 매개변수 유효성을 검사해야 한다는 규칙의 예외

  • 첫번째, 유효성 검사 비용이 지나치게 높거나 실용적이지 않을 때.
  • 두번째, 계산 과정에서 암묵적으로 검사가 수행될 때.
    e.g.) Collections.sort(List) : 정렬 과정에서 리스트 안의 객체들이 상호 비교될 수 있는지 확인이 이루어진다.
  • 계산 과정에서 필요한 유효성 검사가 이뤄지지만 실패했을 때 잘못된 예외를 던지기도 한다.
    • API 문서에서 던지기로 한 예외와 다르다면, 예외 번역(exception translate) 관용구를 사용하여 API 문서에 기재된 예외로 번역해줘야 한다. (아이템73)

 

[How]

public과 protected 메서드는 매개변수에 의한 예외를 문서화해야 한다. (@throws 자바독 태그를 사용하자. 아이템74)

  • 보통 IllegalArgumentException, IndexOutOfBoundsException, NullPointerException 중 하나일 것이다. (아이템72)
/**
 * (현재 값 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일때 NullPointerException을 던진다라는 말은 메서드 설명 어디에도 없다.
  • 그 이유는 이 설명을 BigInteger '클래스' 수준에서 기술했기 때문이다.

자바 7에 추가된 java.util.Objects.requireNonNull 메서드는 유연하고 사용하기도 편하니, 더 이상 null 검사를 수동으로 하지 않아도 된다.

  • this.strategy = Objects.requireNonNull(strategy, "전략");
  • 원하는 예외 메시지도 지정할 수 있다.
  • 또한 입력을 그대로 반환하므로 값을 사용하는 동시에 null 검사를 수행할 수 있다.
  • 반환값은 그냥 무시하고 필요한 곳 어디서든 순수한 null 검사 목적으로 사용해도 된다.

자바 9에서는 Objects에 범위 검사 기능도 더해졌다.

  • checkFromIndexSize, checkFromToIndex, checkIndex라는 메서드들인데, null 검사 메서드만큼 유연하지는 않다.
  • 예외 메시지를 지정할 수 없고, 리스트와 배열 전용으로 설계됐다.
  • 또한 닫힌 범위(closed range; 양 끝단 값을 포함하는)는 다루지 못한다.
  • 그래도 이런 제약이 없는 상황에서는 아주 유용하고 편리하다.

공개되지 않은 메서드라면 메서드가 호출되는 상황을 통제할 수 있다.

  • 오직 유효한 값만이 메서드에 넘겨지리라는 것을 보증할 수 있고, 그렇게 해야 한다.
  • 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;
    ... // 계산 수행
}
  • 단언문은 몇 가지 면에서 일반적인 유효성 검사와 다르다.
    • 첫 번째, 실패하면 AssertionError를 던진다.
    • 두 번째, 런타임에 아무런 효과도, 아무런 성능 저하도 없다.
      (단, java를 실행할 때 명령줄에서 -ea 혹은 --enableassertions 플래그를 설정하면 런타임에 영향을 준다)