[클린 코드] 7장 오류 처리

이 글은 로버트 마틴의 '클린 코드'를 읽고 TIL(Today I Learned)로써 정리한 내용을 기록하는 글입니다.
자세한 내용은 책을 통해 확인하실 수 있습니다.

알라딘: 클린 코드 Clean Code (aladin.co.kr)

클린 코드 Clean Code

오류 처리

• 오류 처리는 프로그램에 반드시 필요한 요소 중 하나이다.
• 무언가 잘못될 가능성을 항상 존재한다.
• 깨끗한 코드와 오류 처리는 연관성이 있다.
• 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기가 힘들어질 수 있다.

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

• 오류코드를 사용하면 논리와 오류처리가 뒤섞인다.
• 오류가 발생하면 예외를 던지는 편이 낫다. 호출자 코드가 더 깔끔해진다.

//나쁜코드
public class DeviceController {
  public void sendShutDown() {
    DeviceHandle handle = getHandle(DEV1);
    if(handle != DeviceHandle.INVALID) {
      retrieveDeviceRecord(handle);
      if(record.getStatus() != DEVICE_SUSPENDED) {
      	pauseDevice(handle);
        clearDeviceWorkQueue(handle);
       	closeDevice(handle);
      } else {
      	logger.log("Device suspended. Unable to shut down");
      }
    } else {
      logger.log("Invalid handle for: " + DEV1.toString());
    }
  }
}

//개선 - 오류처리하는 하나의 함수를 로직을 수행하는 함수 + 예외 처리한 함수로 분리
public class DeviceController {
  public void sendShutDown() {
  	try {
      tryToShutDown();
    } catch (DeviceShutDownError e) {
      logger.log(e);
    }
  }
  
  private void tryToShutDown() throws DeviceShutDownError {
  	DeviceHandle handle = getHandle(DEV1);
    DeviceRecord record = retrieveDeviceRecord(handle);
    
    pauseDevice(handle);
    clearDeviceWorkQueue(handle);
    closeDevice(handle);
  }
}

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

• try블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지해야 한다.
• 예외가 발생할 코드를 짤 때는 try-catch-finally 문부터 시작하는 편이 낫다.
• try블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다.
• 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법이 좋다.
• 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.

미확인 예외를 사용하라

• 확인된 예외는 OCP(Open Closed Principle)을 위반한다.
• 메서드에서 예외를 던지더라도 catch 블록이 여러 단계 위에 있다면 그 사이 메서드 모두가 예외를 정의해야 한다.
• 단계를 내려갈 수록 호출하는 함수 수는 늘어난다. throws 경로에 위치하는 모든 함수가 예외를 알아야하므로 캡슐화가 깨진다.
• 확인된 예외도 유용하지만 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.

예외에 의미를 제공하라

• 예외를 던질 때는 전후 상황을 충분히 덧붙인다.
• 자바는 모든 예외에 호출 스택을 제공하지만 실패한 코드의 의도를 파악하려면 호출 스택만으로는 부족하다.
• 오류 메시지에 정보를 담아 예외와 함께 던져라. 실패한 연산 이름, 유형도 언급하도록 한다.
• 애플리케이션이 Logging 기능을 사용한다면 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨주어라.

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

• 애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.
• 외부 API를 사용할 때는 감싸기 기법을 사용하면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다.
• 감싸기 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기도 쉬워진다.
• 한 예외는 잡아내고 다른 예외는 무시해도 괜찮은 경우라면 여러 예외 클래스를 사용하도록 한다.

//나쁜 예시 - 예외에 대응하는 방식이 예외 유형과 무관하게 거의 동일하다.
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 {
 ....
}

//개선 - 예외를 잡아 유형을 반환하는 wrapper 클래스로 의존성 최소화
LocalPort port = new LocalPort(12);

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

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 (ATM1212UnlockedException e) {
      throw new PortDeviceFailure(e);
    } catch (GMXError e) {
      throw new PortDeviceFailure(e);
    }
  }
}

정상 흐름을 정의하라

• 예외는 논리를 따라가기 어렵게 만든다.
• 가장 좋은 것은 특수 상황을 처리할 필요가 없는 것이다.
• 특수 사례 패턴은 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식이다.
• 특수 사례 패턴은 클래스나 객체가 예외적인 상황을 캡슐화해서 처리하므로 클라이언트 코드가 예외적인 상황을 처리할 필요가 없게 만든다.

//나쁜 예시
try {
  MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
  m_total += expenses.getTotal();
} catch (MealExpenseNotFound e) {
  m_total += getMealPerdiem();
}

//개선 - 특수 사례 패턴으로 예외를 처리할 필요가 없게 만듦.
MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
m_total += expenses.getTotal();

public class PerDiemMealExpenses implements MealExpenses {
  public int getTotal() {
    //기본값으로 일일 기본 식비는 반환하는 코드
  }
}

null은 반환하지도, 전달하지도 마라.

• null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다.
• null 확인이 빠져 문제가 생긴 것이 아니라 null 확인이 너무 많아 문제가 생기는 것이다.
• 메서드에서 null을 반환하고 싶은 유혹이 든다면 감싸기 메서드를 구현해 예외를 던지거나 특수 사례 객체를 반환하는 방식을 고려하라.

//나쁜 코드 - null을 반환하는 getEmployees메서드.
List<Employee> employees = getEmployees();
if(employees != null) {
  for(Employee e : employees) {
    totalPay += e.getPay();
  }
}

//개선 - getEmployee 메서드가 null이 아닌 빈 List를 반환하도록 수정
List<Employee> employees = getEmployees();
for(Employee e : employees) {
  totalPay += e.getPay();
}

public List<Employee> getEmployees() {
  if(...) //직원이 없다는 것을 확인하는 조건문
    return Collections.emptyList();
}

• 정상적인 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드를 최대한 피해야 한다.
• null을 인수로 전달할 경우 NullPointerException이 발생하며 이를 고치기 위해 예외를 만들고, 이를 처리해야 한다.
• assert문을 사용하면 코드를 읽기는 편하지만 문제를 해결하지 못한다.

애초에 null을 넘기지 못하도록 금지하는 정책이 합리적이다. (인수로 null이 넘어오면 코드에 문제가 있다.)