7장 오류 처리

여기저기 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기 힘들다면 깨끗한 코드라 부르기 어렵다.

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

오류 코드 사용하기

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

public void sendShutDown() {
  DeviceHandle handle = getHandle(DEV1);
  // 디바이스 상태를 점검한다.
  if (handle != DeviceHandle.INVALID) { //오류 플래그 사용
    // ...
  } else { //호츨한 즉시 오류를 확인
    logger.log("Invalid handle");
  }
}jㅓㅁㅓㅇㅓㅏ리dfjdkf

  • 호출자 코드가 복잡해진다. 함수를 호출한 즉시 오류를 확인해야 하기 때문이다. 또한 이 단계는 잊어버리기 쉽다.

예외 사용하기

// 예외 처리만 담당
public void sendShutDown() {
    try {
        tryToShutDown();
    } catch (DeviceShutDownError e) {
        logger.log(e);        
    }
}

// 실제 로직 처리
private void tryToShutDown() throws DeviceShutDownError {
  //...
}

  • 오류가 발생하면 예외를 던지는 편이 낫다.

    그러면 논리가 오류 처리 코드와 뒤섞이지 않아서 호출자 코드가 더 깔끔해진다.

  • 코드 품질도 더 나아졌다. 앞서 뒤섞였던 개념, 즉 디바이스를 종료하는 알고리즘과 오류를 처리하는 알고리즘을 분리했기 때문이다. 이제는 각 개념을 독립적으로 살펴보고 이해할 수 있다.

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

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

따라서 해당 부분은 TDD로 개발하면 깔끔하다. 다음은 TDD로 코드를 작성하는 절차이다.

파일이 없으면 예외를 던지는지 알아보는 단위 테스트

@Test(expected = StorageException.class)
public void retrieveSectionShouldThrowOnInvalidFileName() {
    sectionStore.retrieveSection("invalid - file");
}

단위 테스트에 맞춰 아래 코드를 구현한다.

실패하는 메소드

public List<RecordedGrip> retrieveSection(String sectionName) {
    // 실제로 구현할 때까지 비어 있는 더미를 반환한다. 
    return new ArrayList<RecordedGrip>();
}

⇒ 코드가 예외를 던지지 않으므로 단위 테스트는 실패한다. 잘못된 파일 접근을 시도하게 구현을 변경하자. 아래 코드는 예외를 던진다.

예외를 던지는 최소한의 성공 테스트

public List<RecordedGrip> retrieveSection(String sectionName) {
    try {
        FileInputStream stream = new FileInputStream(sectionName);
    } catch (Exception e) {
        throw new StorageException("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

⇒ 코드가 예외를 던지므로 이제는 테스트가 성공한다. 이 시점에서 리팩터링이 가능하다. catch 블록에서 예외 유형을 좁혀 실제로 FileInputStream 생성자가 던지는 FileNotFoundException을 잡아내자.

public List<RecordedGrip> retrieveSection(String sectionName) {
    try {
        FileInputStream stream = new FileInputStream(sectionName);
    } catch (FileNotFoundException e) {
        throw new StorageException("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

이처럼 강제로 예외를 일으키는 테스트 케이스를 먼저 작성한 후 테스트를 통과하게 코드를 작성하는 방법(TDD)를 권장한다. 그러면 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.

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

확인된 예외는 사용하지 않는다. 확인된 예외는 OCP를 위반하기 때문이다. 메서드에서 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 한다. 즉, 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 한다는 말이다. 이는 OCP를 위반하고 따라서 캡슐화가 깨진다. 오류를 원거리에서 처리하기 위해 예외를 사용한다는 사실을 감안한다면 이처럼 확인된 예외가 캡슐화를 깨버리는 현상은 참으로 유감스럽다.

Checked Exception

UnChecked Exception

확인 시점

컴파일 시점

런타임 시점

처리 여부

반드시 처리

명시적으로 처리하지 않아도 됨

트랜잭션 처리

roll-back 하지 않음

roll-back 함

예

IOException, ClassNotFoundException

NullPointerException, ArithmeticException

예외에 의미를 제공하라

예외를 던질 때는 전후 상황을 충분히 덧붙인다. 그러면 오류가 발생한 원인과 위치를 찾기가 쉬워진다. 오류 메시지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름과 실패 유형도 언급한다.

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

플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.

다음은 오류를 형편없이 분류한 사례 예시이다.

외부 라이브러리를 호출하는 try-catch-finally 문을 포함한 코드로, 외부 라이브러리가 던질 예외를 모두 잡아낸다.

ACMEPort port = new ACMEPort(12);

try {
    port.open();
} catch (DeviceReponseException 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 reponse exception", e);
} finally {
    //...
}

⇒ 위 코드는 중복이 심하지만 그리 놀랍지 않다. (하지만 중복이 있으므로 당연히 좋은 코드가 아니다).

왜 놀랍지 않냐면, 원래 대다수 상황에서 우리가 오류를 처리하는 방식은 (오류를 일으킨 원인과 무관하게) 비교적 일정하기 때문이다.

  1. 오류를 기록한다.

  2. 프로그램을 계속 수행해도 좋은지 확인한다.

위의 경우 예외에 대응하는 방식이 예외 유형과 무관하게 거의 동일하기 때문에 아래처럼 간결하게 고칠수 있다. 호출하는 라이브러리 API를 감싸면서 예외 유형 하나를 반환하면 된다.

호출하는 라이브러리 API를 감싸면서 위 코드를 간결하게 작성한 코드

LocalPort port = new LocalPort(12);

try {
    port.open();
} catch (PortDeviceFailure e) { 
    reportPortError(e);
    logger.log(e.getMessage(), e);
} finally {
    //...
}

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

예외를 잡아 변환하는 감싸기(wrapper) 클래스

public class LocalPort {
    private ACMEPort innerPort;

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

    public void open() {
        try {
            innerPort.open();
        } catch (DeviceReponseException 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를 정의하면 그만이다.

    위 예제에서 port 디바이스 실패를 표현하는 예외 유형 하나를 정의했고 이로 인해 코드가 훨씬 깨끗해졌다.

  • 흔히 예외 클래스가 하나만 있어도 충분한 코드가 많다. 한 예외는 잡아내고 다른 예외는 무시해도 괜찮은 경우라면 여러 예외 클래스를 사용한다.

정상 흐름을 정의하라

특수 사례 패턴(SPECIAL CASE PATTERN)으로 정상 흐름을 정의하자. 특수 사례 패턴이란 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식이다. 이 방식으로 클래스나 객체가 예외적인 상황을 캡슐화해서 처리한다. 그러면 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다.

기존 코드: 예외가 논리를 따라가게 어렵게 만든다.

try {
    MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
    m_total += expenses.getTotal();
} catch(MealExpensesNotFound e) { //예외가 발생하는 특수한 상황 처리 로직
    m_total += getMealPerDiem();
}

특수 사례 패턴 적용 코드: 예외(특수 상황)가 캡슐화되어 클라이언트 코드는 논리가 깔끔해진다.

  • ExpenseReportDAO를 고쳐서 언제나 MealExpenses 객체를 반환한다.

  • 청구한 식바가 없는 특수한 상황이라면 일일 기본 식비를 반환하는 emalExpenses 객체를 반환한다.

// 클라이언트 코드
MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
m_total += expenses.getTotal();

// 특수 사례를 처리하는 클래스
public class PerDiemMealExpenses implements MealExpenses {
    public int getTotal() {
        // 기본값으로 일일 기본 식비를 반환한다. 
    }
}

null을 반환하지 마라

null을 반환하는 나쁜 코드예시이다.

public void registerItem(Item item) {
    if (item != null) { //클라이언트가 null인지 매번 확인해야 한다.
        ItemRegistry registry = persistentStore.getItemRegistry();
        if (registry != null) {
            Item existing = registry.getItem(item.getID());
            if (existing.getBillingPeriod().hasRetailOwner()) {
                existing.register(item);
            }
        }
    }
}

⇒ 위 코드는 나쁜 코드다! null을 반환하는 코드는 일거리를 늘릴뿐만 아니라 호출자에게 문제를 떠넘긴다. 누구 하나라도 null 확인을 빼먹는다면 애플리케이션이 통제 불능에 빠질지도 모른다.

  • 실제로 위 코드에는 persistentStore가 null인지 검사하지 않는데, 해당 객체가 null이라면 NullPointerException이 발생한다.

위 코드에서 null 확인이 누락된 것이 문제라고 말하기 쉽지만, 실상은 null 확인이 너무 많아서 문제이다. 메서드에서 null을 반환하고픈 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환한다. 사용하려는 외부 API가 null을 반환한다면 감싸기 메서드를 구현해 예외를 던지거나 특수 사례 객체를 반환하는 방식을 고려한다.

두 번째, null을 반환하는 나쁜 코드 예시이다.

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

굳이 null을 반환할 필요가 없다. null이 아닌 빈 리스트를 반환할 수 있다.

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

// 자바에서 제공하는 읽기 전용 리스트 반환
public List<Employee> getEmployees() {
    if ( /* 직원이 없다면 */ ) {
        return Collections.emptyList();
    }
}

⇒ 이처럼 코드를 변경하면 코드도 깔끔해질뿐더러 NullPointerException이 발생할 가능성도 줄어든다.

null을 전달하지 마라

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

  • null을 전달하면 메소드 내에서 NullPointerException이 발생할 가능성이 있기 때문이다.

null을 전달하는 코드

public class MetircsCalculator {
    public double xProjection(Point p1, Point p2) { //두 지점 사이의 거리를 계산
        return (p2.x - p1.x) * 1.5;       
    }
    //...
}

// null을 인수로 전달 => NPE 발생
calculator.xProjection(null, new Point(12, 13));

⇒ 누군가 인수로 null을 전달하면 NullPointerException이 발생한다.

개선안 1: 메소드 내에서 null 검사해서 예외 던지기

public class MetircsCalculator {
    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;       
    }
}

개선안 2: 메소드 내에서 assert 문 이용하기

public class MetircsCalculator {
    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이 넘어오면 코드에 문제가 있다는 발이다.

결론

  • 깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다. 이 둘은 상충하는 목표가 아니다.

    • 오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다.

    • 오류 처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지며 유지보수성도 크게 높아진다.

Previous6장 객체와 자료구조Next8장 경계

Last updated