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

EFFECTIVE JAVA(이펙티브 자바)

 

이 포스팅에서 작성하는 내용은 EFFECTIVE JAVA(이펙티브자바) 에서 발췌하였습니다.

---

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

 

메서드와 매개변수

• 메서드와 생성자 대부분은 입력 매개변수의 값이 특정 조건을 만족해야 한다. ex) 인덱스 값은 음수가 아니어야 하며, 객체 참조는 null이 아니어야 한다 등등
• 이러한 제약은 반드시 문서화를 해야 하며 메서드 몸체가 시작되기 전에 검사해야한다.
• 메서드 몸체가 실행되기 전에 매개변수를 확인한다면 잘못된 값이 넘어왔을 때 즉각적으로 예외 처리를 할 수 있다.
• 매개변수 검사를 제대로 못했을 때의 문제점
  • 메서드가 수행되는 중간에 모호한 예외를 던져 원인을 찾는 데 헤맬 수 있다.
  • 메서드가 잘 수행되지만 잘못된 결과를 반환할 수 있다.
• public 과 protected 메서드는 매개변수 값이 잘못됐을 때 던지는 예외를 문서화해야 한다.
• 매개변수의 제약을 문서화한다면 그 제약을 어겼을 때 발생하는 예외도 함께 기술해야한다.

 

 

ex 1) 매개변수의 제약을 문서화한 전형적인 예

/**
 * (현재 값 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);
    }
    ...
}

• 위와 같이 문서화를 해두면 좋다.
• 참고로, 자바 7에 추가된 java.util.requireNonNull 메서드는 유연하고 사용하기도 편하니, 더 이상 null 검사를 수동으로 하지 않아도 된다.

this.strategy = Objects.requireNonNull(strategy, "strategy is Null!");

• 위의 코드에서 strategy가 null 일경우, “strategy is Null!”이라는 예외를 발생시킨다.

 

 

공개되지 않은 메서드의 경우

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

따라서, 오직 유효한 값만이 메서드에 넘겨지리라는 것을 제작자가 보증해야 한다.

 

 

ex2) 재귀 정렬용 private 도우미 함수

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;
    ... //계산 수행
}

• 이처럼 public이 아닌 메서드라면 assert(단언문)을 사용해 매개변수 유효성을 검증할 수 있다.
• 단언문은 몇 가지 면에서 일반적인 유효성 검사와 다르다.
  • 이 단언문들은 자신이 단언한 조건이 무조건 참이라고 선언한다는 것
  • 실패하면 AssertError를 던진다.
  • 런타임에 아무런 효과도, 아무런 성능 저하도 없다.

 

유의점

• 메서드 몸체 실행 전에 매개변수 유효성을 검사해야한다는 규칙에도 예외가 있다.
• 유효성 검사 비용이 지나치게 높거나 실용적이지 않을 때, 혹은 계산과정에서 암묵적으로 검사가 수행될 때이다.

 

 

정리

• 메서드나 생성자를 작성할 때면 그 매개변수들에 어떤 제약이 있을 지 생각하자
• 그 제약들을 문서화하고 메서드 몸체 실행 전에 명시적으로 검사하자.
• 만약, 몸체 실행 전에 검사를 하지 않아 오류가 발생한다면 에러 추적이 어려울 수도 있다.