[Java] 자바 예외 전략

출처

https://www.theserverside.com/blog/Coffee-Talk-Java-News-Stories-and-Opinions/Java-Exception-handling-best-practices

Java Exception handling best practices

 

https://stackify.com/best-practices-exceptions-java/

9 Best Practices to Handle Java Exceptions - Stackify

 

 

이런 것들을 주의해야 하는구나.. 하는 것들을 출처들어서 정리함.

---

 

1. Be careful what you log. 로그하는 기록물에 주의하라.

보안을 어기지 않는 범위에서 로그를 기록해라. 안그럼 해고된다.

 

2. Don’t bury thrown exceptions. 발생한 예외를 묻어두지 말아라 / Don’t Ignore Exceptions 예외를 무시하지 마라

예외 발생 시 아무 것도 안하는 것을 burying an exception(예외 묻기)라고 한다. 예외를 묻으면 애플리케이션 문제 해결이 어려워진다. 

catch 블록에서 에러를 처리하거나 로그를 남기지 않는 것은 예외를 무시하는 것이다. 이건 예외가 발하지 않을 것이란 생각으로 개발자가 작성했을 가능성이 크다.

 

코드가 앞으로 어떻게 바뀔지 알 수 없기 때문에, 문제가 발생한다는 사실을 인지하지 못한채로 누군가가 예외 이벤트를 방지하는 유효성 검사를 제거할 수도 있거나, 예외를 발생시키는 코드가 변경되면 모든 예외를 catch하지 못할 수도 있다.

최소한으로 상상할 수 없는 일이 발생했을 때에 누군가가 이를 확인해야 한다는 것을 모든 사람에게 알리는 로그 메시지를 작성해야 한다. 그렇게 하면 당신이나 다른 사람들은 로그를 통해 예외 상황에 대한 정보를 추출할 수 있다.

public void logAnException() {
	try {
		// do something
	} catch (NumberFormatException e) {
		log.error("This should never happen: " + e);
	}
}

 

 

3. Use a global Exception handler. 전역 예외 처리를 사용해라.

런타임 예외를 처리할 전역 예외 처리(handler)를 사용해라. 

이렇게 하면 예외를 기록하고 잠재적으로 예외를 처리할 수 있고, 예외 발생 시 앱이 중단되는 것을 막는다.

 

4. Don’t close resources manually. 수동으로 리소스를 close 하지 마라.

try-with-resources, try-catch를 사용하라. JVM이 알아서 완벽하게 리소스를 닫도록 해라.

 

5. Throw early and handle exceptions late. 예외는 빨리 throw하고 처리는 늦게 하라.

예외가 발생하는 순간에 예외를 throw 하라.

예외를 catch하는 함수는 메소드의 끝부분에 있어야 한다. 이렇게 하면 더 적은 수의 catch 블록을 추가하고 코드의 가독성 및 유지보수를 쉽게 한다. 

 

6. Don’t log and rethrow Java exceptions.

예외 발생 시

1)  예외를 로그로 남기고 애플리케이션을 계속 진행하던가

2) 예외를 다시 throw해서 다른 메소드가 세부사항을 로그로 남기게 끔 하라

둘 중에 하나만 해야 한다.

둘 다 같이 해서는 안된다. 그럼 코드가 중복되고 문제가 발생하는 코드를 찾기 어렵다.

 

7. Check for suppressed exceptions. suppressed(억제된) 예외를 확인해라.

suppressed(억제된) 예외를 확인해라. 

try-with-resource 기능이 도입되면서 동시에 두 가지 예외를 발생시키는 것이 가능해졌다. 

 

예제

try ( Door door = new Door() ) {
  door.swing(); /* Throws the SwingException */
}
catch (Exception e) {
  System.out.println("Primary Exception:  " + e.getClass());
  if (e.getSuppressed().length > 0) {
    System.out.print("Suppressed Exception: " + e.getSuppressed()[0]);
  }
}

 

 

8. Explicitly define exception in the throws clause. throws 구문의 예외를 명시적으로 정의하라

throws 구문에서 구체적, 명시적으로 예외를 기입해서, 개발자들이 특정 메서드가 제대로 실행되지 않을 경우 사용할 수 있는 다양한 오류 처리 루틴을 알 수 있게 해라.

 

9. Catch the most explicit exception first. 명시적인 예외를 먼저 catch 해라

구체적인 예외를 먼저 catch 하고 덜 구체적인 예외 순으로 catch 해라. 이 규칙을 따르지 않으면 JVM은 이해하기 어려워한다. 

 

10.Use modern exception handling techniques

Java에서 예외 처리 관련한 많은 기능들이 추가되어 왔다. 단일 catch 블록에서 여러 예외를 catch 하는 기능, try-with-resource 블록으로 리소스를 자동으로 close하는 기능 등을 사용해라.

 

11.Document the Exceptions You Specify. 예외를 명시할 경우(throws 구문 쓸 경우) 문서를 남겨라.

 메소드 시그니처에 예외를 명시할 경우(throws 구문 쓸 경우) Javadoc을 이용해 문서를 남겨라.

 

예제

/**
* This method does something extremely useful ...
*
* @param input
* @throws MyBusinessException if ... happens
*/
public void doSomething(String input) throws MyBusinessException { ... }

 

12.Throw Exceptions With Descriptive Messages 설명하는 메시지와 함께 예외를 던져라.

예외가 발생된 문제를 이해하도록 돕는 정확한 설명을 제공해야 한다. 1-2줄로짧게 쓰면 된다. 운영 시 문제의 심각도를 이해하고 더 쉽게 분석할 수 있다. 

특정 예외가 발생하면 클래스 이름이 오류 종류를 설명할 가능성이 높기 때문에 많은 추가 정보를 제공할 필요는 없다. 

 

13.Don’t Catch Throwable Throwable을 catch하지 마라.

Throwable은 모든 예외와 에러의 슈퍼클래스이다. catch 구문에서 사용 가능은 하지만, 사용하지 마라.

catch 절에 throwable을 사용하면 모든 예외 뿐만이 아니라 에러도 catch한다. 

에러는 애플리케이션에서 처리할 수 없는 오류로 JVM이 발생시킨다. OutOfMemoryError, StackOverflowError가 있다. 이것들은 애플리케이션의 제어 범위를 벗어나서 처리할 수 없다.

따라서 에러를 처리할 수 있거나 처리해야 하는 예외적인 상황에 처해 있다는 확신이 없다면 Throwable을 잡지 않는 것이 좋다.