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

문법식·2022년 10월 11일
0

Effective Java 3/E

목록 보기
49/52

메서드와 생성자 대부분은 입력 매개변수의 값이 특정 조건을 만족하기를 바란다. 예를 들어 인덱스 값은 음수이면 안 되며, 객체 참조는 null이 아니어야 하는 식이다. 이런 제약은 반드시 문서화해야 하며 메서드 몸체가 시작되기 전에 검사해야 한다. 이는 오류는 가능한 빨리 (발생한 곳에서) 잡아야 한다는 일반 원칙의 한 사례이기도 하다. 오류를 발생한 즉시 잡지 못하면 해당 오류를 감지하기 어려워지고, 감지하더라도 오류의 발생 지점을 찾기 어려워진다.
메서드 몸체가 실행되기 전에 매개변수를 확인한다면 잘못된 값이 넘어왔을 때 즉각적이고 깔끔한 방식으로 예외를 던질 수 있다. 매개변수 검사를 제대로 하지 못하면 몇 가지 문제가 생길 수 있다. 첫 번째, 메서드가 수행되는 중간에 모호한 예외를 던지며 실패할 수 있다. 두 번째, 더 나쁜 상황은 메서드가 잘 수행되지만 잘못된 결과를 반환할 때다. 세 번째, 한층 더 나쁜 상황은 메서드는 문제없이 수행됐지만, 어떤 객체를 이상한 상태로 만들어놓아서 미래의 알 수 없는 시점에 이메서드와는 관련 없는 오류를 낼 때다.

publicprotected 메서드는 매개변수 값이 잘못됐을 때 던지는 예외를 문서화해야 한다. 매개변수의 제약을 문서화한다면 그 제약을 어겼을 때 발생하는 예외도 함께 기술해야 한다.
자바의 null 검사 시 java.util.objects.requireNonNull 메서드를 사용하면 좋다. 이 메서드는 유연하고 사용하기 편하기 때문이다.

공개되지 않은 메서드라면 패키지 제작자인 우리들이 메서드가 호출되는 상황을 통제할 수 있다. 따라서 오직 유효한 값만이 메서등 ㅔ넘겨지리라는 것을 우리들이 보증할 수 있고 그렇게 해야 한다. public이 아닌 메서드라면 단언문(assert)을 사용해 매개변수 유효성을 검증할 수 있다. 핵심은 단언문들은 자신이 단언한 조건이 무조건 참이라고 선언한다는 것이다. 단언문은 몇 가지 측면에서 일반적인 유효성 검사와 다르다. 첫 번째, 실패하면 AssertionError를 던진다. 두 번째, 런타임에 아무런 효과도, 아무런 성능 저하도 없다.

메서드가 직접 사용하지는 않으나 나중에 쓰기 위해 저장하는 매개변수는 특히 더 신경 써서 검사해야 한다. 그렇지 않으면 오류가 발생한 지점을 찾기 어려워진다.

메서드 몸체 실행 전에 매개변수 유효성을 검사해야 한다는 규칙에도 예외는 있다. 유효성 검사 비용이 지나치게 높거나 실용적이지 않을 때, 혹은 계산 과정에서 암묵적으로 검사가 수행될 때다. 예를 들어 정렬을 생각해보면 리스트 안의 객체들은 모두 상호 비교될 수 있어야 한다. 만약 상호 비교할 수 없는 타입의 객체가 들어있다면 그 객체와 비교할 때 ClassCastException을 던진다. 따라서 비교하기 전에 리스트 안의 모든 객체가 상호 비교될 수 있는지 검사해보야 별다른 이익이 없다.

계산 중 잘못된 매개변수 값을 사용해 발생한 예외와 API 문서에 던지기로 한 예외가 다를 수도 있다. 이런 경우에는 예외 번역 관용구를 사용하여 API 문서에 기재된 예외로 번역해줘야 한다.

profile
백엔드

0개의 댓글