오류 처리는 프로그램에 반드시 필요한 요소 중 하나.
여기 저기 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기가 거의 불가능하다.
오류 처리는 중요하지만 해당 코드로 인해 프로그램 논리를 이해하기 어려워진다면 깨끗한 코드라 부르기 어렵다.
오류 코드보다 예외를 사용하라
함수를 호출한 즉시 오류를 확인해야 하는 것은 잊어버리기 쉽다. 그래서 오류가 발생하면 예외를 던지는 편이 더 낫다. 그러면 호출자 코드가 더 깔끔해진다. (논리가 오류 처리 코드와 뒤섞이지 않으니까)
Try-Catch-Finally 문 부터 작성하라
try catch finally 는 트랙잭션과 비슷하다. try 에서 무슨일이 생기든지 catch 블록은 일관성 있게 유지해야 한다.
미확인 예외를 사용하라
처음에는 확인된 예외가 멋진 아이디어라고 생각했다. 하지만 대부분의 경우 불필요하다.
확인된 예외는 OPC 를 위반한다. 메서드에서 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메서드는 모두가 메서드 선언부를 고쳐줘야 한다. 모듈과 관련된 코드가 전혀 바뀌지 않았는데 메서드 선언분를 전부 고쳐야한다는 말이다.
예외에 의미를 제공하라
예외를 던질 때는 전후 상황을 충분히 덧 붙인다. 그러면 오류가 발생한 원인과 위치를 찾기 쉬워진다.
자바는 모든 예외 호출 스택을 제공한다. 하지만 실패한 코드의의도를 파악하려면 호출 스택만으로는 부족하다. 오류 메시지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름과 실패 유형도 언급한다. 애플리케이션이 로깅 기능이을 사용하려면 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨준다.
호출자를 고려해 예외 클래스를 정의하라
같은 처리를 필요로하는 예외가 있으면 하나 감사서 같은 예외를 throw 하는 것이 바람직하다. 그래야 호출자가 예외에 대해서 별도로 catch 하지 않아도 된다.
정상 흐름을 정의하라
try {
MealExpense expenses = expenseReportDAO.getMeals(employee.getId());
m_total += expenes.getTotal();
} catch(MealExpenseNotFound(e) {
m_total += getMealPerDiem();
}
과 같이 작성하지 않고..
DAO 클래스를 고쳐서 언제나 MealExpense 객체를 반환하도록 처리하도록 하는 것이 좋다
MealExpense expenses = expenseReportDAO.getMeals(employee.getId());
m_total += expenes.getTotal();
public class PerDiemMealExpenses implements MealExpenases {
public int getTotal() {
// 기본 값으로 일일 기본 식비를 반환한다.
}
}
null 을 반환하지 마라
null 을 환환하는 습관은 좋지 않다. 한 줄 건너 하나씩 null 을 확인해야하는 코드로 가득한 애플리케이션이 된다.
null 을 반환하면 호출자는 매번 null 을 체크하고, 하지 않으면 오류가 발생할 가능성이커진다.
메서드에서 null을 반환하고 싶은 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환한다. (위에 PerDiemMealExpenses 같은..)
List<Employee> employees = getEmployees();
if (employees != null) {
for (employee e: employees) {
totalPay += e.getPay();
}
}
getEmployees 가 null 을 반환하기 때문에 호출자에서 체크해줘야 한다.
하지만 null 이 아닌 빈 객체를 반환하면.. 호출자가 null 체크할 필요가 없어진다
public List<Employees> getEmlpoyees() {
if (..직원이 없으면..) {
return Collections.emptyList();
}
...
}
null 을 전달하지 마라
null 을 반환하는 것도 나쁘지만 null 을 인수로 받는 방식은 더 나쁘다.
public class MetricsCalculator {
public double xProjection(Point p1, Point p2) {
return (p2.x - p1.x) * 1.5;
}
...
}
위 코드에서 null 을 전달하면 NullPointException 이 발생한다.
public class MetricsCalculator {
public double xProjection(Point p1, Point p2) {
if (p1 == null || p2 == null) {
throw InvaildArgumentException("${Message}");
}
return (p2.x - p1.x) * 1.5;
}
...
}
위 코드 처럼 처리할 수 있지만, InvalidArgumentException 을 잡아내는 처리기가 필요하다.
assert 문을 사용하는 방법도 있다. (개인적으로 별로 좋아보이진 않는다..)
public class MetricsCalculator {
public double xProjection(Point p1, Point p2) {
assert p1 != null : "p1 should not be null";
assert p2 != null : "p2 should not be null";
return (p2.x - p1.x) * 1.5;
}
...
}
문서화가 잘 되어 코드 읽기 편하지만 문제를 해결하지는 못한다. 누군가 null 을 전달하면 여전히 실행 오류가 발생한다. 대다수 프로그래밍 언어는 호출자가 실수로넘기는 null 을 적절히 처리하는 방법이 없다. 그러면 애초에 null 을 넘기지 못하도록 금지하는 정책이 합리적이다. 즉, 인수로 null 이 넘어오면 코드에 문제가 있다는 말이다. 이런 정책을 따르면 그 만큼 부주의 한 실수를 저지를 확률도 작아진다.
→ NonNull annotaiton 같은것을 활용.. 하면 IDE에서 알려줄 수 있음.
결론
깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다. 이 둘은 상충하는 목표가 아니다. 오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다. 오류 처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지며 코드 유지보수성도 크게 높아진다.
댓글 없음:
댓글 쓰기