클린 코드 (Clean Code) - 7장 오류 처리

노션 정리

7장 오류 처리

 

😃 책에서 기억하고 싶은 내용을 써보세요.

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

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

• 오류 플래그를 설정하거나 호출자에게 오류 코드를 반환하는 방법을 사용하면 호출자 코드가 복잡해진다. 함수를 호출한 즉시 오류를 확인해야 하기 때문이다.
• 오류가 발생하면 예외 처리하는 편이 낫다. 논리가 오류 처리 코드와 뒤 섞이지 않으니까 더 깔끔해진다.

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

• 어떤 면에서 try 블록은 트랜잭션과 비슷하다.
• try블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지해야 한다. 그러므로 예외가 발생할 코드를 짤 때는 try-catch-finally 문으로 시작하는 편이 낫다. 그러면 try 블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다.
• 먼저 강제로 예외를 일으키는 테스트 케이스를 작성한 후 테스트를 통과하게 작성하는 방법을 권장한다. 그러면 자연스럽게 try 블록의 트랜잭션 범위부터 구현하게 되므로 범위 내에서 트랜잭션 본질을 유지하기 쉬워진다.

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

• 옛날에 비해 지금은 안정적인 소프트에어를 제작하는 요소로 확인된 예외가 반드시 필요하지 않다는 사실이 분명해졌다.
• C#은 확인된 예외를 지원하지 않는다. C++ 역시 확인된 예외를 지원하지 않는다. 파이썬이나 루비도 마찬가지다. 그럼에도 불구하고 C#, C++, 파이썬, 루비는 안정적인 소프트웨어를 구현하기에 무리가 없다. 그러므로 우리는 확인된 오류가 치르는 비용에 상응하는 이익을 제공하는지 (철저히) 따져봐야 한다.
• 확인된 예외는 OCP(Open Closed Principlel)을 위반한다.
• 때로는 확인된 예외도 중요하다. 아주 중요한 라이브러리를 작성한다면 모든 예외를 잡아야 한다. 하지만 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.

예외에 의미를 제공하라

• 예외를 던질 때는 전후 상황을 충분히 덧붙인다. 그러면 오류가 발생한 원인과 위치를 찾기가 쉬워진다.
• 오류 메시지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름과 시패 유형도 언급한다. 애플리케이션이 로깅 기능을 사용한다면 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨준다.

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

• 오류를 분류하는 방법은 수없이 많다.
  • 오류를 발생한 위치로 분류 (e.g. 오류가 발생한 컴포넌트로 분류)
  • 유형으로 분류 (e.g. 디바이스 실패, 네트워크 실패, 프로그래밍 오류 등으로 분류)
• 하지만 애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.
• 외부 API를 사용할 때는 감싸기(wrapper) 기법이 최선이다.
  • 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 나중에 다른 라이브러리로 갈아타도 비용이 적다.
  • 감싸기 클래스에서 외부 API를 호출하는 대신 테스트 코드를 넣어주는 방법으로 프로그램을 테스트하기도 쉬워진다.
  • 특정 업체가 API를 설계한 방식에 발목 잡히지 않는다. 프로그램이 사용하기 편리한 API를 정의하면 그만이다.
• 예외 클래스에 포함된 정보로 오류를 구분해도 괜찮은 경우 예외 클래스가 하나만 있어도 충분하다.
• 한 예외는 잡아내고 다른 예외는 무시해도 괜찮은 경우라면 여러 예외 클래스를 사용한다.

정상 흐름을 정의하라

• 외부 API를 감싸 독자적인 예외를 만들고 코드 위에 처리기를 정의해 중단된 계산을 한다. 대개는 멋진 처리 방식이지만 때로는 중단이 적합하지 않은 때도 있다.

null을 반환하지 마라

• 한 줄 건너 하나씩 null을 확인하는 코드로 가득한 애플리케이션을 지금까지 수 없이 많다. 이런 코드는 나쁜 코드다. null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다. 누구 하나라도 null확인을 빼먹는다면 애플리케이션이 통제 불능에 빠질지도 모른다.
• 메서드에서 null을 반환하는 대신 예외를 던지거나 특수 사례 객체를 반환한다. 사용하려는 외부 API가 null을 반환한다면 감싸기 메서드를 구현해 예외를 던지거나 특수 사례 객체를 반환하는 방식을 고려한다.

null을 전달하지 마라

• 메서드에서 null을 반환하는 방식도 나쁘지만 메서드로 null을 전달하는 방식은 더 나쁘다. 정상적인 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드는 최대한 피한다.
• 대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다. 그렇다면 애초에 null을 넘기지 못하도록 금지하는 정책이 합리적이다. 즉, 인수로 null이 넘어오면 코드에 문제가 있다는 말이다. 이런 정책을 따르면 그만큼 부주의한 실수를 저지를 확률도 작아진다.

결론

• 깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다. 이 둘은 상충하는 목표가 아니다.
• 오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다.
• 오류 처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지며 코드 유지보수성도 크게 높아진다.

 

🤔 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.

• 객체 지향 언어를 제대로 공부하지 않아서 모르는 부분이 많다. 공부를 하고 다시 읽어보면 좀 더 발전할 수 있을 거라고 생각한다. 꼭 다시 읽어봐야겠다.

 

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• Try-Catch-Finally 문부터 작성하라
  • 코드 부분
• 미확인(unchecked) 예외를 사용하라
  • 확인된 예외란?
• 정상 흐름을 정의하라
  • 특수 사례 패턴(Special case pattern)
• null을 반환하지 마라
  • 특수 사례 객체