#개발자, #노개북, #코딩, #클린코드
7. 오류처리
깨끗한 코드와 오류처리는 확실히 연관성이 있다. 상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다. 여기서 좌우된다는 표현은 코드기반이 오류만 처리한다는 의미가 아니다. 여기저기 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기 거의 불가능하다는 의미다.
오류 처리코드로 인해 프로그램 논리를 이해하기 어려워 진다면 깨끗한 코드라 불리기 어렵다.
오류 보단 예외를 활용하라
If/Else 구문보단 try/catch 구문으로 오류를 던지는것이 더 깔끔하다. 함수를 호출한 시점에 즉시 오류를 확인해야 하는데, 불행히 If/Else구문은 복잡해 지기 때문에 잊어버리기 쉽기 때문이다.
1. Try-Catch-Finally 문부터 작성하라
예외가 발생할 코드를 짤때는 try-catch-finally 문으로 시작하는 편이 낫다. 그러면 try 블록에서 무슨일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다. 이런 구조로 범위를 정의한 뒤 TDD를 사용해 필요한 나머지 논리를 추가하여 , 강제로 예외를 일으키는 '테스트 케이스'를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 권장한다. 그러면 자연스럽게 try 블록의 트랜잭션 범위 부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.
2. 미확인 예외를 사용하라
과거엔 모든 예외를 모두 열거하였고 메서드가 반환하는 예외는 메서드 유형의 일부였다. 메서드를 사용하는 방식이 '메서드 선언'과 일치 하지않으면 아에 컴파일도 못하였다. 이렇듯 예외를 지원하지 않음에도 안정적인 소프트웨어를 구현하기엔 무리가 없었다.
대규모 시스템에서 호출이 일어난다 가정한다.
Function number 1() {
Function number 2(){
Function number 3(){
Function number 4() {
....
// 계속 호출됨
}
}
}
}이제 최하위 함수를 변경해 새로운 오류를 던진다고 가정하자. 그러면 선언부에 throw절을 추가하고 , catch 블록에 새로운 예외를 처리한다. 그런데 변경한 함수에 '새로운 오류'를 던진다고 가정하면 연쇄적인 수정이 일어난다. 모든 함수가 최하위 함수에 던지는 예외를 알아야 하므로 캡슐화가 깨진다.
예외를 전질때 전후 상황을 충분히 덧붙인다. 그러면 오류가 발생한 원인과 위치를 찾기 쉬워진다. 오류 메세지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름과 실패 유형도 언급한다. 애플리케이션이 로깅 기능을 사용한다면 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨준다.
3. 호출자를 고려해 예외클래스를 정의하라
오류를 분류하는 방법은 수없이 많다. 오류가 발생한 위치로 분류가 가능하다. 오류가 발생한 컴포넌트로 분류하거나, 아니면 유형으로 분류가 가능하다. 대다수 상황에서 우리가 오류를 처리하는 방식은 다음과 같다.
1) 오류를 기록한다.
2) 프로그램을 계속 수행해도 좋은지 확인한다.
예외 유형관 무관하게 거의 동일하며 , 코드를 간결하게 고치기 아주 쉽다. 호출하는 라이브러 API를 감싸면서 예외 유형 하나를 반환하면 된다.
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를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 나중에 다른 라이브러리로 갈아타도 비용이 적다. 또한 감싸기 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 테스트하기도 쉬워진다.
또 마지막으로, 감싸기 기법을 사용하면 특정 업체가 API를 설계한 방식에 발목잡히지 않는다. 프로그램이 사용하기 편리한 API를 정의하면 그만이다.
4. 정상 흐름을 정의하라
앞서 지침은 장점이 많다. 하지만, 오류감지가 프로그램 언저리로 밀려날 수도 있다. 외부 API를 감싸 독자적인 예외를 던지고 코드 위에 처리기를 정의해 중단된 계산을 처리한다. 대개는 멋진 처리방식이지만, 때로는 중단이 적합하지 않는 때도 있다.
특수 사례 패턴 이라는 것이 있는데, 클래스를 만들거나 객체를 조작해 '특수 사례'를 처리하는 방식이다. 그러면 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다. 클래스나 객체가 예외적인 상황을 '캡슐화' 하므로.
// 총계에 청구한 식비를 더하는 함수
// catch가 예외상황에 대처할 수 없음.
try{
MealExpress expense =
expenseReportDAO.getMeals(employee.getID());
m_total += expense.getTotal();
} catch(MealExpressExpenseNotFound e){
m_total += getMealPerDiem();
}
// ExpenseReportDAO를 고쳐 언제나 MealExpense 객체를 반환
public class PerDieMealExpense implements MealExpense {
public int getTotal() {
// 기본값으로 일일 기본 식비를 반환한다.
}
}위에 함수는 식비를 비용으로 청구했다면, 청구한 식비를 총계에 더하는 함수이다. 하지만 식비를 비용으로 청구하지 않았더라면 일일 기본 식비를 총계에서 더한다. 그런데 예외가 논리를 따라가기 어렵게 만든다. 만약 청구한 식비가 없다면 일일 기본 식비를 반환해야 한다. 위
5. null
null 을 반환하지 말라. 흔히 저지르는 '오류 유발 행위'이다. 그중하나가 null을 반환하는 습관이다. null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 '호출자'에게 문제거리를 떠넘긴다. 누구 하나라도 null 확인을 빼먹는다면 애플리케이션이 통제불능에 빠질지도 모른다. 메서드에 null을 반환하고픈 유혹이 든다면 그 대신 예외를 던지거나 '특수사례'객체를 반환한다. 많은 경우 '특수 사례'객체가 손쉬운 해결책이다.
null 을 전달하지 마라. 메서드에서 null 을 반환하는것 보다 null을 전달하는것이 더 나쁘다. 정상적인 인수로 null을 기대하는 API가 아니면 메서드로 null을 전달하는 코드는 최대한 피한다. 만약 인수로 null을 전달하게 된다면 null의 예외사항이 발생한다. 예외유형을 던지는 방법을 두가지 소개해 보겠다.
// case 1
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;
}
}
// case 2
// 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;
}
}위 처리기는 InvalidArgumentException 예외를 어떻게 처리기가 필요하다. 문서화가 잘 되어 코드읽기는 편하지만 문제를 해결하지 못한다. null을 전달하면 여전히 실행오류가 생기며, 대다수 프로그래밍 언어는 호출자가 실수로 null을 적절히 처리하는 방법이 없다.
그렇다면, 애초에 null을 넘기지 못하도록 적절히 처리하는 정책이 합리적이다.
결론
깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다. 이 둘은 상충하는 목표가 아니다. 오류처리를 프로그램 논리와 분리하여 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다. 오류처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지고 코드 유지보수성도 높아진다.
