7장. 오류 처리

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

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

예외를 지원하지 않는 경우 오류 플래그를 설정하거나 호출자에게 오류 코드를 반환해야하는데, 이 방법을 사용하면 호출자 코드가 복잡해진다. 함수를 호출한 즉시 오류를 확인해야 하기 때문이다.
오류 발생 시 예외를 던지면 논리가 오류 처리 코드와 뒤섞이지 않아 호출자 코드가 깔끔해진다.

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

try-catch-finally문에서 try블록에 들어가는 코드를 실행하면 어느 시점에서든 실행이 중단된 후 catch블록으로 넘어갈 수 있다. 어떤 면에서 try 블록은 트랜잭션과 비슷하다. try 블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지해야한다. 그래야 try블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다.

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

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

//단위테스트를 할 코드
public List<RecordedGrip> retireveSection(String sectionName) {
	//실제로 구현할 때까지 비어있는 더미를 반환한다.
    return new ArrayList<RecordedGrip>();
}

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

//단위테스트를 할 코드
public List<RecordedGrip> retireveSection(String sectionName) {
	try{
    	FileInputStream stream = new FileInputStream(sectionName);
    } catch (Exception e) {
    	throw new StorageException("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

코드가 예외를 던지므로 테스트는 성공하였다. 여기서 catch블록에서 예외 유형을 좁혀 실제로 FileInputStream 생성자가 던지는 FileNotFoundException을 잡아내도록 리팩터링 가능하다.

//단위테스트를 할 코드
public List<RecordedGrip> retireveSection(String sectionName) {
	try{
    	FileInputStream stream = new FileInputStream(sectionName);
        stream.close();
    } catch (FileNotFoundException e) {
    	throw new StorageException("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

try-catch구조로 범위를 정의했으므로 TDD를 사용해 필요한 나머지 논리를 추가한다. 나머지 논리는 FileInputStream을 생성하는 코드와 close 호출문 사이에 넣으며 오류나 예외가 전혀 발생하지 않는다고 가정한다.
코드를 작성할 때 먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 사용하면 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.

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

확인된 예외는 OCP(Open Closed Principle)를 위반한다. 메서드에서 확인된 예외를 던졌는데 catch블록이 세 단계 위에 있다면 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야한다. 즉, 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야한다는 말이다. 확인된 오류를 던진다면 함수는 선언부에 throws 절을 추가해야하는데, 그러면 변경한 함수를 호출하는 함수 모두가 1) catch 블록에서 새로운 예외를 처리하거나 2) 선언부에 throw 절을 추가해야 한다. 결과적으로 최하위 단계에서 최상위 단계까지 연쇄적인 수정이 발생한다.
이처럼 확인된 예외가 캡슐화를 깨버리는 상황이 발생한다.

예외에 의미를 제공하라

예외를 던질 때는 전후 상황을 충분히 덧붙인다. 그러면 오류가 발생한 원인과 위치를 찾기가 쉬워진다. 오류 메시지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름과 실패 유형도 언급한다. 애플리케이션이 로깅 기능을 사용한다면 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨준다.

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

애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.
대다수 상황에서 우리가 오류를 처리하는 방식은 다음과 같다.

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

위 경우는 예외에 대응하는 방식이 예외 유형과 무관하게 거의 동일하다. 호출하는 라이브러리 API를 감싸면서 예외 유형 하나를 반환하면 된다.

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

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

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 DeviceResponseException(e);
        } catch (ATM1212UnlockedException e) {
        	throw new ATM1212UnlockedException(e);
        } catch (GMXError e) {
        	throw new GMXError(e);
        }
    }
    ...
}

외부 API를 사용할 때는 감싸기 기법이 최선이다. 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 나중에 다른 라이브러리로 갈아타도 비용이 적으며, 감싸기 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기도 쉬워진다.
흔히 예외 클래스가 하나만 있어도 충분한 코드가 많다. 예외 클래스에 포함된 정보로 오류를 구분해도 괜찮은 경우가 그렇다. 한 예외는 잡아내고 다른 예외는 무시해도 괜찮은 경우라면 여러 예외 클래스를 사용한다.

정상 흐름을 정의하라

앞 절에서 충고한 지침을 충실히 따른다면 비즈니스 논리와 오류 처리가 잘 분리된 코드가 나온다. 그러다보면 오류 감지가 프로그램 언저리로 밀려나는 경우가 발생할 수 있는데, 외부 API를 감싸 독자적인 예외를 던지고, 코드 위에 처리기를 정의해 중단된 계산을 처리하는 방식은 때로 적합하지 않은 방식일 수 있다.
예외가 논리를 따라가기 어렵게 되는 특수 상황에서는 이 방식보다 클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 특수사례패턴이 적합하다.

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이 빠져있다. 만약 peristentStore가 null이라면 NullPointerException이 발생한다. 이처럼 null 확인이 너무 많은 코드는 문제가 된다. null을 반환하는 대신 예외를 던지거나 특수 사례 객체를 반환하면 문제가 해결된다. 사용하려는 외부 API가 null을 반환한다면 감싸기 메서드를 구현해 예외를 던지거나 특수 사례 객체를 반환하는 방식을 고려한다.

//기본예제(리팩토링 전, getEmployees null 반환)
List<Employee> employees = getEmployees();
if (employees != null) {
	for(Employee e : employees) {
    	totalPay += e.getPay();
    }
}

//리팩토링1(getEmployees 빈 리스트 반환)
List<Employee> employees = getEmployees();
for(Employee e : employees) {
   	totalPay += e.getPay();
}

//리팩토링2(java Collections.emptyList() 사용)
List<Employee> employees = getEmployees();
if(//직원이 없다면) {
	return Collections.emptyList();
}

null을 전달하지 마라

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

//기본예제(리팩토링 전, 인수로 null 전달 시 NullPiinterException 발생)
public class MetricsCalculator {
	public double xProjection(Point p1, Point p2) {
    	return (p2.x - p1.x) * 1.5;
    }
    ...
}

//리팩토링1(새로운 예외 유형 만들어 전달, InvalidArgumentException 잡아내는 처리기 필요)
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;
    }
    ...
}

//리팩토링2(assert문 사용, 문제 해결은 불가. null 전달 시 실행 오류 발생)
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;
    }
    ...
}