Clean Code 요약해보기 (6)
깨끗한 코드와 오류 처리는 연관성이 있다.
상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다.
여기서 좌우된다는 표현은 코드 기반이 오류만 처리한다는 의미가 아니다.
여기저기 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기가 거의 불가능하다는 의미다.
오류 코드보다 예외를 사용하라
public class DeviceController {
...
public void sendShutDown() {
DevicedHandle 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 {
DevicedHandle handle = getHandle(DEV1);
DeviceRecord record = retrieveDeviceRecord(handle);
pauseDevice(handle);
clearDeviceWorkQueue(handle);
closeDevice(handle);
}
private DeviceHandle getHandle(DeviceID id) {
...
throw new DeviceShutDownError("Invalid handle for: " + DEV1.toString());
...
}
...
}위 두 개의 클래스 코드를 비교해보자. 아래쪽이 확실히 깨끗해지고 코드 품질도 좋아졌다.
앞서 뒤섞였던 개념, 즉 디바이스를 종료하는 알고리즘과 오류를 처리하는 알고리즘을 분리했기 때문이다.
이제는 각 개념을 독립적으로 살펴보고 이해할 수 있다.
Try-Catch-Finally 문부터 작성하라
예외가 발생할 코드를 짤 때는 try-catch-finally 문으로 시작해라.
try 블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지하게 해주고,
호출자가 기대하는 상태를 정의하기 쉬워진다.
먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후
테스트를 통과하게 코드를 작성하는 방법을 권장한다.
그러면 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.
미확인(unchecked) 예외를 사용하라
예전과 달리 지금은 확인된 예외가 반드시 필요하지 않다는 사실이 분명해졌다.
또한 확인된 예외는 OCP를 위반한다. 메서드에서 확인된 예외를 던졌는데
catch 블록이 세 단계 위에 있다면 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 한다.
즉, 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 한다는 말이다.
물론 때로는 확인된 예외도 유용하다. 아주 중요한 라이브러리라면 모든 예외를 잡아야 한다.
예외에 의미를 제공하라
예외를 던질 때는 전후 상황을 충분히 덧붙인다.
그러면 오류가 발생한 원인과 위치를 찾기가 쉬워진다.
호출 스택을 제공한다고 하지만 부족하다. 로깅 기능을 사용하여 충분한 정보를 알려주자.
호출자를 고려해 예외 클래스를 정의하라
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 {
...
}위 코드는 외부 라이브러리가 호출하는 코드의 예외를 전부 잡아내려하는 형편 없는 코드다.
대다수의 상황에서 우리가 오류를 처리하는 방식은 비교적 일정하다.
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) {
throw new PortDeviceFailure(e);
} catch (ATM1212UnlockedException e) {
throw new PortDeviceFailure(e);
} catch (GMXError e) {
throw new PortDeviceFailure(e);
}
}
...
}LocalPort 클래스처럼 ACMEPort를 감싸는 클래스는 매우 유용하다.
실제로 외부 API를 사용할 때는 감싸기 기법이 최선이다.
외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다.
나중에 다른 라이브러리로 갈아타도 비용이 적다. 또한, wrapper 클래스에서 외부 API를 호출하는 대신
테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기도 쉬워진다.
마지막 장점으로 감싸기 기법을 사용하면 특정 업체에서 API를 설계한 방식에 발목 잡히지 않는다.
프로그램이 사용하기 편리한 API를 정의하면 그만이다.
위 예제에서 우리는 port 디바이스 실패를 표현하는 예외 유형 하나를 정의한 것만으로 프로그램이 훨씬 깨끗해졌다.
정상 흐름을 정의하라
앞 절에서 충고한 지침을 충실히 따른다면 비즈니스 논리와 오류 처리가 잘 분리된 코드가 나온다.
그러다 보면 오류 감지가 프로그램 언저리로 밀려난다.
try {
MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
m_total += expenses.getTotal();
} catch (MealExpensesNotFound e) {
m_total += getMeealPerDiem();
}위 코드는 비용 청구 애플리케이션에서 총계를 계산하는 허술한 코드다.
식비를 비용으로 청구하면 직원이 청구한 식비를 총계에 더한다.
식비를 비용으로 청구하지 않았다면 일일 기본 식비를 총계에 더한다. 그런데 예외가 논리를 따라가기 어렵게 만든다.
특수 상황을 처리할 필요가 없다면 더 좋지 않을까?
그러면 코드가 훨씬 더 간결해지리라. 다음 코드를 보자.
MealExpenses expenses = expenseReportDAO.getMeals(employee.getID());
m_total += expenses.getTotal();ExpenseReportDAO를 고쳐 언제나 MealExpense 객체를 반환하고,
청구한 식비가 없다면 일일 기본 식비를 반환하는 MealExpense 객체를 반환시킴으로써 위 코드가 가능하다.
이를 특수 사례 패턴(Special Case Pattern)이라 부른다.
클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식이다.
이러면 클라이언트가 예외적인 상황을 처리할 필요가 없어진다.
null을 반환하지마라
public void registerItem(Item item) {
if (item != null) {
ItemRegistry registry = persistentStore.getItemRegistry();
if (registry != null) {
Item existing = registry.getItem(item.getID());
if (existing.getBillingPeriod().hasRetailOwner()) {
existing.register(item);
}
}
}
}이런 코드는 나쁜 코드다! null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다.
누구 하나라도 null 확인을 빼먹는다면 애플리케이션이 통제 불능에 빠질지도 모른다.
위 코드에서 둘째 행에는 null이 빠져있다는 사실을 눈치챘는가?
만약 persistentStore가 null이라면 실행 시 어떤 일이 벌어질까?
NPE가 발생하고 위에 어디선가 해당 오류를 잡을지도 모르고 아닐지도 모른다.
메서드에서 null을 반환하고픈 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환해라.
사용하려는 외부 API가 null을 반환한다면 wrapper 메서드를 구현해 예외를 던지거나
특수 사례 객체를 반환하는 방식을 고려해라.
많은 경우 특수 사례 객체가 손쉬운 해결책이다. 아래 코드를 보자.
List<Employee> employees = getEmployees();
if (employees != null) {
for (Employee e : employees) {
totalPay += e.getPay();
}
}위에서 getEmployees는 null도 반환한다. 하지만 반드시 null을 반환할 필요가 있을까? 빈 리스트를 반환하자.
List<Employee> employees = getEmployees();
for (Employee e : employees) {
totalPay += e.getPay();
}다행스럽게 자바에는 Collections.emptyList()가 있어 미리 정의된 읽기 전용 리스트를 반환한다. 우리 목적에 적합한 리스트다.
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;
}
}위 코드가 원래 코드보다 나을까? 조금은 나을 수 있다.
하지만 위 코드는 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을 넘기지 못하도록 금지하는 정책이 합리적이다. 즉, 인수로 null이 넘어오면 코드에 문제가 있다는 말이다.
결론
깨긋한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다. 이 둘은 상충하는 목표가 아니다. 오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다. 오류 처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지며 코드 유지보수성도 크게 높아진다.