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

[item75] 예외의 상세 메시지에 실패 관련 정보를 담으라

스택 추적(stack strace)

• 예외를 잡지 못해 프로그램이 실패하면 자바 시스템은 그 예외의 스택 추적(stack trace) 정보를 자동으로 출력
• 스택 추적은 예외 객체의 toString 메서드를 호출해 얻는 문자열로, 예외의 클래스 이름 뒤에 상세 메시지가 붙는 형태
  • toString 메서드에 실패 원인에 대한 정보를 최대한 담는 것이 중요(실패 순간의 상황을 정확히 포착)

실패 메시지 작성 방법 및 주의 사항

• 발생한 예외에 관여된 모든 매개변수와 필드의 값을 실패 메시지에 담아야 한다. 어떤 부분에서 문제가 발생했는지를 알 수 있다.
  • IndexOutOfBoundsException의 상세 메시지는 범위의 최솟값과 최댓값, 그리고 범위를 벗어났다는 인덱스 값을 담아야 한다.
• 스택 추정 정보는 많은 사람이 볼 수 있어, 상세 메시지에 보안 관련 정보(E.g 비밀번호, 암호 키)를 담아서는 안 된다.
• 문서와 소스코드에 대한 정보는 넣지 않는 게 좋다.
  • 스택 추적에는 예외 발생한 파일 이름과 줄번호, 스택에서 호출한 다른 메서드들의 파일 이름과 줄번호까지 정확히 기록되어 있다.
• 최종 사용자에게는 친절한 안내 메시지를 보여주는 반면, 예외 메시지는 가독성보단 담긴 내용이 훨씬 중요하다.
• 필요한 정보를 예외 생성자에서 모두 받아 상세 메시지까지 미리 생성해놓는 방법도 좋다.

  // 기존 코드
  public class IndexOutOfBoundsException extends RuntimeException {
    private static final long serialVersionUID = 234122996006267687L;
  
    public IndexOutOfBoundsException() {
    }
  
    public IndexOutOfBoundsException(String s) {
      super(s);
    }
  
    // Since Java9
    public IndexOutOfBoundsException(int index) {
      super("Index out of range: " + index);
    }
  }
  
  // 작가에 의해 수정된 코드
  public class IndexOutOfBoundsException extends RuntimeException {
  
    private final int lowerBound;
    private final int upperBound;
    private final int index;
  
    /**
     * 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;
    }
  }
  

• 예외는 실패와 관련된 정보를 얻을 수 있는 접근자 메서드를 제공하는 것이 좋다(E.g. lowerBound, upperBound, index).
  • 포착한 실패 정보는 예외 상황 복구에 유용하여 특히 검사 예외에서 빛을 발한다.