클린코드 7장 오류 처리

깨끗한 코드와 오류처리는 연관성이 있다. 상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다. 하지만 오류 처리 코드로 인해 프로그램 논리를 이해하기 어려워진다면 깨끗한 코드라 부르기 어렵다.

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

• 오류 코드를 리턴하고 호출문에서 리턴받은 오류 코드를 확인하여 처리하는 방식은 호출자 코드가 복잡해진다. 함수를 호출한 즉시 오류를 확인해야 하기 때문이다.
• 오류가 발생하면 예외를 던지는 편이 호출자 코드가 더 깔끔해진다.
• 논리가 오류 처리 코드와 뒤섞이지 않으니까.

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

• 어떤 면에서 try 블록은 트랜잭션과 비슷하다.
  • try 블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지해야 한다.
• 예외가 발생할 코드를 짤 때는 try-catch-finally 문으로 시작하는 편이 낫다.
  • try 블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다.
• 먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 권장한다.

미확인 예외를 사용하라 #

• 확인된 예외가 반드시 필요하지는 않다.
• 확인된 예외는 OCP를 위반한다.
  • 메서드에서 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 한다.
  • 즉, 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 한다.
• 솔직히 잘 모르겠다.

예외에 의미를 제공하라 #

• 예외를 던질 때는 전후 상황을 충분히 덧붙인다.
• 그러면 오류가 발생한 원인과 위치를 찾기가 쉬워진다.

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

• 외부 API를 사용할 때는 감싸기 기법이 최선이다.
  • 외부 api를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다.
  • 또한 감싸기 클래스에서 외부 api를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램 테스트하기도 쉽다.

// ACMEPort가 외부 api 인 상황에서 LocalPort 클래스를 생성하여
// 외부 api를 감싸고 예외처리를 추가함
class LocalPort {
  #innerPort: ACMEPort;

  constructor() {
    this.#innerPort = new ACMEPort();
  }

  open = () => {
    try {
      this.#innerPort.open();
    } catch (e) {
      throw new PortDeviceFailure(e);
    }
    ...
  };
}

정상 흐름을 정의하라 #

• 특수 사례 패턴 → 클라이언트 코드가 예외적인 상황을 처리할 필요가 없도록 클래스나 객체를 조작해 특수사례를 처리하는 방식

// employ의 식비를 총계에 더한다.
// 만약 식비를 비용으로 청구하지 않았다면 일일 기본 식비를 총계에 더한다.
function getTotal(employList) {
  let m_total = 0;
  for (let employee of employList) {
    const expenses = expenseReportDAO.getMeals(employee.getID());
    try {
      m_total += expenses.getTotal();
    } catch {
      m_total += getMealPerDiem();
    }
  }

  return m_total;
}

// 하지만 expense.getTotal 함수의 기본값으로 일일 기본 식비를 반환한다면
// 클라이언트 코드에서 예외 상황을 처리할 필요가 없어진다.
function getTotal(employList) {
  let m_total = 0;
  for (let employee of employList) {
    const expenses = expenseReportDAO.getMeals(employee.getID());
    m_total += expenses.getTotal();
  }

  return m_total;
}

null을 반환하지마라 #

• null을 반환하면 한 줄 건너 하나씩 null을 확인하는 코드로 가득한 애플리케이션이 된다.
• Null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다.
• 많은 경우 특수사례 패턴이 좋은 해결책이다.

null을 전달하지 마라 #

• 메서드로 null을 전달하는 방식은 더 나쁘다.

결론 #

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