[Clean Code(클린 코드)] 7장 오류 처리

 

본 게시글은 <Clean Code>를 학습한 내용을 정리한 글입니다. (문제시 삭제하겠습니다.)

 

Clean Code(클린 코드) - 교보문고

 

깨끗한 코드와 오류 처리는 확실히 연관성이 있다. 여기저기 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기가 거의 불가능해질 수도 있다. 오류 처리 코드로 인해 프로그램 논리를 이해하기 어려워진다면 깨끗한 코드라 부르기 어렵다.

예외란? → 입력 값에 대한 처리가 불가능하거나, 프로그램 실행 중에 참조된 값이 잘못된 경우 등 정상적인 프로그램의 흐름에 어긋나는 것.

에러란? → 시스템에 무엇인가 비정상적인 상황이 발생한 경우에 사용됨. (예외와 받내로 애플리케이션 코드에서 잡으려고 하면 안됨)

 

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

예외를 지원하지 않는 언어는 오류를 처리하고 보고하는 방법이 제한적이었다. 오류 플래그를 설정하거나 호출자에게 오류 코드를 반환하는 방법이 전부였다.

이러한 방법을 사용하면 호출자 코드가 복잡해진다. 함수를 호출한 즉시 오류를 확인해야하기 때문이다. (이 마저도 쉽게 잊어버리기 쉬움)

오류가 발생하면 예외를 던지는 편이 낫다. 그러면 호출자 코드가 더 깔끔해진다. 논리가 오류 처리 코드와 뒤섞이지 않으니까. 각 개념을 독립적으로 살펴보고 이해할 수 있다.

 

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

try-catch-finally 문에서 try 블록에 들어가는 코드를 실행하면 어느 시점에서든 실행이 중단된 후 catch 블록으로 넘어갈 수 있다.

어떤 면에서는 try 블록은 트랜잭션과 비슷하기 때문에 예외가 발생할 코드를 짤 때는 try-catch-finally 문으로 시작하는 편이 낫다. 그러면 try 블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다.

 

미확인(unchecked) 예외를 사용하라

Checked Exception는 간단하게 RuntimeException을 상속하지 않는 클래스를 의미하고, Unchecekd Exception은 상속한 클래스를 의미한다. 자바에서는 RuntimeException과 이를 상속한 클래스는 명시적으로 예외 처리를 하지 않아도 된다.

(참고 : https://madplay.github.io/post/java-checked-unchecked-exceptions)

 

이전에는 Checked와 UnChecked Exception에 대한 논쟁이 있었으나 지금은 Checked Exception이 반드시 필요하지 않다는 사실이 분명해졌다. (C#, C++, 파이썬, 루비 등 다양한 언어에서 확인된 예외를 지원하고 있지만 안정적인 소프트웨어를 구현하기에 무리가 없다.)

확인된 오류가 치르는 비용에 상응하는 이익을 제공하는지 따져봐야 한다.

→ 확인된 예외는 OCP(Open Closed Principle)를 위반한다. 메서드에서 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 한다. 즉, 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 한다는 말이다. 결과적으로 최하위 단계에서 최상위 단계까지 연쇄적인 수정이 일어난다.

때로는 확인되 예외도 유용하지만 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.

 

예외에 의미를 제공하라

예외를 던질 때는 전후 상황을 충분히 덧붙인다. 그러면 오류가 발생한 원인과 위치를 찾기가 쉬워진다.

자바는 모든 예외에 호출 스택을 제공하지만 실패한 코드의 의도를 파악하기에는 부족하다.

오류 메시지에 정보(실패한 연산 이름, 실패한 유형 등)를 담아 예외와 함께 던지는 등 디버깅을 위해 충분한 정보를 제공한다.

 

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

오류를 분류하는 방법은 수없이 많다. 오류가 발생한 위치, 유형으로 분류가 가능하다. 하지만 애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.

예를 들어, 외부 라이브러리를 호출하는 try-catch-finally 문을 포함하는 코드를 작성할 때 외부 라이브러리가 던질 예외를 모두 catch문으로 잡아낸다면 코드 중복이 심해질 것이다.

→ 감싸기(wrapper) 기법을 사용하면 호출하는 라이브러리 API를 예외 유형 하나만을 반환하도록 코드를 간결하게 바꿀 수 있다.

감싸기 기법을 사용하면 외부 API를 감싸서 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 테스트도 수월해진다. 또한 특정 업체가 API를 설계한 방식에 발목 잡히지 않는다.

 

정상 흐름을 정의하라

앞 절에서 충고한 지침을 충실히 따른다면 비즈니스 논리와 오류 처리가 잘 분리된 코드가 나온다. 외부 API를 감싸 독자적인 예외를 던지고, 코드 위에 처리기를 정의해 중단된 계산을 처리한다. 하지만 때로는 중단이 적합하지 않은 때도 있다.

다음은 비용 청구 애플리케이션에서 총계를 계산하는 허술한 코드다.

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

식비를 비용으로 청구했다면 직원이 청구한 식비를 총계에 더한다. 식비를 비용으로 청구하지 않았다면 일일 기본 식비를 총계에 더한다. 예외가 논리를 따라가기 어렵게 만든다. 특수한 상황을 처리할 필요가 없다면 더 좋지 않을까?

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

----------------

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

ExpenseReportDAO를 고쳐 언제나 MealExpense 객체를 반환한다. 청구한 식비가 없다면 일일 기본 식비를 반환하는 MealExpense 객체를 반환한다.

이를 특수 사례 패턴(Special Case Pattern)이라 부른다. 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식으로, 예외적인 상황을 처리할 필요가 없어진다.

 

null을 반환하지 마라

우리가 흔히 저지르는 바람에 오류를 유발하는 행위 중 하나가 null을 반환하는 습관이다. null을 확인하는 코드로 가득한 코드는 나쁜 코드다! null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다. 누구 하나라도 null을 빼먹는다면 애플이케이션이 통제 불능에 빠질 것이다. null로 인해 발생할 NullPointerException을 어떻게 처리할까?

메서드에 null을 반환하고 싶은 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환한다.

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

위에서 getEmployees()는 null도 반환한다. 하지만 반드시 null을 반환할 필요는 없어 보인다.

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

------------------

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

위와 같이 getEmployees()를 변경해 빈 리스트를 반환한다면 코드가 훨씬 깔끔해질 뿐더러 NullPointerException이 발생할 가능성도 줄어든다.

 

null을 전달하지 마라

메서드로 null을 전달하는 방식은 더 나쁘다. 정상적인 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드는 최대한 피한다.

null을 체크하지 않는 메서드의 인수로 null을 전달한다면 당연히 NullPointerException이 발생한다. 어떻게 고치면 좋을까?

새로운 예외 유형을 만들어 던지는 방법 → NullPointerException보다는 조금 나을 수는 있지만 이를 잡아내는 처리기가 따로 필요해진다.

assert 문을 사용하는 방법 → 문서화가 잘 되어 코드 읽기는 편하지만, 누군가 Null을 전달하면 여전히 실행 오류가 발생한다.

대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없기 때문에 애초에 null을 넘기지 못하도록 금지하는 정책이 합리적이다. 즉, 인수로 null이 넘어오면 코드에 문제가 있다는 말. 이런 정책을 따르면 그만큼 부주의한 실수를 저지를 확률도 작아짐

 

결론

깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다. 이 둘은 상충하는 목표가 아니다. 오류 처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지며 코드 유지보수성도 크게 높아진다. 즉, 깨끗한 코드를 작성할 수 있다는 말씀