우아한 오류 처리

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

오류 플래그를 설정하거나 호출자에게 오류 코드를 반환하는 방법을 사용하면 호출자 코드가 복잡해집니다. 함수를 호출한 즉시 오류를 확인해야 하기 때문입니다. 오류를 처리하는 알고리즘을 분리하는 것이 좋습니다.

// 오류 코드 사용
class DeviceController {
  sendShutDown(): void {
    const handle: DeviceHandle = this.getHandle(DEV1);
    if (handle !== DeviceHandle.INVALID) {
      const record: DeviceRecord = retrieveDeviceRecord(handle);
      if (record.getStatus() !== DEVICE_SUSPENDED) {
        this.pauseDevice(handle);
        this.clearDeviceWorkQueue(handle);
        this.closeDevice(handle);
      } else {
        console.error("Device suspended. Unable to shut down");
      }
    } else {
      console.error("Invalid Handle for: " + DEV1.toString());
    }
  }

  // ...
}

// 예외 사용
class DeviceController {
  sendShutDown(): void {
    try {
      this.tryToShutDown();
    } catch (e) {
      console.error(e);
    }
  }

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

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

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

예외에서 프로그램 안에다 범위를 정의한다는 사실은 매우 흥미롭습니다. try-catch-finally 문에서 try 블록에 들어가는 코드를 실행한다면 어느 시점에서든 실행이 중단된 후 catch 블록으로 넘어갈 수 있습니다.

어떤 면에서 try 블록은 트랜잭션과 비슷합니다. try 블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지해야 합니다. 그러므로 예외가 발생할 코드를 짤 댸는 try-catch-finaliy 문으로 시작하는 편이 낫습니다. 그러면 try 블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워집니다.

function retrieveSection(sectionName: string): RecordedGrip {
  try {
    const fd = fs.openSync(sectionName);
    fs.closeSync(fd);
  } catch (e) {
    throw new StorageException("retrieval error", e);
  }

  return [];
}

try-catch 구조로 범위를 정의했으므로 TDD를 사용해 필요한 나머지 논리를 추가합니다. 먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 권장합니다. 그러면 자연스럽게 try 블록의 트랜잭션 볌위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워집니다.

3. 예외에 의미를 제공하라

에외를 던질 때는 전후 상황을 충분히 덧붙입니다. 그러면 오류가 발생한 원인과 위치를 찾기가 쉬우집니다. 타입스크립트는 모든 예외에 스택을 제공합니다. 하지만 실패한 코드의 의도를 파악하려면 호출 스택만으로 부족합니다.

오류 메시지에 정보를 담아 예외와 함꼐 던집니다. 실패한 연산 이른과 실패 유형도 언급합니다. 애플리케이션이 로깅 기능을 사용한다면 catch 블록에서 오류를 기록하도록 충분한 정보를 남겨줍니다.

4. 정상 흐름을 정의하라

비즈니스 논리와 오류 처리가 잘 분리된 코드는 깨끗하고 간결한 알고리즘으로 보입니다. 하지만 그러다 보면 오류 감지가 프로그램 언저리로 밀려납니다. 외부 API를 감싸 독자적인 예외를 던지고, 코드 위에 처리기를 정의해 중단된 계산을 처리합니다. 대개는 멋진 처리 방식이지만, 떄로는 중단이 적합하지 않을 떄도 있습니다.

다음은 비용 청구 애플리케이션에서 총꼐를 계산하는 허술한 코드입니다.

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

위에서 식비를 비용으로 청구했다면 직원이 청구한 식비를 총계에 더하고, 청구하지 않았다면 일일 기본 식비를 총계에 더합니다. 그런데 예외가 논리를 따라가기 어렵게 만듭니다. 특수 상황을 처리할 필요가 없다면 더 좋지 않을까요? 그러면 코드가 훨씬 더 간결해 집니다.

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

이를 특수 사례 패턴(Special Case Pattern)이라 부릅니다. 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식입니다. 그러면 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어집니다. 클래스나 객체가 예외적인 상황을 캡슐화해서 처리합니다.

5. null을 반환하지 마라

class Test {
  registerItem(item: Item): void {
    if (item !== null) {
      const registry: ItemRegistry = this.persistenceStore.getItemRegistry();
      if (registry !== null) {
        const existing: Item = registry.getItem(item.getID());
        if (existing.getVillingPeriod().hasRetailOwner()) {
          existing.register(item);
        }
      }
    }
  }
}

null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘깁니다. 누구 하나라도 null 확인을 빼먹는다면 애플리케이션이 통제 풀능에 빠질지도 모릅니다. 메서드에서 null을 반환하고픈 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환합니다. 사용하려는 외부 API가 nul을 반환한다면 감싸기 메서드를 구현해 예외를 던지거나 특수 사례 객체를 반환하는 방식을 고려합니다.

// getEmployeesr가 null을 반환하는 코드
const employees: Employee[] = getEmployees();
if (employees !== null) {
  employees.forEach((e) => {
    totalPay += e.getPay();
  });
}

// getEmployeesr가 빈 리스트를 반환하는 코드
const employees: Employee[] = getEmployees();
employees.forEach((e) => {
  totalPay += e.getPay();
});

6. null을 전달하지 마라

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

대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없습니다. 그렇다면 애초에 null으 ㄹ넘기지 못하도록 금지하는 정책이 합리적입니다. 즉, 인수로 null이 넘어오면 코드에 문제가 있다는 말입니다. 이런 정책을 다르면 그만큼 부주의한 실수를 저지를 확률도 작아집니다.

function xProjection(p1: Point, p2: Point) {
  return (p2.x - p1.x) * 1.5;
}

xProjection(null, new Point(12, 13));

7. 결론

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

8. 출처

• 제목: 클린 코드 - 애자일 소프트웨어 장인 정신
• 저자: 로버트 C.마틴
• 옮긴이: 박재호, 이해영
• 출판사: 인사이트