[Study][CleanCode - 2] 7. 오류 처리

📋 목차.

7. 오류 처리
    .오류 코드보다 예외를 사용하라
    .Try-Catch-Finally 문부터 작성하라
    .미확인(unchecked) 예외를 사용하라
    .예외에 의미를 제공하라
    .호출자를 고려해 예외 클래스를 정의하라
    .Null을 반환하지 마라
    .Null을 전달하지 마라
    .결론

---

✔️ 내용.

 

7. 오류 처리

 

 깨끗한 코드와 오류 처리는 연관성이 있다. 상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다.
여기저기 흩어진 오류 처리 코드 때문에 실제 코드가 하는 일을 파악하기 어렵다는 의미이다. 

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

---

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

 

 if/else를 사용하여 특정 에러 발생 시 처리를 하기보다는 try/catch를 사용한 예외 처리를 하도록 하자.

 

---

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

 

 try 블록은 트랜잭션과 비슷하다. try에서 무슨 일이 생기든 catch는 프로그램 상태를 일관성 있게 유지해야 한다.

그러므로 예외가 발생할 코드를 짤 때는 try-catch-finally 문으로 시작하는 편이 낫다.

 

 먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 권장한다.

그러면 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.

 

---

 

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

 

  많은 시간 동안 자바 프로그래머들은 확인된(checked) 예외의 장단점을 놓고 논쟁을 벌여왔다.

 

 확인된 예외는 OCP(Open Closed Principle)를 위반한다.

메서드에서 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메서드 모두가 선언부에 해당 예외를 정의해야 한다. 즉, 하위 단계에서 코드를 변경하면 상위 단 게 메서드 선언부를 전부 고쳐야 한다는 말이다.

 

 확인된 예외는 캡슐화를 깨트린다.

대규모 시스템에서 호출 과정은. 최상위 함수가 아래 함수를 호출하는 방식으로 단계가 내려갈수록 호출하는 함수 수는 늘어난다. 이제 최하위 함수에서 새로운 오류를 던진다면? 함수 선언부에 throws 절을 추가해야 한다. 그러면 변경한 함수를 호출하는 모두가 1. catch 블록에서 새로운 예외를 처리하거나, 2. 선언부에 trhow 절을 추가해야 하는 연쇄작용이 최하위 단계에서 최상위 단계까지 일어 난다. throw 경로에 위치하는 모든 함수가 최하위 함수에서 던지는 예외를 알아야 하므로 캡슐화가 깨진다.

 

 때로는 확인된 예외도 유용하다. 아주 중요한 라이브러리를 작성한다면 모든 예외를 잡아야 한다.

하지만 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.

---

.예외에 의미를 제공하라

 

 예외를 던질 때는 전후 상황을 충분히 덧붙인다.

그러면  오류가 발생한 원인과 위치를 찾기 쉬워진다. 자바는 모든 예외에 호출 스택을 제공한다. 하지만 실패 코드의 의도를 명확히 파악하기 위해서는 호출 스택만으로 부족하기 때문에 오류 메시지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름, 실패 유형 등을 담아준다. 로깅 기능을 사용해 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨준다.

 

---

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

 

 

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

 

 다음은 오류를 형편없이 분류한 사례이다. 외부 라이브러리를 호출하는 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 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){
	reportPortError(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 클래스처럼 외부 API(ACMEPort)를 감싸는 클래스는 매우 유용하다. 실제로 외부 API를 사용할 때는 감싸기 기법이 최선이다. 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 다른 라이브러리로 교체할 때 비용이 적게 든다. 또한 감싸기(Wrapper) 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기도 쉬워진다.

 

---

 

.Null을 반환하지 마라

 

 메서드에서 null을 반환하고픈 유혹이 든다면 예외를 던지거나 특수 사례 객체(ex. Collections.emptyList())를 변환한다.

또는 외부 API의 경우 감싸기(Wrapper)을 구현해 예외를 던지거나 특수 사례 객체를 변환하도록 한다. 대부분의 경우의 해결책으로는 특수 사례 객체가 손쉬운 해결책이다

 

---

.Null을 전달하지 마라

 

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

정상적인 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드는 최대한 피한다.

 

대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다. 그렇다면 애초에 null을 넘기지 못하도록 금지하는 정책이 합리적이다. 즉, 인수로 null이 넘어오면 코드에 문제가 있다는 말이다. 이런 정책을 따르면 그만큼 부주의한 실수를 저지를 확률도 작아진다.

 

---

. 결론

 

 깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다.

오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다. 오류 처리를 논리와 분리하면 독립적인 추론이 가능해 코드 유지보수성도 크게 높아진다.

 

 

---

📝 느낀 점.

 - OCP와 캡슐화를 깨트리는 Checked 예외보다는 Unchecked 예외를 사용하자!
 - Exception에 오류에 대한 명확한 정보를 담아 보내자
 - 비즈니스와 오류처리를 분리하도록 한다! (Wrapper 사용)
 - Null을 반환/전달하지 말자
 - 깨끗한 코드는 안정성 또한 높아야 한다!