클린코드 - 7.오류 처리

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

public class DeviceController {
    ...
    public void sendShutDown() {
    	DeviceHandle handle = getHandle(DEV1);
        // 디바이스 상태를 점검한다.
        if (handle != DeviceHandle.INVALID) {
        	// 레코드 필드에 디바이스 상태를 저장한다.
            retrieveDeviceRecord(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 sendShutDown() {
    	try {
        	tryToShutDown();
        } catch (DeviceShutDownError e) {
        	logger.log(e);
        }
    }
    
    private void tryToShutDown() throws DeviceShutDownError{
    	DeviceHandle handle = getHandle(DEV1);
        DeviceHandle record = retrieveDeviceRecord(handle);
        
        pauseDevice(handle);
        clearDeviceWorkQueue(handle);
        closeDevice(handle);
    }
    
    private DeviceHandle getHandle(DeviceId id) {
    	...
        throw new DeviceShutDownError("Invalid handle for: " + id.toString);
    }
}

각 개념을 독립적으로 읽고 이해할 수 있도록 변경하자

---

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

catch (Exception e) 보다는 catch 블록에서 예외 유형을 좁혀서 사용하자

ex) 파일이 없을 경우 예외를 던지는 코드

try {
	...
} catch (FileNotFoundException e) {
	...
}

---

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

확인된 예외(Checked Exception) : 컴파일 단계에서 에러 발생
미확인 예외(Unchecked Exception): 개발자가 판단하여 처리

확인된 예외는 우선 OCP(open close principle)를 위반한다

하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 한다

예를 들어 최상위 메서드에서 아래 메서드를 호출했다고 가정하자

그 아래 메서드가 또 아래 메서드를 호출한다고 했을 때

가장 마지막 최하위 메서드에서 새로운 예외를 던지는 코드를 추가한다면?

해당 메서드와 연관된 상위 메서드들에 코드를 모두 수정해야 하는 일이 벌어진다

catch 블록을 추가하거나, 선언부에 throw 절을 추가해야 한다

또한, throws 경로에 위치하는 모든 함수가 최하위 함수에서 던지는 예외를 알아야 하기 때문에 캡슐화도 깨지게 된다!

 

때로는 확인된 예외도 유용하지만, 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다는 것을 명심하자

---

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

오류 메시지에 정보를 담아 예외와 함께 던진다면,

원인과 오류 발생 위치를 찾기가 쉬워진다

---

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

ACMEPort port = new ACMEPort(12);

try {
    port.open();
    ...
} catch (DeviceResponseException e) {
	...
} catch (ATM1212UnlockedException e) {
	...
} catch (GMXError e) {
	...
} finally {
	...
}

ACMEPort 라는 외부 라이브러리를 사용한다고 가정했을 때

해당 라이브러리의 예외를 처리하기 위한 wrapper 클래스를 만들어주면 더 좋은 코드를 작성할 수 있다

public calss LocalPort {
    private ACMEPort innerPort;
    
    public LocalPort(int portNumber) {
    	innerPort = new ACMEPort(portNumber);
    }
    
    public void open() {
    	try {
        	innerPort.open();
        } catch (DeviceResponseException e) {
            ...
        } catch (ATM1212UnlockedException e) {
            ...
        } catch (GMXError e) {
            ...
        } finally {
            ...
        }
    }
}

ACMEPort 클래스가 던지는 예외를 잡아 변환하는 LocalPort라는 wrapper 클래스를 만들어주고

아래와 같이 선언하여 사용하면 외부 라이브러리와 프로그램 사이의 의존성도 크게 줄일 수 있다

테스트 코드를 작성하기에도 훨씬 편해진다

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

---

6. 정상 흐름을 정의하라

예제 코드를 통해 살펴보자

try {
    MealExpenses expenses = expensesReportDAO.getMeals(employee.getId());
    m_total = expenses.getTotal();
} catch(MealExpensesNotFound e) {
	m_total = getMealPerDiem();
}

식사 비용을 청구했을 때 누적된 값이 없어서 getTotal()을 가져오는데 실패할 경우 getMealPerDiem()을 통해 기본 식사값을 넣도록 하는 예제이다

예외로 처리하기 때문에 실제 코드를 읽게 되면 읽기가 어려워진다

 

예외 코드 대신 MealExpenses 값을 가져올 때 기본값을 포함하여 객체를 반환하도록 변경해보자

public class PerDiemMealExpenses implements MealExpenses {
    public int getTotal() {
    	// 기본값으로 일일 기본 식비를 반환
    }
}

이를 특수 사례 패턴(special case pattern)이라 부른다

클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식

클래스나 객체가 예외적인 상황을 캡슐화해서 처리하여 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다

---

7. null을 반환하지 마라

null을 반환하게 되면 모든 객체에 대해서 null 처리를 해줘야 하는 상황이 발생한다

if(item != null) {
    item.getId();
    ItemRegistry registry = peristentStore.getItemRegistry();
}

예를 들어 위 코드처럼 null이 반환되어 오류가 날 경우를 대비해서 != null로 처리해준다고 했을 때

item에 대해서는 null 처리를 했다고 볼 수 있지만

만약 저기서 peristentStore가 null 이라면?

NullPointerException 에러가 발생할 것이다

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

위 코드 역시 getEmployees() 메서드가 null 을 반환하기 때문에 코드가 지저분해진다

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

getEmployees() 메서드에서 null 대신 빈 리스트를 반환해준다면 코드를 더 깔끔하게 작성할 수 있으며,

NullPointerException 발생도 줄일 수 있다

---

8. null을 전달하지 마라

null을 반환하는 것보다 null을 전달하는 방식이 더 나쁘다

인수로 null을 기대하는 API는 거의 없다

---

9. 결론

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

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

---

마무리 느낀 점

하위 함수에서 예외를 추가 했을 때

상위 함수에도 모두 해당 예외를 적용해야하는 경우... 꽤 자주 겪었던 것 같다 앞으로는 조심해야지

외부 라이브러리 등을 처리할 때 wrapper 클래스로 생성하여 관리하는 방법은 꼭 필요한 부분인 것 같다!

꼭 기억하고 적용해야지 :)