[Clean Code] 7. 오류 처리

 

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

예외를 사용하지 않고 오류 플래그를 설정하는 등의 방식은 코드를 복잡하게 만든다. 오류가 발생하면 예외를 던지는 편이 낫다. 그래야 코드가 깔끔해진다. 논리가 오류 처리 코드와 뒤섞이지 앟는다.

 

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

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

 

미확인 예외를 사용하라

자바 첫 버전이 확인된 예외를 선보였던 당시는 확인된 예외가 멋진 아이디어로 여겨졌다. 메서드를 선언할 때는 메서드가 반환할 예외를 모두 열거했다. 그러나 C#, C++, 파이썬, 루비는 확인된 예외를 지원하지 않음에도 불구하고 안정적인 소프트웨어를 구현하기에 무리가 없다. 그러므로 우리는 확인된 오류가 치르는 비용에 상응하는 이익을 제공하는지 따져봐야 한다. 확인된 예외는 OCP를 위반한다. 메서드에서 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 한다. 즉, 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고 쳐야 한다는 말이다. 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.

 

예외에 의미를 제공하라

예외를 던질 때는 전후 상황을 충분히 덧붙인다. 단순히 호출 스택만으로 실패한 코드의 의도를 파악하기 어렵다. 오류 메시지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름과 실패 유형도 언급한다.

 

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

오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다. 다음은 오류를 형편없이 분류한 사례다. 외부 라이브러리를 호출하는 try-catcch-finally 문을 포함한 코드로, 외부 라이브러리가 던질 예외를 모두 잡아낸다.

ACMEPort port = new ACMEPort(12);

try {
    port.open();
} catch (DeviceResponseException e) {
    reportPortError(e);
    logger.log("Device response exception", e);
} catch (ATM1212UnlockedException e) {
    reportPortError(e);
    logger.log("Unlock exception", e);
} catch (GMXError error) {
    reportPortError(e);
    logger.log("Device response exception", e);
} finally {
    ...
}

위 코드는 예외에 대응하는 방식이 예외 유형과 무관하게 거의 동일하다. 그래서 코드를 간결하게 고치기가 아주 쉽다. 호출하는 라이브러리 API를 감싸면서 예외 유형 하나를 반환하면 된다.

LocalPort port = new Port(12);
try {
    port.open();
} catch (PortDeviceFailure e) {
    reportError(e);
    logger.log(e.getMessage(), e);
} finally {
    ...
}

여기서 LocalPort 클래스는 단순히 ACMEPort 클래스가 던지는 예외를 잡아 변환하는 감싸기(wrapper) 클래스일 뿐이다.

class LocalPort {
    private ACMEPort innerPort;

    public LocalPort(int portNumber) {
        innerPort = new ACMEPort(portNumber);
    }

    public void open() {
        try {
            innerPort.open();
        } catch (DeviceResponseException e) {
            throw new PortDeviceFailure(e);
        } catch (ATM1212UnlockedException e) {
            throw new PortDeviceFailure(e);
        } catch (GMXError error) {
            throw new PortDeviceFailure(e);
        } finally {
            ...
        }
    }
}

실제로 외부 API를 사용할 때는 감싸기 기법이 최선이다. 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 프로그램이 사용하기 편리한 API를 정의하면 그만이다. 위 예제에서 port 디바이스 실패를 표현하는 예외 유형 하나를 정의했는데, 프로그램이 훨씬 깨끗해졌다.

 

정상 흐름을 정의하라

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

예제를 살펴보자. 다음은 비용 청구 애플리케이션에서 총계를 계산하는 코드다.

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

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

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

위처럼 간결한 코드가 가능할까? ExpensesReportDAO를 고쳐 청구한 식비가 없다면 일일 기본 식비를 반환하는 MealExpense 객체를 반환한다.

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

이를 특수 사례 패턴이라 부른다. 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식이다. 그러면 클라이언트 코드가 예외적인 상황을 처리할 필요 없이 클래스나 객체가 처리하게 된다.

 

null을 반환하지 마라

null을 반환하는 습관을 오히려 오류를 유발하는 행위이다. 언제 NullPointExceptino이 발생할지도 모른다. 메서드에서 null을 반환하고픈 유혹이 든다면 그 대신 예외를 더지거나 특수 사례 객체를 반환한다. 많은 경우에 특수 사례 객체가 손쉬운 해결책이다.

 

null을 전달하지 마라

메서드에서 null을 반환하는 방식도 나쁘지만 메서드로 null을 전달하는 방식은 더 나쁘다. 예제를 살펴보면 이유가 드러난다. 다음은 두 지점 사이의 거리를 계산하는 메서드다.

class MetricsCalculator {
    public double xProjection(Point p1, Point p2) {
        return (p2.x - p1.x) * 1.5;
    }
}

누군가 인수로 null을 전달하면 당연히 NullPointExceptino이 발생한다. 어떻게 고치면 좋을까? 다음과 같이 새로운 유형을 만들어 던지는 방법이 있다.

class MetricsCalculator {
    public double xProjection(Point p1, Point p2) {
        if (p1 == null || p2 == null) {
            throw InvalidArgumentException("Invalid argument");
        }
        return (p2.x - p1.x) * 1.5;
    }
}

위 코드가 원래 코드보다 나을까? NullPointException보다는 조금 나을지도 모르겠다. 하지만 위 코드는 InvalidArgumentException을 잡아내는 처리기가 필요하다.

다음은 또다른 대안이다. assert 문을 사용하는 방법도 있다.

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을 넘기지 못하도록 금지하는 정책이 합리적이다.

 

결론

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