item 75 SeungminLee - JAVA-JIKIMI/EFFECTIVE-JAVA3 GitHub Wiki

Effective Java 3e item 75 예외의 상세 메시지에 실패 관련 정보를 담으라를 요약한 내용입니다.

예외를 잡지 못해 프로그램이 실패하면 자바 시스템은 그 예외의 스택추적Stack Trace 정보를 자동으로 출력한다. 스택추적은 예외 객체의 toString 메서드를 호출해 얻는 문자열로 예외의 클래스 이름 뒤에 상세 메시지가 붙는 형태이다. 이 정보가 실패원인을 분석해야 하는 프로그래머가 얻을 수 있는 유일한 정보인 경우가 많다. 따라서 예외의 toString 메서드에 실패 원인에 대한 정보를 가능한 많이 담아 반호나하는 일은 아주 중요하다. 달리 말하면, 사후 분석을 위해 실패 순간의 상황을 정확히 포착해 예외의 상세 메시지에 담아야 한다.

1. 예를 들어 IndexOuOfBoundsException의 상세 메시지는 범위의 최솟값과 최댓값, 그리고 범위를 벗어났다는 인덱스 값 등의 추가 정보를 담아야 한다. 이들은 모두 다른 예외 상황들의 원인이 되므로, 추가 정보를 제공하면 무엇을 고쳐야 할지 분석하는데 큰 도움이 된다.

보안과 관련한 정보는 주의해서 다뤄야 하기 때문에 스택 추적의 상세 메시지에 비밀번호나 암호 키 같은 정보까지 담아서는 안된다.

2. 관련 데이터를 모두 담아야 하지만 장황할 필요 없다. 문제를 분석하는 사람은 스택 추적뿐 아니라 관련 문서와 소스코드를 함께 살펴보기 때문이다.

스택 추적에는 예외가 발생한 메서드들의 파일 이름과 줄번호까지 정확히 기록되어 있다.

3. 예외의 상세 메시지와 최종 사용자에세 보여줄 오류 메시지를 혼동해서는 안된다.

최종 사용자에게는 친절한 안내 메시지는 보여줘야 하는 반면, 예외 메시지는 가독성보다는 담긴 내용이 훨씬 중요하다.

예외 메시지의 주 소비층은 문제를 분석할 프로그래머이기 때문이다.

또한 최종 사용자용 메시지는 현지어로 번역해주기도 하지만, 예외 메시지는 그런 일이 거의 없다.

4. 실패를 적절히 포착하려면 필요한 정보를 예외 생성자에서 모두 받아서 상세 메시지까지 미리 생성해 놓는 방법도 괜찮다.

    /**
         * IndexOutOfBoundsException을 생성한다
         * @param lowerBound 인덱스의 최솟값
         * @param upperBound 인덱스의 최댓값 + 1
         * @param index 인덱스의 실젯값
         */
       public IndexOutOfBoundsException(int lowerBound, int upperBound, int index){
            // 실패를 포착하는 상세 메시지를 생성한다.
           super(String.format("최솟값: %d , 최댓값: %d, 인덱스: %d", lowerBound, upperBound, index));
           
           // 프로그램에서 이용할 수 있도록 실패 정보를 저장해둔다.
           this.lowerBound = lowerBound;
           this.upperBound = upperBound;
           this.index = index;
    }
 

Java9 에서는 IndexOutOfBoundsException에 드디어 정수 인덱스 값을 받는 생성자가 추가되었다. 하지만 아쉽게도 최솟값과 최댓값까지 받지는 않는다. 자바 라이브러리는 이 조언을 적극 수용하지는 않지만 나는 강력히 권장하는 바이다. 이렇게 해두면 프로그래머가 던지는 예외는 자연스럽게 실패를 더 잘 포착한다.

또한 고품질의 상세 메시지를 만들어내는 코드를 예외 클래스 안으로 모아주는 효과도 있어, 클래스 사용자가 메시지를 만드는 작업을 중복하지 않아도 된다.

예외는 실패와 관련한 정보를 얻을 수 있는 접근자 메서드를 적절히 제공하는 것이 좋다. 포착한 실패정보는 예외 상황을 복구하는데 유용할 수 있으므로 접근자 메서드는 비검사 예외보다는 검사 예외에서 더 빛을 발한다. 비검사 예외의 상세정보에 프로그램적으로 접근하길 원하는 프로그래머는 드물겠지만 toString이 반환하는 값에 포함된 정보를 얻어올 수 있는 API를 제공하자는 일반 원칙에 따른다는 관점에서, 비검사 예외라도 상세 정보를 알려주는 접근자 메서드를 제공하라고 권하고 싶다.