Search

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

메서드 몸체가 실행되기 전에 매개변수를 확인한다면 잘못된 값이 넘어왔을 때 즉각적이고, 깔끔한 방식으로 예외를 던질 수 있다.”

 매개변수 검사를 제대로 하지 못하면 어떤 문제가 있을까?

메서드가 수행되는 중간에 모호한 예외를 던지며 실패할 수 있다.
메서드가 잘 수행되지만 잘못된 결과를 반환할 수 있다.
메서드는 문제없이 수행되었지만, 이상한 상태를 가진 객체로 만들어 미래의 알 수 없는 시점에 해당 메서드와 관련 없는 오류가 날 수 있다.
즉, 매개변수 검사에 실패하면 실패 원자성을 어기는 결과를 낳을 수 있다.
실패 원자성(failure atomicity)이란? 메서드 호출이 정상적으로 처리되지 못한 객체의 상태는 함수 호출 전 상태와 동일해야 한다. 위 속성을 만족하지 못하는 함수를 실패 원자성을 갖추었다고 한다.

 매개변수에 대해 문서화하기

 예외도 문서화하기

/** * * @param m 계수(양수여야함) * @return 현재 값 mod m * @throws ArithmeticException if m <= 0. */ public BigInteger mod(BigInteger m) { if (m.signum() <= 0) throw new ArithmeticException("계수(m)은 양수여야 합니다. " + m); ... // 계산 수행 }
Java
매개변수의 제약은 반드시 문서화해야 하며, 메서드 몸체가 시작되기 전에 검사해야 한다. ex) 매개 변수 A는 음수이면 안된다, null이 아니어야 한다. 등
public, protected 메서드는 매개변수 값이 잘못됐을 때 던지는 예외도 문서화해야 한다. (자바독 태그) ex) IllegalArgumentException, IndexOutOfBoundsException, NullPointerException

 애노테이션 활용?

@Nullable이나 이와 비슷한 애노테이션을 통해 특정 매개변수가 null이 될 수 있다고 알려줄 수 있다.
그러나 표준적인 방법은 아니다. (여러 어노테이션이 존재하여 추천하지 않음)
해당 메서드로 null 검사를 수동으로 하지 않아도 된다.
유연하고 사용하기 편하다.
예외 메시지를 지정할 수 있으며,
String name = null; name = Objects.requireNonNull(name, "이름을 입력해주세요.");
Java
기존 java.util.Objects에 범위 검사 기능이 추가되었다.
null 검사 메서드만큼 유연하지 않다.
예외 메시지를 지정할 수 없다.
리스트와 배열 전용으로 설계되었다.

 단언문(assert) : 공개되지 않은 메서드 매개변수 검증하기

공개되지 않은 메서드라면 호출되는 상황을 통제할 수 있다. 따라서 public이 아닌 메서드라면 단언문(assert)를 활용하여 매개변수 유효성을 검증할 수 있다.
단언문(assert)은 자신이 단언한 조건이 무조건 참이라고 선언한다는 의미로 사용한다.
유효성 검사에 실패하면 AssertionError를 던진다.
런타임에 아무런 효과도 성능 저하도 없다.

 핵심 정리

메서드는 최대한 범용적으로 설계하자.
그러나 매개변수 제약은 적을수록 좋다.
메서드나 생성자를 작성할 때
1.
매개변수들에 어떤 제약이 있을지부터 생각하자.
2.
제약들을 문서화하자.
3.
메서드 코드 시작 부분에서 명시적으로 검사하자.