search

jongfeel / BookReview

Reviews the IT or any books slowly and steady.
MIT License
4 stars 0 forks source link

Clean Code, Chapter 7: Error Handling #774

Closed jongfeel closed 5 months ago

jongfeel commented 5 months ago

Chapter 7 오류 처리 by 마이클 패더스(Michael Feathers)

오류 처리는 프로그램에 필요한 요소 중 하나이다. 뭔가 잘못될 가능성은 늘 존재하며, 그럴 때 바로 잡을 책임은 프로그래머에게 있다.

여기저기 흩어진 오류 처리 코드로 실제 코드가 하는 일을 파악하기가 불가능할 수 있다. 오류 처리로 인해 프로그램 논리를 이해하기 어렵다면 깨끗한 코드라고 부르기 어렵다.

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

예외를 지원하지 않는 언어는 오류 플래그를 설정하거나 호출자에게 오류 코드를 반환하는 방법이 전부였다. 이런 방법을 사용하면 호출자 코드가 복잡해진다. 함수를 호출한 즉시 오류를 확인해야 하기 때문이다.

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

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

 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);
     }

     private DeviceHandle getHandle(DeviceID id) {
             ...
             throw new DeviceShutDownError("Invalid handle for: " + id.toString());
             ...
         }
         ...
 }

오류 처리 방식 보다는 코드가 깨끗해지고 코드 품질도 더 나아졌다.

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

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

먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 권장한다. 그러면 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.

미확인unchecked 예외를 사용하라.

자바 프로그래머는 확인된checked 예외의 장단점을 놓고 논쟁을 벌여왔다. 자바 첫 버전에서 예외는 메서드 선언할 때 메서드가 반환한 예외를 열거하는 방식이었다. 메서드가 반환하는 예외는 메서드 유형의 일부였다.

이렇게 확인된 예외는 멋진 아이디어라 생각했다. 지금은 안정적인 소프트웨어를 제작하는 요소로 확인된 예외가 반드시 필요하지 않다는 사실이 분명해졌다. C#과 C++는 확인된 예외를 지원하지 않는다. 파이썬과 루비도 마찬가지다. 그렇기에 확인된 오류가 치르는 비용에 상응하는 이익을 제공하는지 따져봐야 한다.

확인된 예외는 OCPOpen Closed Principle를 위반한다. 하위 단계에서 코드를 변경하면 사위 단계 메서드 선언부 전부 고쳐야 한다. 모듈과 관련된 코드가 바뀌지 않았어도 선언부가 바뀌었으므로 모듈을 다시 빌드 후 배포해야 한다.

함수 호출 단계가 많고 깊어질 수록 변경한 함수 모두가 1) catch 블록에서 새로운 예외를 처리하거나 2) 선언부에 throw 절을 추가해야 한다 결과적으로 최하위 단계에서 최상위 단계까지 연쇄적인 수정이 일어난다! throws 경로에 위치하는 모든 함수가 최하위 함수에서 던지는 예외를 알아야 하므로 캡슐화가 깨진다.

때로 확인된 예외도 유용하다. 아주 중요한 라이브러리의 경우 모든 예외를 잡아서 처리해야 한다. 하지만 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.

예외에 의미를 제공하라

예외를 던질 때는 전후 상황을 충분히 덧붙인다. 자바는 예외에 호출 스택을 제공하지만, 실패한 코드의 의도를 파악하려면 호출 스택만으로 부족하다.

오류 메시지에 정보를 담아 예외를 던져야 하는데, 실패한 연산 이름과 실패 유형을 언급한다. catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨줘야 한다.

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

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

다음은 외부 라이브러리를 호출하는 try-catch-finally 문을 포함한 코드로, 외부 라이브러리가 던질 예외를 모두 잡아낸다.

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 {
    …}
}

대다수 상황에서 오류를 처리하는 방식은 오류를 일으킨 원인과 무관하게 비교적 일정하다. 1) 오류를 기록한다. 2) 프로그램을 계속 수행해도 좋은지 확인한다.

위 경우는 예외에 대응하는 방식이 예외 유형과 무관하게 동일하다. 그래서 호출하는 라이브러리 API를 감싸면서 예외 유형 하나를 반환하면 코드를 간결하게 고치기 쉽다.

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

LocalPort 클래스는 ACMEPort 클래스가 던지는 예외를 잡아 변환하는 감싸기 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 (ATM1212UnlockedException e) {
            throw new PortDeviceFailure(e);
        } catch (GMXError e) {
            throw new PortDeviceFailure(e);
        }
    }…
}

이런 wrapper 클래스는 매우 유용하다. 외부 API를 사용할 때는 감싸기 기법이 최선이며, 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 나중에 다른 라이브러리로 갈아타도 비용이 적다. 감싸기 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기 쉬워진다.

이 기법을 사용하면 특정 업체가 API를 설계한 방식에 발목 잡히지 않는다. 래퍼 클래스는 실패를 표현하는 예외 유형 하나를 정의했는데, 프로그램이 훨씬 깨끗해진다.

일반적으로 예외 클래스 하나만 있어도 충분한 코드가 많다. 예외 클래스에 포함된 정보로 오류를 구분해도 괜찮기 때문이다.

정상 흐름을 정의하라

외부 API를 감싸 독자적인 예외를 던지고, 코드 위에 처리기를 정의해 중단된 계산을 처리한다. 멋진 처리 방식이지만, 때로는 중단이 적합하지 않은 때도 있다.

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

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

총계를 구하는 방식에서 예외가 논리를 따라가기 어렵게 만든다. 예외가 발생하는 특수 상황을 처리할 필요가 없다면 더 좋을 수 있다. 그러려면 ExpenseReportDAO를 고쳐서 언제나 MealExpenses를 반환하게 하면 된다. 그리고 청구한 식비가 없다면 일일 기본 식비를 반환하는 MealExpenses를 반환한다.

public class PerDiemMealExpenses implements MealExpenses {
    public int getTotal() {
        // return the per diem default
    }
}

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

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을 반환하는 코드는 일거리를 늘리고 호출자에게 문제를 떠넘기는 것이다. 위 코드에서 persistentStore가 null 이라면 NullPointerException이 발생한다. 위쪽 어디선가 예외를 잡을지도 모르고 아닐지도 모른다. 어느 쪽이든 나쁘다.

null 체크가 누락된게 문제일 수 있지만 실제로 null 체크를 너무 많이 해서 문제이다. 메서드가 null을 반환하게 하고 싶은 유혹이 생길 때는 예외를 던지거나 특수 사례 객체를 반환하는 것이 좋다.

자바에는 Collections.emptyList()가 있어 미리 정의된 읽기 전용 리스트를 반환한다.

public List<Employee> getEmployees() {
    if ( .. there are no employees .. )
        return Collections.emptyList();
}

null을 전달하지 마라

메서드에 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;
    }
}

위 코드는 NullPointerException 보다 조금 나을수도 있지만 결국 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이 넘어오면 코드에 문제가 있다는 뜻으로 이해하는 것이다.

결론

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

참고문헌

jongfeel commented 5 months ago

미확인unchecked 예외를 사용하라 부분에서

이 부분은 저자에 따라 상반된 주장을 한다는 점에서 흥미로운 부분이다.

구글 소프트웨어 엔지니어 출신 톰 롱의 저서 < 좋은 코드, 나쁜 코드 > 의 4장 오류에 따르면 검사checked 예외와, 비검사uncheced 예외에 대해 많은 설명과 주장을 얘기한다. 4.5.3절의 저자의 결론에 따르면 호출하는 쪽에서 복구를 원할 수 있는 오류에 대해 비검사unchecked 예외가 적절하다는 의견이 있다.

이건 의견일 뿐이고, 개발자들 끼리 오류 처리 방식에 대해 동의하고 따르는게 더 좋다는 방향을 제시한다.

이는 확실히 클린 코드의 예외 처리 방식의 주장과 상반된다.

책은 많이 읽어보고 여러 저자의 주장을 이해한 후 내려볼 수 있는 최종 결론은 같은 팀 내에서 오류 처리 방식에 대해서 어떻게 일관성을 유지할 것인가를 정하는 것이 가장 좋은 방법이 아닐까 싶다.

jongfeel commented 5 months ago

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

외부 라이브러리 API wrapper 클래스 테스트 용이성 등

설명하는 방식과 써야 하는 이유에 대한 설명이 마틴 파울러의 < 엔터프라이즈 애플리케이션 아키텍처 패턴 > 책에서 언급한 게이트웨이 패턴과 매우 유사하다.

로버트 마틴 (물론 마이클 패더스의 글이긴 하지만)이 설명하는 방식의 좋은 점은 이게 꼭 어떤 디자인 패턴이라는 용어의 정의와 설명 없이 조금 더 쉽게 설명한다는 점이다.

게이트웨이 패턴도 단순화된 API 래퍼 방식 의존성 분리로 인한 테스트 용이성 등이 같다.