쾌락코딩

클린코드_오류처리

02 Feb 2019 | book

여기저기 흩어진 오류 처리 코드는 실제 코드가 하는 일을 파악하기 힘들게 한다. 오류 처리 코드로 인해 프로그램 논리를 이해하기 어려워진다면 깨끗한 코드라 부르기 어렵다.

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

먼저 오류 코드를 사용해서 급급하게 오류를 처리하는 코드부터 보자.

public class DeviceController {
    ...
    public void sendShutDown() {
        DeviceHandle handle = getHandle(DEV1);
        // 디바이스 상태를 점검한다.'
        if (handle != DeviceHandle.INVALID) {
            // 레코드 필드에 디바이스 상태를 저장한다.
            retriveDeviceRecord(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 shutDown() {
        try {
            tryToShutDown();
        } catch (DeviceShutDownError e) {
            logger.log(e);
        }
    }

    private void tryToShutDown() throws DeviceShutDownError {
        DeviceHandle handle = getHandle(DEV1);
        DeviceHnadle record = retrieveDeviceRecord(handle);

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

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

    ...
}

코드가 확실히 깔끔해졌다. 품질도 나아졌다. 앞서 뒤섞였던 개념, 즉 디바이스를 종료하는 알고리즘과 오류를 처리하는 알고리즘을 분리했기 때문이다.

오류 처리 작성 팁

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

예를 들자면 테스트 코드에 작성된 코드가 아래와 같다고 하자.

public List<RecordedGrip> retireveSection(String sectionName) {
    try {
        FileInputStream strem = new FileInputStream(sectionName);
    } catch (Exception e) {
        throw new StorageExeption("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

잘못된 파일 접근을 시도하게 되면 에러를 뿜어내는 코드다. 이제 리팩토링이 가능하다. catch 블록에서 예외 유형을 좁혀 실제로 FileInputStream 생성자가 던지는 FileNotFoundException을 잡아내자.

public List<RecordedGrip> retireveSection(String sectionName) {
    try {
        FileInputStream strem = new FileInputStream(sectionName);
    } catch (FileNotFoundExeption e) {
        throw new StorageExeption("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

try-catch 구조로 범위를 정의했으므로 TDD를 사용해 필요한 나머지 논리를 추가하자. 나머지 논리는 FileInputStream을 생성하는 코드와 close 호출문 사이에 넣으며 오류나 예외가 전혀 발생하지 않는다고 가정한다.

예외에 의미를 제공하라

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

오류메시지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름과 실패 유형도 언급한다.

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

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

아래코드는 오류를 형편 없이 분류한 사례다. 외부 라이브러리가 던질 예외를 모두 잡아낸다.

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

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

코드를 간결하게 고쳐보자. 호출하는 라이브러리 API를 감싸면서 예외 유형 하나를 반환하면 된다.

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

new ACMEPort(12)가 new LocalPort(12)이 된것에 주목하자. LocalPort 클래스는 단순히 ACMEPort 클래스가 던지는 예외를 잡아 변환하는 Wrapper 클래스일 뿐이다.

LocalPort 클래스처럼 ACMEPort를 감싸는 클래스는 매우 유용하다. 실제로 외부 API를 사용할 때는 감싸기 기법이 최선이다. 그 이유는 아래와 같다.

  • 외부 라이브러리와 프로그램 사이의 의존성이 크게 줄어든다.
  • 에러 처리가 간결해진다.
  • 프로그램 테스트가 쉬워진다.
  • 외부 API 설계 방식에 의존하지 않아도 된다.

null을 반환하지 마라

null을 반환하는 습관은 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다. 누구 하나라도 null확인을 빼먹는다면 애플리케이션이 통제 불능에 빠질지도 모른다. 아래는 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을 반환하고 싶은 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환하라. 만약 사용하려는 외부 API가 null을 반환한다면 어떡할까? 그럴땐 Wrapper 메서드를 구현해 예외를 던지거나 특수 사례 객체를 반환하는 방식을 고려하자. 아래의 코드를 보자.

List<Employee> employees = getEmployees();
if(employees != null) {
    for(Employee e : employees) {
        totalPay += e.getPay();
    }
}

getEmployees()는 null을 반환할 수도 있다. 혹시 null을 반환하지 않을 수는 없을까?

getEmployees()를 변경해 null 대신 빈 리스트를 반환하면 코드가 훨씬 깔끔해진다.

List<Employee> employees = getEmployees();
for(Employee e : employees) {
    totalPay += e.getPay();
}

public List<Employee> getEmployees() {
    if (..직원이 없다면..)
        return Collections.emptyList();
}

이렇게 하면 NullPointerException이 발생할 가능성도 줄어든다.

null을 전달하지 마라

메서드에서 null을 반환하는 방식도 나쁘지만 메서드로 null을 전달하는 방식은 더 나쁘다.

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

Related Posts

Comments