[Clean Code] 7장, 오류 코드

오류 처리는 중요하다. 상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다.

여기서 좌우된다는 표현은 코드 기반이 오류만 처리한다는 의미가 아니다.

여기저기 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기가 거의 불가능하다는 의미이다.

 

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

• 오류 플래그 설정, 혹은 호출자에게 오류 코드를 반환하는 방법
  • 함수를 호출한 즉시 오류를 확인해야 함 → 호출자 코드가 복잡해짐.

public class DeviceController {

    ...

    DeviceHandle handle = getHandle(DEV1);
    if (handle != DeviceHandle.INVALID) {
        retrieveDeviceRecord(handle);
        if (record.getStatus() != DEVICE_SUSPENDED) {
            closeDevice(handle);
        } else {
            logger.log("Device suspended. Unable to shut down");
        }
    } else {
        logger.log("Invalid handle");
    }

    ..

 

• 예외를 던지는 방법
  • 코드가 깨끗해진다.
  • 디바이스를 종료하는 알고리즘과 오류를 처리하는 알고리즘을 분리하여 각 개념을 독립적으로 살피고 이해할 수 있다.

public class DeviceController {

    ...

    public void sendShutDown() {
        try {
            tryToShutDown();
        }
        catch (DeviceShutDownError e) {
            logger.log(e);
        }
    }

    private void tryToShutDown() {
        DeviceHandle handle = getHandle(DEV1);
        DeviceRecord record = retrieveDeviceRecord(handle);

        pauseDevice(handle);
        clearDeviceWorkQueue(handle);
        closeDevice(handle);
    }

    private DeviceHandle getHandle(DeviceId id) {
        ...
        throw new DeviceShutDownError("Invalid handle for: " + id.toString());
        ...
    }

    ...

}

 

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

• try 블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지해야 한다.
  → 어떻게 보면 트랜잭션과 비슷한 성질.
  → 예외가 발생할 코드를 짤 때는 try-catch-finally 문으로 시작하는 편이 좋음.

 

• 단위 테스트 코드 작성

@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);
    stream.close();
    } catch (Exception e) {
        throw new StorageException("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

 

• 리팩토링
  • Exception의 범위를 FileInputException으로 좁힌다.
  • TDD를 사용해 stream 선언과 stream close 사이에 추가 로직을 넣는다.
  • (먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후, 테스트를 통과하게 코드를 작성하는 법을 권장한다. 자연스럽게 try블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.)

public List<RecordedGrip> retrieveSection(String sectionName) {
    try {
        FileInputStream stream = new FileInputStream(sectionName);
                // 추가 로직
                // 추가 로직 
                // ...
    stream.close();
    } catch (FileInputException e) {
        throw new StorageException("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

 

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

• 확인(checked) 예외는 OCP를 위반한다.
  • 메서드에서 checked exception을 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 한다.
  • 즉, 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 한다.
• 확인된 예외는 몇 가지 장점을 제공하지만 안정적인 소프트웨어를 제작하는 요소로 반드시 필요하지는 않다.

 

• 개선이 필요한 예시
  • 하위 메서드에서 던진 Exception를 상위 메서드에서 모두 처리해줘야 한다.

public void catchFileInputException() {
    try {
        a();
    } catch (FileInputException e) {
        throw new StorageException("retrieval error", e);
    }
}

public void a() throws FileInputException {
    aa();
}

public void aa() throws FileInputException {
    aaa();
}

public void aaa() throws FileInputException {
    FileInputStream stream = new FileInputStream(sectionName);
    stream.close();
}

 

예외에 의미를 제공하라

• 예외를 던질 때는 전후 상황을 충분히 덧붙인다. 오류가 발생한 원인과 위치를 찾기 쉬워진다.
  • 실패한 연산 이름, 실패 유형, 기타 정보들.
  • 로깅 기능을 사용한다면 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨주기.

 

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

• 오류를 잡아내는 방법은 수없이 많다. (오류가 발생한 위치, 오류의 유형 등)
• 애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 ‘오류를 잡아내는 방법

 

• 개선이 필요한 예시
  • 외부 라이브러리가 던질 예외를 모두 잡아내고 있다.
  • 중복이 심하고, 에러마다 기능을 추가해야 한다면 코드도 길어질 것.

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 클래스는 단순히 ACMEPort 클래스가 던지는 예외를 잡아 변환하는 감싸기(wrapper) 클래스.
  • 처리 방식이 동일한 예외를 하나의 동일한 예외로 통일하여 다시 던진다.
  • 외부 API를 사용할 때는 감싸기 기법이 최선이다.
    • 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다.
    • 외부 API를 호출하는 데신에 테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기도 쉬워진다.
    • 특정 업체가 API를 설계한 방식에 발목잡히지 않는다. 프로그램이 사용하기 편리한 API를 정의하면 그만.

 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;

         // ACMEPort 객체 생성
     public LocalPort(int portNumber) {
         innerPort = new ACMEPort(portNumber);
     }

         // ACMEPort의 open() 메소드 호출.
     public void open() {
         try {
             innerPort.open();
                 // 처리 방식이 동일한 예외를 PortDeviceFailure 하나로 통일해서 변환하여 다시 던짐.
         } catch (DeviceResponseException e) {
             throw new PortDeviceFailure(e);
         } catch (ATM1212UnlockedException e) {
             throw new PortDeviceFailure(e);
         } catch (GMXError e) {
             throw new PortDeviceFailure(e);
         }
     }
     ...
 }

 

정상 흐름을 정의하라

• 외부 API를 감싸 독자적인 예외를 던지고, 코드 위에 처리기를 정의해 중단된 계산을 처리하는 방식은 대개 멋진 방식이다. 하지만 때로는 중단이 적합하지 않은 때도 있다.

 

• 개선이 필요한 예시
  • 예외가 논리를 따라가기 어렵게 만든다.
  • 특수 상황을 처리할 필요가 없다면 코드가 더 간결해질 것.

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

 

• 개선 후 예시
  • ExpenseReportDAO를 고쳐 언제나 MealExpense 객체를 반환하게 만듦.
  • 특수 사례 패턴 (Special Case Pattern)
    • 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식.
    • 클래스나 객체가 예외적인 상황을 캡슐화해서 처리
      → 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어짐.

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

 public class PerDiemMealExpenses implements MealExpenses {
     MealExpenses someThing
     public int getTotal() {
            // 기본 값으로 일일 식비 반환하도록 코드 수정.
     }
 }

 

null을 반환하지 마라

• null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다.
• 누구 하나라도 null 확인을 빼먹는다면 애플리케이션이 통제 불능에 빠질 수도 있다.
  → 예외를 던지거나 특수 사례 객체를 반환하라!*

 

• 개선이 필요한 예시
  • 아래 예시에서 getEmployess() 함수는 null도 반환하는 함수라고 가정.
  • employees가 null이 아님을 확인하는 과정이 한 번 더 필요하다.

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

 

• 개선 후 예시
  • getEmployees() 함수가 null 대신 빈 리스트를 반환하도록 수정.
    →Collections.emptyList() 사용 (특수 사례 객체)
    
  • employees가 null인지 아닌지 확인할 필요가 없다.

List<Employee> employees = getEmployees();

for(Employee e : employees) {
    totalPay += e.getPay();
}

public List<Employee> getEmployees() {
    if( .. 직원이 없다면 .. )
        return Collections.emptyList(); // 빈 리스트를 반환. 특수 사례 객체.
}

 

null을 전달하지 마라

• 정상적인 인수로 null을 기대하는 API가 아니라면 메소드로 null을 전달하는 코드는 피한다.
• 대다수의 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다. 그렇다면 애초에 null을 넘기지 못하도록 금지하는 정책이 힙리적이다.

 

• 개선이 필요한 예시
  • 함수의 인수로 null값을 전달하면 NullPointerException이 발생한다.

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

caculator.xProjection(null, new Point(12, 13)); // NullPointerException 발생

 

• 개선 후 예시 1
  • null 값을 잡아서 InvalidArgumentException을 발생시킨다.
  • 이전에 다뤘던 개선이 필요한 예시보다는 낫지만 InvalidArgumentException을 잡아내는 처리기가 필요하다.

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문을 사용해서 개선.
  • 문서화가 잘 되어 코드 읽기는 편하지만 누군가가 null을 전달하면 여전히 실행 오류가 발생한다.

public Class MetricsCalculator
{
    public double xProjection(Point p1, Point p2) {
        assert p1 != null : "p1 should not be null"; // AssertionError 발생
        assert p2 != null : "p2 should not be null";
        return (p2.x - p1.x) * 1.5;
    }
}

 

결론

깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다.

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

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