IT 관련 책 정리 및 후기/Clean Code

[Clean Code] 7장. 오류 처리

JUN0126 2022. 9. 19. 20:55

상당수 코드 기반은 전적으로 오류 처리 코드에 좌우된다. 

하지만 오류처리에 몰두한 나머지 기존 로직에 대해 이해도를 떨어트리고 오히려 더 복잡한 예외 처리는 더러운 코드로 가는 지름길이 된다.

그러기에 오류를 처리하는 기법과 고려사항 몇가지를 서술 해보도록 하겠다.

 

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

단순히 로깅 같은 기능들을 이용하여 오류코드를 남기는 것보다 예외를 던져서 어떠한 오류 사항인지 확인하는 것이 좋다.

오류를 처리하는 부분 (catch 와 같이)과 사용되는 로직을 분리하여 코드가 같이 섞이지 않을 수 있기 때문이다.

 

Try-Catch_Finally 문 부터 작성하여라

예외가 발생할 코드를 짤 때는 Try-Catch_Finally 문으로 시작하는 것이 좋다.

그러면 try블록에서 무슨일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다 (위에서 적은 내용이랑 비슷한 느낌)

테스트 코드를 작성함에 있어도 먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 코드를 작성하는 방법을 권장한다. 그렇게 되면 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.

 

 

미확인 예외를 사용하라

확인된(checked) 예외 는 컴파일 단계에서 확인되며 반드시 처리해야 하는 예외

  • IOException
  • SQLException

미확인(Unchecked) 예외 는 실행(Runtime) 단계에서 확인되며 명시적인 처리를 강제하지는 않는 예외

  • NullPointerException
  • IllegalArgumentException
  •  ArithmeticException

최상위 함수가 아래 함수를 호출하며 아래 함수는 그 아래 함수를 호출한다 계속하여 단계를 내려갈수록 호출하는 함수는 늘어나게 되며
최하위 함수가 오류를 확인된 오류를 던진다면 함수는 선언부에 throws절을 추가해야 한다.
위와 같은 예외 호출 시 catch 블록에서 새로운 예외를 처리하거나, 선언부에 throws절을 추가해야 한다.
결과적으로 최하위 단계에서 최상위 단계까지 연쇄적인 수정이 일어나게 된다.

 

예외에 의미를 제공하라

단순히 예외를 발생시키는 것 뿐만 아니라 오류 메세지에 상세한 정보를 담아 어떠한 오류 상황인지 명시해 주는 것이 바람직 하다.

 

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

 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 {
     ...
 }

위와 같이 reportPortError() 라는 메서드를 여러번 호출하여 예외 코드를 처리하는 것 보다 해당 클래스를 감싸서 특정한 기능(메서드) 가 실행될 떄 발생 할 수 있는 예외 상황들을 따로 분리하여 사용하는것이 바람직 하다.

 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 port = new LocalPort(12);
 try {
     port.open();
 } catch (PortDeviceFailure e) {
     reportError(e);
     logger.log(e.getMessage(), e);
 } finally {
     ...
 }

ACEMPort 클래스를 Wrapper 클래스로 만든 후 안에서 예외가 발생하는 로직을 설정해 준 후 예외를 던져 예외를 발생 시키는 로직을 내부에서 구현하게끔 하는것이 좋다.

외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서도 의존성이 크게 줄어들며, 나중에 다른 라이브러리로 갈아타도 비용이 적다.

또한 Wrapper 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트 하기도 쉬워진다.

 

정상 흐름을 정의하라

클래스나 객체가 예외적인 상황을 캡슐화해 처리하여 클라이언트 코드가 예외적인 상황을 처리할 필요가 없도록 할 수 있습니다...??

 

null 을 반환하지 마라

메서드에서 null을 반환하고픈 유혹이 든다면 그 대신 예외를 던지거나 특수 사례 객체를 반환하라

null을 반환한다면 언제든지 NPE가 발생할 수 있으며 실수로라도 체크를 안할 시에는 바로 실행이 멈추게 될테니깐

리스트 반환 시 null을 반환하지 말고 Collection.emptyList() 라는 빈배열을 예외 처리에 사용하기 좋다

null을 전달하지 마라

파라미터 값으로 null을 전달하지도 말아햐 한다. 해당 파라미터에 대해 null 체크를 해주어야 하며 예외를 결국 떠 넘긴 셈이 되므로 

애초에 null 값을 전달하지 말아야 한다.

 

 

결론

깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다 이를 위해 오류를 처리하는 부분은 프로그램 의 논리와 별개로 분리하여 기존 로직에 대해 헷갈리지 않게 하는것이 중요하고 이것이 코드의 유지보수성도 높혀주는 역할도 한다.

 

 

 

해당 내용은 Clean Code를 읽고 정리한 내용입니다.

주관적인 생각과 내용을 같이 적시하였으니 적확한 정보는 해당 책을 통하여 같이 확인 해주시길 바랍니다.

http://www.kyobobook.co.kr/product/detailViewKor.laf?mallGb=KOR&ejkGb=KOR&barcode=9788966260959

 

Clean Code(클린 코드) - 교보문고

애자일 소프트웨어 장인 정신 | 나쁜 코드도 돌아는 간다. 하지만 코드가 깨끗하지 못하면 개발 조직은 기어간다. 매년 지저분한 코드로 수많은 시간과 상당한 자원이 낭비된다. 그래야 할 이유

www.kyobobook.co.kr

 

'IT 관련 책 정리 및 후기 > Clean Code' 카테고리의 다른 글

[Clean Code] 8장 경계  (0) 2022.09.19
[Clean Code] 6장. 객체와 자료구조  (0) 2022.08.30
[Clean Code] 5장. 형식 맞추기  (0) 2022.08.28
[Clean Code] 4장. 주석  (2) 2022.08.21
[Clean Code] 3장. 함수  (0) 2022.08.21