클린 코드(Clean Code) - 7장

7장. 오류 처리 🏰

  무언가 잘못될 가능성은 늘 존재한다. 무언가 잘못되면 바로 잡을 책임은 바로 우리 프로그래머에게 있다. 

 

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

// 중복이 심하여 나쁜 코드
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 e) {
    reportPortError(e);
    logger.log("Device response exception");
} finally {
    ...
}

// 감싸는 클래스를 사용한 좋은 코드
LocalPort port = new LocalPort(12);
try {
    port.open();
} catch (PortDeviceFailure e) {
    reportError(e);
    logger.log(e.getMessage(), e);
} finally {
    ...
}

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

public 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 e) {
            throw new PortDeviceFailure(e);
        }
    }
    ...
}

  LocalPort 클래스처럼 ACMEPort를 감싸는 클래스는 매우 유용하다. 실제로 외부 API를 사용할 때는 감싸기 기법이 최선이다. 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 나중에 다른 라이브러리로 갈아타도 비용이 적다. 또한 감싸기 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기도 쉬워진다.

  그리고  감싸기 기법을 사용하면 특정 업체가 API를 설계한 방식에 발목 잡히지 않는다. 프로그램이 사용하기 편리한 API를 정의하면 그만이다.

  흔히 예외 클래스가 하나만 있어도 충분한 코드가 많다. 예외 클래스에 포함된 정보로 오류를 구분해도 괜찮은 경우가 그렇다. 한 예외는 잡아내고 다른 예외는 무시해도 괜찮은 경우라면 여러 예외 클래스를 사용한다.

 

• 정상 흐름을 정의하라
    위에서 살펴본 것처럼 외부 API를 감싸 독자적인 예외를 던지고, 코드 위에 처리기를 정의해 중단된 계산을 처리할 수 있다. 대개는 멋진 처리 방식이지만, 때로는 중단이 적합하지 않은 때도 있다. 이런 경우 특수 사례 패턴(special case pattern)을 사용하자. 이는 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식이다. 그러면 클래스나 객체가 예외적인 상황을 캡슐화해서 처리하므로 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다.
    예를 살펴보자. 직원이 식비를 비용으로 청구했다면 직원이 청구한 식비를 총계에 더한다고 하자. 만약 식비를 비용으로 청구하지 않았다면 일일 기본 식비를 총계에 더한다.

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

  위의 코드는 예외가 논리를 따라가기 어렵게 만든다. 특수 상황을 처리하지 않는다면 아래와 같이 간결한 코드를 만들 수 있다.

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

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

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

 

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

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

  해당 코드에서 calculator.xProjection(null, new Point(12, 13)); 을 실행하면 당연히 NullPointerException이 발생한다.

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

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

public class MetircsCalculator {
    public double xProjection(Point p1, Point p2) {
        assert p1 != null : "p1 should not be null";
        assert p1 != null : "p2 should not be null";
        return (p2.x - p1.x) * 1.5;
    }
}

  위의 코드는 문서화가 잘 되어 코드 일기는 편하지만 문제를 해결하지는 못한다. 즉, 누군가 null을 전달하면 여전히 실행 오류가 발생한다. 대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다. 애초에 null을 넘기지 못하도록 금지하는 정책이 합리적이다.

 

7장 결론

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