[Clean Code] 7장, 오류 처리

 

클린코드,  애자일 소프트웨어 장인정신

Robert C. Martin

 

 

들어가며

• 깨끗한 코드와 오류 처리는 확실히 연관성이 있다.
• 상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다.
• 이 장에서는 깨끗하고 튼튼한 코드에 한걸음 더 다가가는 단계로 우아하고 고상하게 오류를 처리하는 기법과 고려 사항 몇 가지를 소개한다.

 

 

오류 코드보다 예외를 사용하라

• 이전에는 오류 플래그를 설정하거나 호출자에게 오류 코드를 반환하는 방법이 전부였다.
  → 함수를 호출한 즉시 오류를 확인해야 하기 때문에 호출자 코드가 복잡해짐
• 오류가 발생하면 예외를 던지는 편이 좋다.
  → 논리가 오류 코드와 섞이지 않기 때문에 호출자 코드가 더 깔끔해짐

 

 

Try-Catch-Finally문 부터 작성하라

• try 블록에 들어가는 코드를 실행하면 어느 시점에서든 실행이 중단된 후 catch 블록으로 넘어갈 수 있다.
• try 블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다.
• try-catch 구조로 범위를 정의했으므로 TDD를 사용해 필요한 나머지 논리를 추가한다.
• 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하자
• 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.

 

 

미확인 unchecked 예외를 사용하라

• 확인된 예외는 OCP를 위반한다.
• 메서드에서 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면,
  그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 한다.
  하위 단계에서 코드를 변경하면 상위 단계 메서드를 전부 고쳐야 한다. → 모듈도 다시 빌드하여 배포해야 한다.
• 대규모 시스템에서 함수 호출 시 최하위 함수를 변경해 새로운 오류를 던질때,
  확인된 오류를 던진다면 함수는 선언부에 throws 절을 추가해야 한다.
  → 최하위 단계에서 최상위 단계까지 연쇄적인 수정이 일어난다.
      throws 경로에 위치하는 모든 함수가 최하위 함수에서 던지는 예외를 알아야 하므로 캡슐화가 깨진다.
• 때로는 확인된 예외도 유용하다. 중요한 라이브러리를 작성한다면 모든 예외를 잡아야한다.
• 하지만 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.

 

확인된 예외 checked exception

• Error나 RuntimeException 을 제외한 나머지 예외
• 컴파일시 확인 🙆‍♀️
• 예외 처리를 구현하지 않으면 컴파일 에러 발생
• 코드가 잘못된 것이 아니라 잘못된 상황에서 발생

 

미확인 예외 unchecked exception

• Error나 RuntimeException
• 컴파일 시 확인 🙅‍♀️
• 적절한 예외 처리가 없을 경우 프로그램이 강제 종료한다.

 

 

예외에 의미를 제공하라

• 예외를 던질 때는 전후 상황을 충분히 덧붙인다. → 오류가 발생한 원인과 위치를 찾기도 쉬워진다.
• 오류 메시지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름과 실패 유형도 언급한다.
• 애플리케이션이 로깅 기능을 사용한다면 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨준다.

 

 

호출자를 고려해 예외 클래스를 정의하라

• 애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법
• 대다수 상황에서 우리가 오류를 처리하는 방식
  1) 오류를 기록한다.
  2) 프로그램을 계속 수행해도 좋은지 확인한다.
  → 호출하는 라이브러리 API를 감싸면서 예외 유형 하나를 반환하자.
• 예외 클래스가 하나만 있어도 충분한 코드가 많다.
  ex. 예외 클래스에 포함된 정보로 오류를 구분해도 괜찮은 경우

외부를 잡아 변환하는 감싸기wrapper 클래스가 좋은점

1. 외부 API 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 줄어든다.

   → 나중에 다른 라이브러리로 갈아타도 비용이 적다. 

2. 특정 업체가 API를 설계한 방식에 발목 잡히지 않는다.

   → 프로그램이 사용하기 편리한 API를 정의하면 그만 

 

 

정상 흐름을 정의하라

• 때로는 중단이 적합하지 않을 때도 있다.
• 이럴땐 특수 사례 패턴을 사용하자.

특수 사례 패턴 SPECIAL CASE PATTERN

클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식 → 클래스나 객체가 예외 상황을 캡슐화해서 처리

클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다.

 

비용 청구 애플리케이션에서 총계를 계산하는 코드

• 식비를 비용으로 청구하면 직원이 청구한 식비를 총계에 더한다.
• 식비를 비용으로 청구하지 않으면 일일 기본 식비를 총계에 더한다.
• 예외가 논리를 따라가기 어렵다.

try {
	MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
    m_total += expense.getTotal();
} catch (MealExpensesNotFound e){
	m_total += getMealPerDiem();
}

 

• ExcpenseReportDAO를 고쳐 언제나 MealExpense 객체를 반환한다.
• 청구한 식비가 없다면 일일 기본 식비를 반환하는 MealExcpense 객체를 반환한다.
• 코드가 간결해진다.

MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
m_total += expenses.getTotal();

public class PerDiemMealExpenses implements MealExpenses{
	public int getTotal(){
    	// 기본값으로 일일 기본 식비를 반환
    }
}

 

 

null을 반환하지 마라

• null을 반환하는 습관 때문에 오류를 유발할 수도 있다.
• null을 반환하는 코드는 일거리를 늘리고 호출자에게 문제를 떠넘긴다.
• 메서드에서 null을 반환하고픈 유혹이 들 땐, 예외를 던지거나 특수 사례 객체를 반환하자.
• 사용하려는 외부 API가 null을 반환 한다면, 감싸기 메서드를 구현해 예외를 던지거나 특수 사례 객체를 반환하는 방식을 고려하자.

List<Employee> employees = getEmployees();
if (employees != null){
	for(Employee e : employees) {
    	totalPay += e.getPay();
    }
}

• getEmployees는 null도 반환한다. 그러나 반드시 null을 반환할 필요가 없다.
• getEmployees를 변경해 빈 리스트를 반환한다면 코드가 훨씬 깔끔해진다.

List<Employee> employees = getEmployees();
for(Employee e : employees){
	totalPay += e.getPay();
}

• 자바에는 Collections.emptyList() 가 있어 미리 정의된 읽기 전용 리스트를 반환한다.
  → 코드가 깔끔해지고 NullPointerException이 발생할 가능성도 줄어든다.

public List<Employee> getEmployees(){
	if(... 직원이 없다면.. ){
    	return Collections.emptyList();
    }
}

 

 

null을 전달하지 마라

• 정상적인 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드는 최대한 피한다.
• 대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다.
• 그렇다면 애초에 null을 넘기지 못하도록 금지하는 정책이 합리적이다.

 

결론

• 깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다.
• 오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다.
• 오류 처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지며 코드 유지보수성도 크게 높아진다.