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

유지민·2022년 12월 12일
CLEAN CODEbook
0

Clean Code

목록 보기
6/8
post-thumbnail

7장. 오류 처리

오류 처리는 프로그램에 반드시 필요한 요소 중 하나일 뿐이다.
오류 처리는 입력이 이상하거나 디바이스가 실패할지도 모르는 예외 상황을 위해 존재한다.
깨끗한 코드와 오류 처리는 확실히 연관성이 있다.
상당수 코드는 전적으로 오류 처리 코드에 좌우된다.

오류 처리 코드로 인해 프로그램 논리를 이해하기 어려워진다면 깨끗한 코드라 부르기 어렵다.

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

예외를 지원하지 않는 언어는 오류의 처리 및 보고의 방법이 제한적이었다.

  • 오류 플래그의 설정
  • 호출자에게 오류 코드를 반환하는 방법
// 7-1 예제 : 오류 코드 반환
class DeviceController {
    // ...
    sendShutDown() {
        const handle = getHandle(DEV1);
        // 디바이스 상태를 점검한다.
        if (handle != DeviceHandle.INVALID) {
            // 레코드 필드에 디바이스 상태를 저장한다.
            retrieveDeviceRecord(handle);
            // 디바이스가 일시정지 상태가 아니라면 종료한다.
            if (record.getStatus() != DEVICE_SUSPENDED) {
                pauseDevice(handle);
                clearDeviceWorkQueue(handle);
                closeDevice(handle);
            } else {
                console.log("Device suspended. Unable to shut down");
            }
        } else {
            console.log("Invalid handle for : " + DEV1.toString());
        }
    }
    // ...
}

7-1 예제 코드의 문제 : 호출자 코드가 복잡해진다.
→ 함수를 호출한 즉시 오류를 확인해야 하기 때문 : 이 단계를 잊어버리기 쉬움.
오류가 발생하면 예외를 던지는 편이 낫다.
→ 호출자 코드가 더 깔끔해진다. 

// 7-2 예제 : 예외 사용
class DeviceController {
    // ...
    sendShutDown() {
        try {
            tryToShutDown();
        } catch(e) {
            console.log(e);
        }
    }

    tryToShutDown() {
        const handle = getHandle(DEV1);
        const record = retrieveDeviceRecord(handle);

        pauseDevice(handle);
        clearDeviceWorkQueue(handle);
        closeDevice(handle);
    }

    getHandle(id) {
        throw new Error("Invalid handle for: " + id.toString());
        // ...
    }
    // ...
}

코드가 깔끔해진 동시에 코드의 품질이 향상되었다.
→ 디바이스 종료 알고리즘과 오류 처리 알고리즘을 분리했기 때문

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

예외에서 프로그램 내부에 범위를 정의한다는 사실은 매우 흥미롭다.
try-catch-finally문에서 try블록에 들어가는 코드를 실행하면 어느 시점에서든 실행이 중단된 후 catch블록으로 넘어갈 수 있다.

  • try블록 : 트랜잭션과 어떤 면에서 유사하다.
    • try 블록에서 무슨 일이 생기든 catch블록은 프로그램 상태를 일관성 있게 유지해야 한다.
  • 예외가 발생할 코드를 짤 경우 try-catch-finally문으로 시작하는 편이 낫다.
function retrieveSectionShouldThrowOnInvalidFileName() {
    sectionStore.retrieveSection("invalid - file");
}
  • 단위 테스트에 맞춰 구현한 코드
function retrieveSection(sectionName) {
    // 실제로 구현할 때까지 비어있는 더미를 반환한다.
    return new [];
}

코드가 예외를 던지지 않아 단위 테스트는 실패한다.
예외를 던지는 코드로 변경해 잘못된 파일 접근을 시도하도록 하자. 

// 7-3 예제 : 예외를 던지는 코드
function retriveSection(sectionName) {
    try {
        const stream = new FileInputStream(sectionName);
    } catch (e) {
        throw new Error("retrieval error", e);
    }
    return new [];
}
  • catch 블록에서 예외 유형을 좁힌 리팩토링 버전
// 7-3 리팩토링 코드
function retrieveSection(sectionName) {
    try {
        const stream = new FileInputStream(sectionName);
        stream.close();
    } catch (e) {
        throw new Error("retrieval error", e);
    }
    return new [];
}

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

    • FileInputStream을 생성하는 코드와 close 호출문 사이에 넣어 오류와 예외가 전혀 발생하지 않는다고 가정한다.

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

    • try블록의 트랜잭션 범위부터 구현하게 되어 범위 내에서 트랜잭션의 본질을 유지하기 쉬워진다.

✅ 미확인 예외를 사용하라

예전엔 확인된 예외를 멋진 아이디어라고 생각했다.
하지만 지금은 안정적인 소프트웨어를 제작하는 요소로 확인된 예외가 반드시 필요하지 않다는 사실이 분명해졌다.
→ 확인된 오류가 치르는 비용에 상응하는 이익을 제공하는지 따져봐야 한다.

  • 확인된 예외 : OCP(Open Closed Principle) 위반

    • 메서드에서 확인된 예외를 던졌을 때, catch 블록이 세 단계 위에 있을 경우 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 함
      → 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부 전부를 고쳐야 한다는 의미

  • 대규모 시스템에서의 호출 방식

    • 최상위 함수 : 아래 함수 호출
    • 아래 함수 : 그 아래 함수 호출
      → 단계를 내려갈수록 호출하는 함수 수는 늘어남

  • 확인된 오류를 던질 경우
    - 함수는 선언부에 throws절을 추가해야 함
    - 변경하는 함수를 호출하는 함수 모두가
    1. catch 블록에서 새로운 예외를 처리하거나
    2. 선언부에 throw절을 추가해야 함
    → 최하위 단계에서 최상위 단계까지 연쇄적인 수정이 일어남을 의미
    → throws 경로에 위치하는 모든 함수가 최하위 함수에서 던지는 예외를 알아야 하므로 캡슐화가 깨진다.
    → 오류를 원거리에서 처리하기 위해 예외를 사용한다는 사실을 감안할 경우, 확인된 예외가 캡슐화를 깨버리는 현상이 발생할 수 있다.

  • 확인된 예외가 유용한 경우도 존재

    • ex) 아주 중요한 라이브러리를 작성할 때

✅ 예외에 의미를 제공하라

예외를 던질 때에는 전후 상황을 충분히 덧붙일 것.
→ 오류의 발생 원인과 위치를 찾기 쉬워진다.
오류 메시지에 정보를 담아 예외와 함께 던진다.

  • 실패한 연산 이름과 실패 유형도 언급
  • 애플리케이션이 로깅 기능을 사용할 때 catch블록에서 오류를 기록하도록 충분한 정보를 넘겨준다.

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

오류를 분류하는 방법은 수없이 많다.

  • 오류가 발생한 위치로 분류

  • 오류가 발생한 컴포넌트로 분류

  • 유형으로 분류 ex) 디바이스 실패, 네트워크 실패, 프로그래밍 오류
    애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사 : 오류를 잡아내는 방법

  • 오류를 형편없이 분류한 사례

    • 외부 라이브러리를 호출하는 try-catch-finally문을 포함한 코드
    • 외부 라이브러리가 던질 예외를 모두 잡아내는 코드.
// 7-4 예제
const port = new ACMEPort(12);

try {
    port.open();
} catch (e) {
    reportPortError(e);
    console.log("Device response exception", e);
} catch (e) {
    reportPortError(e);
    console.log("Unlock exception", e);
} catch (e) {
    reportPortError(e);
    console.log("Device response exception", e);
} finally {
    // ...
}
  • 위 코드 : 중복이 심하지만 그리 놀랍지 않다.
  • 대다수 상황에서 오류를 처리하는 방식은 (오류를 일으킨 원인과 무관하게) 비교적 일정하다.
    1. 오류를 기록한다.
    2. 프로그램을 계속 수행해도 좋은지 확인한다.
  • 위의 경우 예외에 대응하는 방식이 예외 유형과 무관하게 거의 동일하다.
// 7-4 예제 리팩토링 코드
// 호출하는 라이브러리 API를 감싸 예외 유형 하나를 반환하는 방식
const port = new LocalPort(12);
try {
    port.open();
} catch (e) {
    reportError(e);
    console.log(e.getMessage(), e);
} finally {
    // ...
}
  • 위 LocalPort 클래스는 단순히 ACMEPort 클래스가 던지는 예외를 잡아 변환하는 감싸기(wrapper)클래스의 역할만을 수행한다.
// 7-4 예제 확장 ver. (java)
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 (ATM1212UnlickedException e) {
            throw new PortDeviceFailure(e);
        } catch (GMXError e) {
            throw new PortDeviceFailure(e);
        }
    }
}

  • LocalPort 클래스와 같이 ACMEPort를 감싸는 클래스는 유용하다.

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

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

    • ex) 예외 클래스에 포함된 정보로 오류를 구분해도 괜찮은 경우

  • 한 예외는 잡아내고 다른 에외는 무시해도 괜찮은 경우 : 여러 예외 클래스를 사용

✅ 정상 흐름을 정의하라

위 지침을 따랐다면 비즈니스 논리와 오류 처리가 잘 분리된 코드가 나온다.
코드 대부분이 깨끗하고 간결한 알고리즘으로 보이기 시작한다.
→ 오류 감지가 프로그램 언저리로 밀려날 수 있다.

  • 외부 API를 감싸 독자적인 예외를 던지고, 코드 위에 처리기를 정의해 중단된 계산을 처리하는 방식
    → 대게는 멋진 처리방식이나, 때로는 중단이 적합하지 않은 경우도 존재

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

// 7-5 예제
// 식비를 비용으로 청구했다면 직원이 청구한 식비를 총계에 더한다.
// 식비를 비용으로 청구하지 않았다면 일일 기본 식비를 총계에 더한다.
try {
    const expenses = expenseReportDAO.getMeals(employee.getID());
    m_total += expenses.getTotal();
} catch (e) {
    m_total += getMealPerDiem();
}

예외가 논리를 따라가기 어렵게 만든다.
→ 특수 상황을 처리할 필요가 없도록 리팩토링해보자. 

// 7-5 예제 : 리팩토링한 코드
const expenses = expenseReportDAO.getMeals(employee.getID());
m_total += expenses.getTotal();

ExpenseReportDAO를 고쳐 언제나 MealExpense 객체를 반환하도록 한다.
청구한 식비가 없다면 일일 기본 식비를 반환하는 MealExpense 객체를 반환한다. 

class PerDiemMealExpenses implements MealExpenses {
    getTotal() {
        // 기본 값으로 일일 기본 식비를 반환한다.
    }
}
  • 특수 사례 패턴(special case pattern)
    • 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식
      → 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다.
      → 클래스나 객체가 예외적인 상황을 캡슐화해 처리하기 때문.

✅ null을 반환하지 마라

우리가 흔히 저지르는 바람에 오류를 유발하는 행위도 언급해야 한다.
ex) null을 반환하는 습관 

// 7-6 예제
function registerItm(item) {
    if (item != null) {
        const registry = persistentStore.getItemRegistry();
        if (registry != null) {
            const existing = registry.getItem(item.getID());
            if (existing.getBillingPeriod().hasRetailOwner()) {
                existing.register(item);
            }
        }
    }
}

위 코드는 나쁘다.
null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다.
→ 누구 하나라도 null 확인을 빼먹는다면 애플리케이션이 통제 불능에 빠질지도 모른다.

위 코드는 null 확인이 누락된 문제라 말하기 쉽다.
하지만 실상은 null 확인이 너무 많아서 문제이다.

  • 메서드에서 null을 반환하고픈 유혹이 든다면? 그 대신 예외를 던지거나 특수 사례 객체를 반환
  • 사용하려는 외부 API가 null을 반환한다면? 감싸기 메서드를 구현해 예외를 던지거나 특수 사례 객체를 반환

많은 경우에 특수 사례 객체가 손쉬운 해결책 

// 7-7 예제
const employees = getEmployees();
if (employees != null) {
    for (let e in employees) {
        totalPay += e.getPay();
    }
}

getEmployees를 변경해 빈 리스트를 반환해 코드를 더욱 깔끔하게 해보자. 

// 7-7 예제 : 리팩토링 코드
const employees = getEmployees();
for (let e in employees) {
    totalPay += e.getPay();
}
  • java의 경우 : Collections.emptyList()로 미리 정의된 읽기 전용 리스트 반환 가능
// 7-7 예제 : 리팩토링 코드 (in java)
public List<Employee> getEmployees() {
    if (.. 직원이 없다면 ..)
        return Collections.emptyList();
}

위 코드 : 코드가 깔끔해짐 + NullPointerException 발생 가능성 ↓

✅ null을 전달하지 마라

메서드에서 null을 반환하는 방식도 나쁘나, 메서드로 null을 전달하는 방식은 더 나쁘다.
정상적인 인수로 null을 기대하는 API가 아닐 경우 메서드로 null을 전달하는 코드를 최대한 피할 것. 

// 7-8 예제
class MetricsCalculator {
    xProjection(p1, p2) {
        return (p2.x - p1.x) * 1.5;
    }
    ...
}

인수로 null을 전달할 경우 어떤 일이 벌어질까?
calculator.xProjection(null, new Point(12,13)); → NullPointerException 발생

  • 새로운 예외 유형을 만들어 던지는 방법
// 7-8 예제 : 리팩토링 코드
class MetricsCalculator {
    xProjection(p1, p2) {
        if (p1 == null || p2 == null) {
            throw new Error("Invalid argument for MetricsCalculator.xProjection");
        }
        return (p2.x - p1.x) * 1.5;
    }
}

위 코드는 InvaludArgumentException을 잡아내는 처리기가 필요
→ assert 문을 사용하는 방법 

class MetricsCalculator {
    xProjection(p1, p2) {
        console.assert(p1 != null, "p1 should not be null");
        console.assert(p2 != null, "p2 should not be null");
        return (p2.x - p1.x) * 1.5;
    }
}

문서화가 잘 되어 코드 읽기는 편하나, 문제를 해결하지는 못한다.
→ 누군가 null을 전달할 경우 여전히 실행 오류 발생

대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다.
애초에 null을 넘기지 못하도록 금지하는 정책이 합리적이다.
즉, 인수로 null이 넘어오면 코드에 문제가 있다는 것이다.
이런 정책을 따르면 그만큼 부주의한 실수를 저지를 확률도 작아진다.

▶️ 결론

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

profile
유지민
끊임없이 도전하며 사고하는 주니어 Web 개발자 유지민입니다.
이전 포스트

[클린코드] 5장. 형식맞추기

다음 포스트

[클린코드] 6장. 객체와 자료구조

0개의 댓글