[클린 코드: Clean Code] 7. 오류 처리

| 7. 오류 처리

---

오류 처리는 중요하다.

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

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

---

-

- 오류 코드를 사용하게 되면 논리가 오류 처리 코드와 뒤섞여버린다. 

> 예외를 사용한 코드

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-catch-finally 문으로 시작하는 편이 낫다.

> try-catch-finally Code

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

- 나머지 논리는 FileInputStream을 생성하는 코드와 close 호출문 사이에 넣으며,

  오류나 예외가 전혀 발생하지 않는다고 가정.

|| 예외에 의미를 제공하라.

---

- 예외를 던질 때는 전후 상황을 충분히 덧붙인다.

  그러면 오류가 발생한 원인과 위치를 찾기 쉬워진다!

  오류 메시지에 정보를 담아 예외와 함께 던지자. (실패한 연산 이름과 실패 유형)

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

---

-

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

- 외부 API를 사용할 때는 감싸기 기법이 최선이다.

1. 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다.

2. 나중에 다른 라이브러리로 갈아타도 비용이 적다.

3. 감싸기 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기도 쉬워진다. 

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 (GMXEError e) {
            throw new PortDeviceFailure(e);
        }
    }
 
    // ..
}

|| 정상 흐름을 정의하라

---

-

> Before

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

- 예외가 논리를 따라가기 어렵게 된다. 

  특수 상황을 처리할 필요가 없게 만들어주자.

> After

MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
m_total += expenses.getTotal();
 
//
 
public class PerDiemMealExpenses implements MealExpenses {
    public int getTotal() {
        // 기본값으로 getMealPerDiem 반환
    }
}

- 특수 사례 패턴(special case pattern) : 클래스를 마들거나 객체를 조작해 특수 사례를 처리하는 방식

  클라이언트 코드가 예외적인 상황을 처리할 필요 없게 만들자.

|| null을 반환하지 마라.

---

-

- 메서드에서 null을 반환하고픈 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환하자.

- 사용하려는 외부 API가 null을 반환한다면 감싸기 메서드를 구현해 예외를 던지거나,

  특수 사례 객체를 반환하는 방식을 고려하자.

> Before

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

> After

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

- null을 반환하는 대신 빈 리스트를 반환한다면 훨씬 깔끔하다.

- Collections.emptyList()를 활용하는 방법도 있다. (미리 정의된 읽기 전용 리스트)

public List<Employee> getEmployees() {
    if ( /*.. 직원이 없을 경우 .. */)
        return Collections.emptyList();
    }    
}

|| null을 전달하기 마라.

---

-

- 메서드에서 null을 반환하는 것보다 메서드로 null을 전달하는 방식이 더 나쁘다.

  (정상 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드는 최대한 피하자.)

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

* 깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다.

* 오류 처리를 프로그램 논리와 분리해 독자적인 사안을 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다.

* 오류 처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지며 코드 유지보수성도 크게 높아진다.

출처 : 클린 코드 (Robert C. Martin)