Clean Code - 07. 오류 처리

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

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

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

// bad
// 함수를 호출한 즉시 오류를 확인해야 하기 때문에 호출자 코드가 복잡해진다. 
public void sendShutDown() {
  if (handle != DeviceHandle.INVALIE) {
    if (record.getStatus() != DEVICE_SUSPENDED) {
      ...
    }
  }
  ...
}

// good
// 오류가 발생하면 예외를 던지는 편이 호출자 코드가 더 깔끔해진다.
public void sendShutDown() {
  try {
    tryToShutDown();
  } catch (DeviceShutDownError e) {
    logger.log(e);
  }
}

private void tryToShutDown() throws DeviceShutDownError {
  ...
}

private DeviceHandle getHandle(DeviceId id) {
  ...
  throw new DeviceShutDownError("");
  ...
}

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

try 블록에 들어가는 코드를 실행하면 어느 시점에서든 실행이 중단된 후 catch 블록으로 넘어갈 수 있다.
try 블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지해야 한다.
try-catch 구조로 범위를 정의한 후 필요한 나머지 논리를 추가한다.
먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 권장한다.

// 파일이 없으면 예외를 던지는지 알아보는 단위 테스트
@Test(expected = StorageException.class)
public void retrieveSectionShouldThrowOnInvalidFileName() {
  sectionStore.retrieveSection("invalid - file");
}

public List<RecordedGrip> retrieveSection(String sectionName) {
  try {
    ...
  } catch (FileNotFoundException e) {
    ...
  }
  ...
}

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

하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 하기 때문에,
확인된 오류가 치르는 비용에 상응하는 이익을 제공하는지 따져봐야 한다.
확인된 예외는 OCP(Open Closed Principle)을 위반한다.

최하위 함수를 변경해 새로운 오류를 던진다고 가정한다면,

• 최하위 단계에서 최상위 단계까지 연쇄적인 수정이 일어난다.
  • catch 블록에서 새로운 예외를 처리
  • 선언부에 throw 절을 추가
• throws 경로에 위치하는 모든 함수가 최하위 함수에서 던지는 예외를 알아야 하므로 캡슐화가 깨진다.

예외에 의미를 제공하라

오류 메시지에 정보를 담아 예외와 함께 던진다.

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

오류를 분류하는 방법

• 오류가 발생한 위치로 분류
  • 오류가 발생한 컴포넌트로 분류
• 오류 유형으로 분류
  • 디바이스 실패, 네트워크 실패, 프로그래밍 오류 등

애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.

외부 API를 사용할 때는 감싸기(wrapper) 클래스를 사용한다.

• 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어들고,
• 나중에 다른 라이브러리로 갈아타도 비용이 적다.
• 감싸기 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 테스트하기도 쉬워진다.
• 특정 업체가 API를 설계한 방식에 발목 잡히지 않는다.

예외 클래스가 하나만 있어도 충분한 코드가 많다.

• 예외 클래스에 포함된 정보로 오류를 구분해도 괜찮은 경우
• 한 예외는 잡아내고 다른 예외는 무시해도 괜찮은 경우

정상 흐름을 정의하라

• 특수 사례 패턴 (SPECIAL CASE PATTERN)
  • 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식
  • 클래스나 객체가 예외적인 상황을 캡슐화해 처리하므로 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다.

null을 반환하지 마라

null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘겨 누구 하나라도 확인을 빼먹는다면 프로그램이 통제 불능에 빠질 수도 있다.
null을 반환하는 대신 예외를 던지거나 특수 사례 객체를 반환한다.
이렇게 함으로써 코드도 깔끔해지고 NullPointerException이 발생할 가능성도 줄어든다.

null을 전달하지 마라

대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다.
-> 애초에 null을 넘기지 못하도록 금지하는 정책이 합리적

결론

깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다.
오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다.

내 생각

어떤 오류가 생길지 생각하는 것도 어려운데 어떻게 처리해야 할지를 생각하는 건 더 어렵다..