Clean Code] 7장 오류 처리

로버트 마틴의 클린 코드 7장 오류 처리 정리

 

참고 블로그

 

 

7장 오류 처리

▷ 서론

깨끗한 코드를 다루는 책에 오류 처리를 논하는 장이 있어 이상하게 여길지도 모른다.

하지만 깨끗한 코드와 오류 처리는 확실히 연관성이 있다. 

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

 

 

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

3장 p57 "오류 코드보다 예외를 사용하라" 에서 한 번 다룬 내용이다.

아래 코드에서 getHandle(DEV1), record.getStatus()를 비교하는 로직을 보면 else일 때 에러 메세지를 log로 출력한다.

하지만 이 경우 호출 즉시 오류를 확인해야 하기 때문에 잊어버리기 쉬운 단계이다. 

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(handel);
            } 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);
        DeviceRecord record = retrieveDeviceRecord(handle);
 
        pauseDevice(handle);
        clearDeviceWorkQueue(handle);
        closeDevice(handle);
    }
 
    private DeviceHandle getHandle(DeviceId id) {
        ...    	
        throw new DeviceShutDownError("Invalid handle for:" + id.toString());
        ...
    }
}

 

 

 

▷ p.s 3장] 오류 코드보다 예외를 사용하라!

if (deletePage(page) == E_OK)

위처럼 사용하면 "명령과 조회를 분리하라"는 규칙을 위반한다.

 

if (deletePage(page) == E_OK) {
    if (registry.deleteRegistry(page.name) == E_OK) {
    	logger.log("Registry deleted");
    } else {
    	logger.log("delete Registry failed");
    }
} else {
    logger.log("delete failed")
    return E_ERROR;
}

또한 여러 단계로 중첩되는 코드를 야기한다.

 

 

반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다. 

try {
	deletePage(page);
	registry.deleteRegistry(page.name);
} catch (Exception e) {
	logger.log(e.getMessage());
}

 

하지만 try/catch 블록은 추하다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 섞으므로, try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.

public void delete(Page page) {
    try {
    	deletePageAndRegistry(page);
    } catch(Exception e) {
    	logError(e);
    }
}
 
private void deletePageAndRegistry(Page page) throw Exception {
	deletePage(page);
	registry.deleteRegistry(page.name);
}
 
private void logError(Exception e) {
	logger.log(e.getMessage());
}

이렇게 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다. 

 

오류 처리도 '한 가지'작업에 속한다. 

 

 

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

예외가 발생할 코드를 짤 때는 try-catch-finally 문으로 시작하는 편이 낫다. 그러면 try 블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다. 

 

예제]

파일이 없는 경우 예외를 던지는 단위 테스트다. (TDD)

@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 StorageException("retrieval error", e);
    }
    return new ArrayList<RecordedGrip>();
}

위 코드는 예외를 던지므로 테스트가 성공한다.

이제 리팩토링을 한다. 

 

catch 블록에서 예외 유형을 좁혀서 FileNotFoundException을 잡아낸다. 

 

그 외에 필요한 나머지 논리를 추가한다. 나머지 논리는 FileInputStreamd을 생성하는 코드와 close 호출문 사이에 넣으며 오류와 예외가 전혀 발생하지 않는다고 가정한다. 

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

 

이 부분은 TDD 개발 방식과 관련이 있는 것 같은데, 먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 다음 테스트를 통과하게 작성하는 방법을 저자는 권장한다고 한다. 

이 경우 try 블록의 트랜잭션 범위부터 구현하게 되므로 try-catch-finally 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다. 

 

 

번외] TDD

 

 

 

 

▷ unchecked 예외를 사용하라 

자바에 예외에는 checked, unchecked 2가지 예외가 존재한다.

C#, C++, Python, Ruby의 경우 checked 예외를 지원하지 않지만 안정적인 소프트웨어를 구현하는데 무리가 없다. 

결론적으로 unchecked 예외를 사용할 것.

자바의 예외 계층 그림

 

 

 

▷ 예외에 의미를 제공하라

IllegalArgumentException 와 같이 자바에서 제공해주는 예외를 사용하면 Spring 내의 로직에서 예외가 발생했는지, 혹은 내 로직에서 발생했는지 알 수 없다. 

throw new IllegalArgumentException();

 

따라서 catch 블록에서 log를 작성하던가, 혹은 오류 메시지에 정보를 담아서 예외와 함께 던진다.

 

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

 

아래 코드는 오류를 형편없이 분류한 사례이다. 외부 라이브러리를 호출하는 try-catch-finally 문을 포함한 코드로, 외부 라이브러리가 던질 예외를 모두 잡아낸다. 

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 response exception", e);
} catch (GMXError e) {
    reportPortError(e);
    logger.log("Device response exception", e);
} finally {
    ...
}

위 코드의 경우 예외에 대응하는 방식이 예외 유형과 무관하게 거의 동일하므로, 코드를 간결하게 고치기 쉽다. 

 

호출하는 라이브러리 API를 감싸면서 예외 유형 하나를 반환하면 된다.

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

 

여기서 LocalPort class는 단순히 ACMEPort class가 던지는 예외를 잡아 변환하는 wrapper class일 뿐이다. 

public class LocalPort {
    private ACMEPort innerPort;
 
    public LocalPort(ACMEPort innerPort) {
        this.innerPort = innerPort;
    }
 
    public void open() {
        try {
            port.open();
        } catch (DeviceResponseException e) {
            throw new PortDeviceFailure(e);
        } catch (ATM1212UnlockedException e) {
            throw new PortDeviceFailure(e);
        } catch (GMXError e) {
            throw new PortDeviceFailure(e);
        }
 
        ...
    }
}

위와 같이 외부 API 를 사용할 때는 감싸기 기법이 최선이다. 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 동시에 테스트 코드 작성에도 용이하다.

또한 감싸기 기법을 사용하여 PortDeviceFailure 예외 유형 하나를 정의했는데, 그 결과 프로그램이 훨씬 깔끔해졌다. 

 

결론적으로 예외 처리 로직이 많은 경우 호출자를 고려해 wrapper class로 깔끔하게 사용하자. 

 

▷ 정상 흐름을 정의해라

다음 예제는 비용 청구 어플리케이션의 총계를 계산하는 허술한 코드이다.

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

위와 같이 getMeals 메소드에서 예외가 발생하지 않았다면 반환된 인스턴스에서 getTotal()을 호출하여 더하고

만약 getMeal에서 MealExpensesNotFound 예외가 발생한다면 getMealPerDiem() 메소드를 호출해 반환된 값을 더해주는데,

차라리 특수한 예외상황 자체가 안나도록 만들어주면 코드가 더 간결해질 수 있다.

 

아래와 같이 기본적으로 기본 식비를 반환하는 객체를 반환하게 한다면 예외는 발생하지 않고 더 간단하게 로직을 짤 수 있다. 그러면 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어지는데 이를 특수 사례 패턴(SPECIAL CASE PATTERN)이라 부른다.

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

 

 

 

 

▷ null을 반환하지 마라

아래 코드는 나쁜 코드이다. null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다.

또한 null 확인을 잘 하고 있다고 생각하겠지만, persistentStore 객체가 null인지 아닌지 확인하는 코드는 누락되어 있다. 

public void registerItem(Item item) {
	if (item != null) {
    ItemRegistry registry = persistentStore.getItemRegistry();
    if (registry != null) {
      Item existing = registry.getItem(item.getId());
      // ...
    }
  }
}

이 경우 null 확인이 너무 많아서 발생하는 문제이다. 

메서드에서 null을 반환하고 싶은 유혹이 든다면 

1. 예외를 던진다

2. 특수 사례 객체를 반환한다.

 

많은 경우 특수 사례 객체가 손쉬운 해결책이다. 다음과 같은 코드를 생각해보자.

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

 

getEmployees()에서 null 을 굳이 반환할 필요가 있을까? 

직원이 없는 경우 Collections.emptyList()를 반환하도록 수정한다.

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

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

 

위 경우 코드도 깔끔해질 뿐더러 NPE 가 발생할 가능성도 줄어든다.

 

 

▷ null을 전달하지 마라

메서드에서 null을 반환하는 방식은 나쁘지만 메서드로 null을 전달하는 방식은 더 나쁘다. 

 

두 지점 사이의 거리를 구하는 메서드다.

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

 

누군가 인수로 null을 전달한다면, 당연히 NPE 가 발생한다.

calculator.xProjection(null, new Point(t2, t3));

 

이를 고치기 위해서는, 

다음과 같이 새로운 예외 유형을 만들어 던진다.

public double xProjection(Point p1, Point p2) {
    if (p1 == null || p2 == null) {
        throw InvalidArgumentException("Invalid ... ");
    }
    return (p2.x - p1.x) * 1.5
}

하지만 위 코드는 InvalidArgumentException을 잡는 처리기가 필요하다. 

 

 

결론적으로 애초에 null을 인자로 넘기지 못하도록 설계하는 것이 바람직하다.