Clean Code - 오류 처리

깨끗한 코드와 오류 처리는 확실히 연관성이 있다.
상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다. (여기저기 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기가 거의 불가능하다는 의미)
오류 처리 코드로 인해 프로그램 논리를 이해하기 어려워진다면 깨끗한 코드라 부르기 어렵다.

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

오류 코드를 이용하면 호출자 코드가 복잡해진다. (논리가 오류 처리 코드와 뒤섞임)
예외를 사용 시, 코드가 깨끗해지며, 코드 품질도 좋아진다. (논리가 오류 처리 코드와 뒤섞이지 않음)

• 오류처리

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

• 예외처리

public class DeviceController {
	...
    public void sendShutDown() {
    	try {
        	tryToShutDown();
        } cathc(DeviceShutDownError 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 블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다.

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

public List<RecordedGrip> retrieveSection(String sectionName) {
	return new ArrayList<RecordedGrip>();
}

• 코드가 예외를 던지지 않으므로 단위 테스트는 실패한다.
• 잘못된 파일 접근을 시도하게 구현을 변경

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

• 코드가 예외를 던지므로 이제는 테스트가 성공한다.
• 이 시점에서 리팩토링이 가능하다.
• catch 블록에서 예외 유형을 좁혀 실제로 FileInputStream 생성자가 던지는 FileNotFoundException을 잡아낸다.

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

• try-catch 구조로 범위를 정의했으므로 TDD를 사용해 필요한 나머지 논리를 추가한다.
• 먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 권장한다.
• 그러면 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.

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

• checked 예외는 OCP(Open Closed Principle)를 위반한다.
• 모든 함수가 최하위 함수에서 전디는 예외를 알아야 하므로 캡슐화가 깨진다.

예외에 의미를 제공하라.

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

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

• 오류를 분류하는 방법은 수없이 많다.
• 하지만 애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.

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", e);
} finally {
	...
}

• 위 코드는 중복이 심하지만 그리 놀랍지 않다.
• 대다수 상황에서 우리가 오류를 처리하는 방식은 (오류를 일으킨 원인과 무관하게) 비교적 일정하다.

1. 오류를 기록한다.
2. 프로그램을 계속 수행해도 좋은지 확인한다.

• 위 경우는 예외에 대응하는 방식이 예외 유형과 무관하게 거의 동일하다.
• 그래서 코드를 간결하게 고치기가 아주 쉽다.
• 호출하는 라이브러리 API를 감싸면서 예외 유형을 하나 반환하면 된다.

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

• 여기서 LocalPort 클래스는 단순히 ACMEPort 클래스가 던지는 예외를 잡아 변환하는 Wrapper 클래스 일 뿐이다.

public class LocalPort {
	private ACMEPort innerPort;
    
    public LocalPort(int portNumber) {
    	innerPort = new ACMEPort(portNumber);
    }
    
    public void open() {
    	try {
        	innerPort.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", e);
        }
    }
}

• LocalPort 클래스처럼 ACMEPort를 감싸는 클래스는 매우 유용하다.
• 실제로 외부 API를 사용할 때는 Wrapper 기법이 최선이다.
• 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다.
• 나중에 다른 라이브러리로 갈아타도 비용이 적다.
• 또한, Wrapper 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기도 쉬워진다.

정상 흐름을 정의하라.

• 외부 API를 감싸 독자적인 예외를 던지고, 코드 위에 처리기를 정의해 중단된 계산을 처리한다.
• 대개는 멋진 처리 방식이지만, 때로는 중단이 적합하지 않은 때도 있다.

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

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

• 위에서 식비를 비용으로 청구했다면 직원이 청구한 식비를 총계에 더한다.
• 식비를 비용으로 청구하지 않았다면 일일 기본 식비를 총계에 더한다.
• 그런데 예외가 논리를 따라가기 어렵게 만든다.
• 특수 상황을 처리할 필요가 없다면 더 좋지 않을까? 그러면 코드가 훨씬 간결해지리라.

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

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

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

• 이를 특수 사례 패턴(SpecialCasePattern)이라 부른다.
• 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식이다.
• 그러면 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다. (클래스나 객체가 예외적인 상황을 캡슐화해서 처리하므로.)

null을 반환하지 마라.

• 오류 처리를 논하는 장이라면 우리가 흔히 저지르는 바람에 오류를 유발하는 행위도 언급해야 생각한다.
• 그 중 첫째가 null을 반환하는 습관이다.
• 한 줄 건너 하나씩 null을 확인하는 코드로 가득한 애플리케이션이 많다.
• 이는 나쁜 코드다. (null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다.)

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

• 위에서 getEmployees는 null도 반환한다.
• 하지만 반드시 null을 반환할 필요가 있을까?
• getEmployees를 변경해 빈 리스트를 반환한다면 코드가 훨씬 깔끔해진다.

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

• 다행스럽게 자바에는 Collections.emptyList()가 있어 미리 정의된 읽기 전용 리스트를 반환한다.

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

• 이렇게 코드를 변경하면 코드도 깔끔해질뿐더러 NPE이 발생할 가능성도 줄어든다.

null을 전달하지 마라.

• 메서드에서 null을 반환하는 방식도 나쁘지만 메서드로 null을 전달하는 방식은 더 나쁘다.
• 정상적인 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드는 최대한 피한다.

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

• 누군가 인수로 null을 전달하면 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;
    }
    ...
}

• 위 코드가 NPE보다는 조금 나을지도 모르겠다.
• 하지만 위 코드는 InvalidArgumentException을 잡아내는 처리기가 필요하다.
• 또 다른 대안은 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;
    }
    ...
}

• 문서화가 잘 되어 코드 읽기는 편하지만 문제를 해결하지는 못한다.
• 누군가 null을 전달하면 여전히 실행 오류가 발생한다.
• 대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다.
• 애초에 null을 넘기지 못하도록 금지하는 정책이 합리적이다.

결론

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