반응형
『Clean Code(클린 코드) 애자일 소프트웨어 장인 정신 - 로버트 C. 마틴』 을 읽고 요약한 내용입니다.
오류 처리는 중요하다. 하지만 오류 처리 코드로 인해 프로그램 논리를 이해하기 어려워진다면 깨끗한 코드라 부르기 어렵다.
- 오류 코드보다 예외를 사용하라.
오류가 발생하면 예외를 던지는 편이 낫다. 그러면 호출다 코드가 더 깔끔해진다. 논리가 오류 처리 코드와 뒤섞이지 않으니까.
- try-catch-finally문부터 작성하라.
어떤 면에서 try 블록은 트랜젝션과 비슷하다. try블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지해야 한다. 그러므로 예외가 잘행할 코드를 짤 때는 try-catch-finally문으로 시작하는 편이 낫다. 그러면 try 블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의하기 쉬워진다.
- 미확인 unchecked 예외를 사용하라.
확인된 예외 checked exception는 OCP를 위반한다. 메서드에서 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메서드모두가 선언부에 해당 예외를 정의해야 한다. 즉, 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 한다는 말이다. 모듈과 관련된 코드가 전혀 바뀌지 않았더라도 (선언부가 바뀌었으므로) 모듈을 다시 빌드한 다음 배포해야 한다는 말이다.
throws 경로에 위치하는 모든 함수가 최하위 함수에서 던지는 예외를 알아야 하므로 캡슐화가 깨진다.
때로는 확인된 예외도 유용하다. 아주 중요한 라이브러리를 작성한다면 모든 예외를 잡아야 한다. 하지만 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.
- 예외에 의미를 제공하라
오류 메시지에 정보를 담아 예외와 함께 던진다. 실패한 연산 이름과 실패 유형도 언급한다. 애플리케이션이 로깅 기능을 사용한다면 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨준다.
호출자를 고려해 예외 클래스를 정의하라
애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.
외부API를 사용할 때는 감싸기 wrapper 기법이 최선이다. 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다. 나중에 다른 라이브러리로 갈아타도 비용이 적다.또한 테스트하기고 쉬워지며, 특정 업체가 설계한 방식에 발목잡히지 않는다.
- 정상 흐름을 정의하라
특수 사례 패턴 (special case pattern)
클래스를 만들거나 객체를 조작해 특수 사례를 처리하는 방식이다. 그러면 클라이언트 코드가 예외적인 상황을 처리할필요가 없어진다. 클래스나 객체가 예외적인 상황을 캡슐화해서 처리하므로.
- null을 반환하지 마라.
null을 반환하는 코드는 일거리를 늘릴 뿐만 아니라 호출자에게 문제를 떠넘긴다. 누구 하나라도 null 확인을 빼먹는다면 애플리케이션이 통제 불능에 빠질지도 모른다.
// bad
// 1. null 을 return 하는 경우
List<Employee> employees = getEmployee(); // getEmployee() 은 null을 리턴할 수 있다.
if (employees != null) {
for(Employee e : employees) {
totalPay += e.getPay();
}
}
// good
// 2. getEmployee()가 빈 List를 리턴하도록 하는 경우
List<Employee> employees = getEmployee();
for(Employee e : employees) {
totalPay += e.getPay();
}
// 3. Collections.emptyList()로 미리 정의된 읽기 전용 리스트를 리턴
public List<Employee> getEmployee() {
if( .. 직원이 없다면 .. ) {
return Collections.emptyList();
}
}
// 이렇게 코드를 변경하면 코드도 깔끔해질뿐더러 NullPointerException이 발생할 가능성도 줄어든다.
- null을 전달하지 마라
메서드로 null을 전달하는 방식은 더 나쁘다. 정상적인 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드는 최대한 피한다.
대다수 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하는 방법이 없다. 그럴다면 애초에 null을 넘기지못하도록 금지하는 정책이 합리적이다. 즉, 인수로 null이 넘어오면 코드에 문제가 있다는 말이다. 이런 정책을 따르면 그만큼 부주의한 실수를 저지를 확률도 작아진다.
- 결론
깨끗한 코드는 일기도 좋아야 하지만 안정성도 높아야 한다. 이 둘은 상충하는 목표가 아니아. 오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다. 오류 처리를 프로그램 논리와 분리하면 독립적인 추론이 가능해지며 코드 유지조수성도 크게 높아진다.
반응형