CS Clean Code - 오류처리

 

뭔가 잘못될 가능성은 늘 존재한다. 뭔가 잘못되면 바로 잡을 책임은 우리 프로그래머에게 있다.

깨끗한 코드와 오류 처리는 확실히 연관성이 있다. 상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다. 여기저기 흩어진 코드 때문에 실제 코드가 하는 일을 파악하기가 어려워지게 된다.

오류 처리는 중요하다. 하지만 오류 처리 코드로 인해 프로그램 논리를 이해하기 어려워진다면 깨끗한 코드라 부르기 어렵다. 이 장에서는 우아하고 고상하게 오류를 처리하는 기법과 고려 사항 몇 가지를 소개한다.

 

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

예전에는 예외를 지원하지 않는 프로그래밍 언어가 많았다. 그렇기 때문에 오류 플래그를 설정하거나, 오류 코드를 반환하는 방법이 전부였다.

 

예외를 사용하는 대신 오류 코드를 사용하면 코드가 훨씬 복잡해진다. 오류를 함수를 호출한 곳에서 해결해야 하기 때문이다.

public class DeviceController {
    public void sendShutDown() {
        DeviceHandle handle = getHandle(DEV1);
        
        if (handle != DeviceHandle.INVALID) {
            DeviceRecord record = retrieveDeviceRecord(handle);
            if (record.getStatus() != DEVICE_SUSPENDED) {
                pauseDevice(handle);
                clearDeviceWorkQueue(handle);
                closeDevice(handle);
            } else {
                
            }
        }
    }
}

 

위 코드를 예외로 바꾸면 코드는 훨씬 간단해진다. 디바이스를 종류하는 코드와 에러를 처리하는 부분을 분리했기 때문이다.

public class DeviceController {
    public void sendShutDown() {
        try {
            tryToShutDown();
        } catch (DeviceShutDownError 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 블록에서 무슨 일이 싱개든지 호출자가 기대하는 상태를 정의하기 쉬워진다. 즉 예외 처리를 지정함으로써 프로그래머는 코드의 방향성을 잡을 수 있다.

 

다음은 파일이 없으면 예외를 던지는지 알아보는 단위 테스트이다.

@Test(expected = StorageException.class)
public void retrieveSectionShouldThrowOnInvalidFileName() {
    sectionStore.retrieveSection("invalid - file");
}

 

코드가 예외를 던지므로 테스트가 성공한다. 이 시점에서 리펙터링이 가능하다.

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

 

catch 블록에서 예외 유형을 좁혀 실제로 FileNotFoundException을 잡아낸다.

public List<RecordedGrip> retrieveSection(String sectionName) {
    try {
        FileInputStream stream = new FileInputStream(sectionName);
        stream.close();
    } catch (FileInputException e) {
        throw new StorageException("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

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

 

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

 

미확인 예외를 사용하라

여러 해 동안 자바 프로그래머들은 확인된 예외의 장단점을 놓고 논쟁을 벌여왔다. 당시는 확인된 예외를 멋진 아이디어라 생각했다. 하지만 지금은 확인된 예외가 반드시 필요하지 않다는 사실이 분명해졌다.

개인적으로 자바를 사용할 때 제일 불편하게 느꼈던 점입니다. 연쇄적인 수정을 하게 만드는 요인 중 하나라고 생각합니다. Kotlin의 모토가 `더 나은 자바`인데 Kotlin은 해당 기능이 없습니다.

 

* 확인된 예외 : 함수를 선언할 때 발생할 수 있는 예외를 정의하는 것

 

확인된 예외는 OCP(Open Closed Principle)를 위반한다.

확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 함수들은 모두 선언부에 확인된 예외를 정의해야 한다. 모듈과 관련된 코드가 변경되지 않아도 다시 빌드한 다음 배포해야 한다.

 

대규모 시스템에서 호출이 일어나는 방식을 상상해보라. 이제 최하위 함수를 변경해 새로운 오류를 던진다고 가정하자. 변경된 함수를 호출하는 함수는 아래의 작업을 해야한다.

• catch 블록에서 새로운 예외를 처리한다.
• 선언부에 throw 절을 추가한다.

결과적으로 최하위에서 최상단까지 연쇄적인 수정이 발생한다! throws 경로에 위치하는 함수들은 최하위 함수에서 던지는 예외를 알아야 하므로 캡슐화가 깨진다.

 

예외에 의미를 제공하라

예외를 던질 때는 전후 상황을 충분히 덧붙인다. 그러면 오류가 발생한 원인과 위치를 찾기가 쉬워진다. 자바는 모든 예외에 호출 스택을 제공하지만 의도를 파악하기 부족하다.

Firebase를 사용할 때 예외 코드를 반환해서 쉽게 구글링하기 편했었고, 오류 메시지가 쉬웠던 예외는 구글링하지 않고 충분히 해결할 수 있었습니다.

 

• 오류 메시지에 정보를 담아 예외와 함께 던진다.
• 실패한 연산 이름과 실패 유형도 언급한다.
• 로깅 기능을 사용한다면 catch 블록에서 오류를 기록할 수 있도록 충분한 정보를 제공한다.

 

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

오류를 분류하는 방법은 수없이 많다. 하지만 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이다.

 

다음은 오류를 형편없이 분류한 사례이다. ACMEPort라는 외부 라이브러리를 사용할 때 라이브러리가 발생할 수 있는 에러를 모두 잡아낸다. 많은 상황에서 중복된 코드를 만들 것이다.

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

 

다음은 ACMEPort 클래스를 LocalPort로 감싸서 표현했다. 중복된 코드를 줄일 수 있으며, 호출하는 코드도 매우 깔끔해진다.

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

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

 

클래스를 감싸는 방법은 매우 유용하다. 실제로 외부 API를 사용할 때는 감싸기 기법이 최선이다.

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

 

정상 흐름을 정의하라

적절한 예외 처리는 좋지만 때로는 예외 없이 코드를 작성하는 것이 좋을 수 있다.

 

직원이 식비를 비용으로 청구했다면 직원이 청구한 식비를 더하고 그렇지 않으면 기본 식비를 더하는 코드다. 그런데 예외가 논리를 따라가기 어렵게 만든다. 예외 처리가 없으면 더 깔끔하지 않을까?

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

 

청구한 식비를 반환하거나 청구한 식비가 없으면 기본값을 반환하도록 함수를 수정하면 예외처리 없이 훨씬 간결하게 코드를 작성할 수 있다.

public class PerDiemMealExpenses implements MealExpenses {
    public int getTotal() {
        // 청구한 식비 or 기본값
    }    
}

MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
m_total += expenses.getTotal();

 

이를 특수 사례 패턴이라 부른다. 클래스나 객체가 예외적인 상황을 캡슐화해서 처리하므로 예외적인 상황을 처리할 필요가 없어진다.

 

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을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다. 누구 하나라도 null 확인을 빼먹는다면 어플리케이션은 통제 불능으로 빠질지도 모른다. null을 반환하고픈 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환한다. 많은 경우에 특수 사례 객체가 손수윈 해결책이다.

 

불필요한 null 체크가 필요하고 깜빡한 경우 NPE로 이어질 수 있다.

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

 

코드가 깔끔해지고 NPE 위험도 없어진다.

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

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

 

null을 전달하지 마라

함수로 null을 반환하는 방식도 나쁘지만 null을 함수로 전달하는 방식은 더 나쁘다.

 

두 지점 사이의 거리를 계산하는 간단한 함수이다. 만약 실수로 null을 전달하면 어떤 일이 발생할까? 당연히 NPE가 발생한다.

public class MetricsCalculator {
    public double xProjection(Point p1, Point p2) {
        return (p2.x - p1.x) * 1.5;     
    }
}

 

그럼 어떻게 고치면 좋을까? 새로운 예외 유형을 만들어서 던지는 방법이 있다. 그렇다면 원래 코드보다 나은가? NPE보다 조금 더 나을지도 모르겠다. 하지만 새로운 에러를 잡아야 하는 문제가 생긴다.

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

 

대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다. 그렇다면 에초에 null을 넘기지 못하도록 금지하는 정책이 합리적이다. 즉, 인수로 null을 넘어오면 코드에 문제가 있다는 말이다.

 

결론

깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다. 오류 처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지며 코드 유지보수성도 크게 높아진다.