[개발서적] Clean Code 7. 오류 처리

Book Notes

[개발서적] Clean Code 7. 오류 처리

feel2 2025. 10. 23. 23:36

오류 처리는 프로그램이 반드시 필요한 요소 중 하나다.

깨끗한 코드와 오류 처리는 확실히 연관성이 있다. 상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다.

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

목록 7-1을 살펴보자.

목록 7-1 DeviceController.java

public class DeviceController {
  ...
  
  public void sendShutDown() {
  // 디바이스 상태를 점검한다.
  if (handle != DeviceHandle.INVALID) {
    // 레코드 필드에 디바이스 상태를 저장한다
    retrieveDeviceRecord(handle);
    // 디바이스가 일시정지 상태가 아니라면 종료한다.
    if (record.getStatus() != DEVICE_SUSPENDED) {
      pauseDevice(handle);
      clearDeviceWorkQueue(handle);
      closeDevice(handle);
    } else {
      logger.log("Device suspended. Unable to down");
    }
  } else {
    logger.log("Invalid handle for: " + DEV1.toString());
  }
  }
}

위와 같은 방법을 사용하면 호출자 코드가 복잡해진다.

함수를 호출한 즉시 오류를 확인해야 하기 때문이다.

그래서 오류가 발생하면 예외를 던지는 편이 낫다. 논리와 오류 처리 코드가 섞이지 않으니까.

목록 7-2는 오류를 발견하면 예외를 던지는 코드다.

목록 7-2 DeviceController.java (예외 사용)

public class DeviceController {
  ...
  
  public void sendShutDown() {
    try {
      tryToShutDown();
    } catch (DeviceShutDownError e) {
      logger.log(e);
    }
  }
  
  public void tryToShutDown() throws DeviceShutDownError {
    DeviceHandle handle = getHandle(DEV1);
    DeviceRecord record = retrieveDeviceRecord(handle);
    
    pauseDeivce(handle);
    clearDeviceWorkQueue(handle);
    closeDevice(handle);
  }
  
  private DeviceHandle getHandle(DeviceID id) {
    ...
    throw new DeviceShutDownError("Invalid handle for: " + DEV1.toString());
  }
 ...
}

코드가 확실히 깨끗해지지 않았는가!

이제는 디바이스를 종료하는 알고리즘과 오류를 처리하는 알고리즘을 분리했기 때문에 이해하기 쉽다.

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

예외에서 프로그램 안에다 범위를 정의한다는 사실은 매우 흥미롭다.

예외가 발생할 코드를 짤 때는 try-catch-finally 문으로 시작하는 편이 낫다.

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

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

단위 테스트에 맞춰 다음 코드를 구현하였다.

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

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

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

코드가 예외를 던지므로 이제는 테스트를 통과한다. 이 시점에서 리펙토링이 가능하다.

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

try-catch 구조로 범위를 정의했으므로 TDD를 사용해 필요한 나머지 논리를 추가한다.

먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 권장한다.

그러면 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬어진다.

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

논쟁은 끝났다. 여러 해 동안 자바 프로그래머들은 확인된(checked) 예외의 장단점을 놓고 논쟁을 벌였다.

당시 확인된 예외를 멋진 아이디어라 생각했다.

하지만 지금은 안정적인 소프트웨어를 제작하는 요소로 확인된 예외가 반드시 필요하지 않다는 사실이 분명해졌다.

확인된 예외는 OCP를 위반한다. 메서드에서 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 한다.

즉, 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 한다는 말이다.

대규모 시스템에서 호출이 일어나는 방식을 상상해보라.

최상위 함수가 아래 함수를 호출하고, 아래 함수는 그 아래 함수를, 단계가 늘어날수록 호출하는 함수는 늘어난다.

만약 확인된 오류를 던진다면 함수는 선언부에 throws 절을 추가해야 한다.

결과적으로 최하위 단계에서 최상위 단계까지 연쇄적인 수정이 일어난다!(캡슐화가 깨짐)

때로는 확인된 예외도 중요하다. 아주 중요한 라이브러리를 작성한다면 모든 예외를 잡아야 한다.

하지만 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.

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

오류를 분류하는 방법은 수없이 많다. 오류가 발생한 위치로 분류가 가능하다.

하지만 애플리케이션에서 오류를 정의할 때 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.

다음은 오류를 형편없이 분류한 사례다. 외부 라이브러리를 호출하는 try-catch-finally 문을 포함한 코드다.

ACMEPort port = new ACMEPort(12);

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

위 코드는 중복이 심하지만 그리 놀랍지 않다. 대다수 상황에서 우리가 오류를 처리하는 방식은 비교적 일정하다.

오류를 기록한다.
프로그램을 계속 수행해도 좋은지 확인한다.

위 경우는 예외에 대응하는 방식이 예외 유형과 무관하게 거의 동일하다.

호출하는 라이브러리 API를 감싸면서 예외 유형 하나를 반환하면 된다.

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

여기서 LocalPort 클래스는 단순히 ACMPort 클래스를 던지는 예외를 잡아 변환하는 wrapper 클래스를 뿐이다.

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

LocalPort 클래스처럼 ACMEPort를 감싸는 클래스는 매우 유용하다.

실제로 외부 API를 사용할 때는 감싸기(wrapper) 기법이 최선이다.

외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다.

나중에 다른 라이브러리로 갈아타도 비용이 적다(OCP를 준수)

또한 감싸기 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트 하기로 쉬워진다.

마지막 장점으로 감싸기 기법을 사용하면 특정 업체가 API를 설계한 방식에 발목 잡히지 않는다.

프로그램이 사용하기 편리한 API를 정의하면 그만이다.

흔히 예외 클래스가 하나만 있어도 충분히 코드가 많다. 예외 클래스에 포함된 정보로 오류를 구분해도 괜찮은 경우가 그렇다.

[정상 흐름을 정의하라]

앞 절에서 충고한 지침을 충실히 따른다면 비즈니스 논리와 오류 처리가 잘 분리된 코드가 나온다.

외부 API를 감싸 독자적인 예외를 던지고, 코드 위에 처리기를 정의해 중단된 계산을 처리한다.

대게는 멋진 처리 방식이지만, 때로는 중단이 적합하지 않은 때도 있다.

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

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

위에서 식비를 비용으로 청구했다면 직원이 청구한 식비를 총계에 더한다. 식비를 비용으로 청구하지 않았다면 일일 기본 식비를 총계에 더한다.

그런데 예외가 논리를 따라가기 어렵게 만들었다. 특수 상황을 처리할 필요가 없다면 더 좋지 않을까?

다음을 살펴보자.

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

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

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

이를 특수 사례 패턴이라 부른다. 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식이다.

그러면 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다.

클래스가 객체가 예외적인 상황을 캡슐화해서 처리하므로.

[null을 반환하지 마라]

오류 처리를 논하는 장이라면, 우리가 흔히 저지르는 오류를 유발하는 행위도 언급해야 한다고 생각한다.

그 중 첫번째가 null을 반환하는 습관이다.

다음이 한 예다.

public void registerItem(Item item) {
  if (item != null) {
    ItemRegistry registry = peristentStore.getItemRegistry();
    if (registry != null) {
      Item existing = registry.getItem(item.getID());
      if (existing.getBillingPeriod().hasRetailOwner()) {
        existing.register(item);
      }
    }
  }
}

위 코드는 나쁜 코드다! null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다.

위 코드에서 둘째 행에 null 확인이 빠졌다는 것을 눈치챘는가?

만약 persistentStore가 null이라면 실행 시 어떤 일이 벌어질까?

NullPointerException이 발생하리라(끔찍…)

메서드에서 null을 반환하고픈 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환하자.

많은 경우 특수 사례 객체가 손쉬운 해결책이다. 다음과 같은 코드를 생각해보자.

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

위에서 getEmployees는 null도 반환한다. 하지만 꼭 null을 반환할 필요가 있을까?

public List<Employee> getEmployees() {
  if (.. 직원이 없다면) {
    return Collections.emptyList();
  }
}

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

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

[null을 전달하지 마라]

메서드에서 null을 반환하는 방식도 나쁘지만, 메서드로 null을 전달하는 방식은 더 나쁘다.

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

예제를 살펴보자.

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

누군가 인수로 null을 반환한다면 당연히 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;
  }
  ...
}

위 코드가 원래 코드보다 조금 나을지도 모른다.

하지만 위 코드는 InvalidArgumentException을 잡아내는 처리기가 필요하다.

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

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

[결론]

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

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

또한 코드 유지보수성도 크게 높아진다!

'Book Notes' 카테고리의 다른 글

[개발서적] Clean Code 9. 단위 테스트 (1)	2025.10.24
[개발서적] Clean Code 8. 경계 (0)	2025.10.24
[개발서적] Clean Code 6. 객체와 자료 구조 (1)	2025.10.22
[개발서적] Clean Code 5. 형식 맞추기 (0)	2025.10.21
[개발서적] Clean Code 4. 주석 (0)	2025.10.21

현재글[개발서적] Clean Code 7. 오류 처리

feel_2

안녕하세요, 대체 불가능한 개발자(NFE) 박경태입니다.

99클럽, 클린코드, 클린아키텍처, 바닐라코딩, backend, it, 테스트코드, 백엔드, CleanArchitecture, 코딩테스트 준비, 항해99, 개발자, Spring, 개발서적, 개발, 필독서, 학습 후기, 개발자 취업, cleancode, Til,

Today :
Yesterday :

feel_2