로버트 C.마틴의 클린 코드를 읽고 정리한 포스트입니다.
주석
C1: 부적절한 정보
다른 시스템에 (소스 코드 관리 시스템, 버그 추적 시스템, 이슈 추적 시스템, 기타 기록 관리 시스템 등) 저장할 정보는 주석으로 적절하지 못하다.
- 변경 이력: 장황한 날짜와 따분한 내용으로 소스 코드만 번잡하게 만든다.
- 작성자, 최종 수정일, SPR(Softward Problem Report) 번호 등과 같은 메타 정보만 주석으로 넣는다.
- 주석은 코드와 설계에 기술적인 설명을 부연하는 수단이다.
C2: 쓸모 없는 주석
오래된 주석, 엉뚱한 주석, 잘못된 주석은 더 이상 쓸모가 없다. 주석은 빨리 낡는다. 쓸모 없어질 주석은
- 아예 달지 않는 편이 가장 좋다.
- 빨리 삭제해라.
- 일단 들어가고 나면 코드에서 쉽게 멀어진다.
- 코드와 무관하게 혼자서 따로 놀며 코드를 그릇된 방향으로 이끈다.
C3: 중복된 주석
코드만으로 충분한데 구구절절 설명하는 주석이 중복된 주석이다. 예시
i ++; // i 증가
달랑 함수 서명만 기술하는 Javadoc
/**
* @param sellRequest
* @return
* @throws ManagedComponentException
*/
public SellResponse beginSellItem(SellRequest sellRequest)
throws ManagedComponentException
주석은 코드만으로 다하지 못하는 설명을 부언해야 한다.
C4: 성의 없는 주석
작성할 가치가 있는 주석은 잘 작성할 가치도 있다. 주석을 달거면 최대한 멋지게 작성하자. 단어도 신중하게 고르자. 문법과 구두점을 올바로 사용하고 주절대지 말자. 당연한 소리도 금물이다. 간결하고 명료하게 작성해라.
C5: 주석 처리된 코드
코드를 읽다가 주석으로 처리된 코드가 줄줄이 나오면 신경이 아주 거슬린다. 얼마나 오래된 코드인지, 중요한 코드인지 아닌지, 알 길이 없다. 그럼에도 아무도 삭제하지 않는다. 누군가에게 필요하거나 다른 사람이 사용할 코드라 생각하기 때문이다.
그렇게 코드는 낡아간다. 더 이상 존재하지 않는 함수를 호출한다. 이름이 바뀐 변수를 사용한다. 더 이상 사용하지 않는 표기법을 따른다. 자신이 포함된 모듈을 오염시킨다. 읽는 사람을 헷갈리게 만든다. 주석으로 처리된 코드는 흉물 그 자체다.
주석으로 처리된 코드를 발견하면 즉각 지워버려라! 걱정할 필요 없다. 소스 관리 시스템이 기억하니까. 누군가 정말 필요하다면 이전 버전을 가져오면 되니까. 주석으로 처리된 코드를 내버려 두지 마라.
환경
E1: 여러 단계로 빌드해야 한다
빌드는 간단히 한 단계로 끝나야 한다. 소스 코드 관리 시스템에서 이것저것 따로 체크아웃할 필요가 없어야 한다. 불가해한 명령이나 스크립트를 잇달아 실행해 각 요소를 따로 빌드할 필요가 없어야 한다. 온갖 JAR 파일, XML 파일, 명령으로 전체를 체크아웃해서 한 명령으로 빌드할 수 있어야 한다.
E2: 여러 단계로 테스트해야 한다
모든 단위 테스트는 한 명령으로 돌려야 한다. IDE에서 버튼 하나로 모든 테스트를 돌린다면 가장 이상적이다. 아무리 열악한 환경이라도 셸에서 명령 하나로 가능해야 한다. 모든 테스트를 한 번에 실행하는 능력은 아주 근본적이고 아주 중요하다. 따라서 그 방법이 빠르고, 쉽고, 명백해야 한다.
함수
F1: 너무 많은 인수
함수에서 인수 개수는 작을수록 좋다. 아예 없으면 가장 좋다. 다음으로 하나, 둘, 셋이 차례로 좋다. 넷 이상은 그 가치가 아주 의심스러우므로 최대한 피한다.
F2: 출력 인수
출력 인수는 직관을 정면으로 위배한다. 일반적으로 독자는 인수를 (출력이 아니라) 입력으로 간주한다. 함수에서 뭔가의 상태를 변경해야 한다면 (출력 인수를 쓰지 말고) 함수가 속한 객체의 상태를 변경한다.
F3: 플래그 인수
boolean 인수는 함수가 여러 기능을 수행한다는 명백한 증거다. 플래그 인수는 혼란을 초래하므로 피해야 마땅하다.
F4: 죽은 함수
아무도 호출하지 않는 함수는 삭제한다. 과감하게.
일반
G1: 한 소스 파일에 여러 언어를 사용한다
오늘날 프로그래밍 환경은 한 소스 파일 내에서 다양한 언어를 지원한다. 좋게 말하면 혼란스럽고, 나쁘게 말하면 조잡하다.
이상적으로는 소스 파일 하나에 언어 하나만 사용하는 방식이 가장 좋다. 현실적으로는 여러 언어가 불가피하다. 하지만 각별한 노력을 기울여 소스 파일에서 언어 수와 범위를 최대한 줄이도록 애써야 한다.
G2: 당연한 동작을 구현하지 않는다
최소 놀람의 원칙(The Principle of Least Surprise2)에 의거해 함수나 클래스는 다른 프로그래머가 당연하게 여길 만한 동작과 기능을 제공해야 한다. 예를 들어, 요일 문자열에서 요일을 나타내는 enum으로 변환하는 함수를 살펴보자.
Day day = DayDate.StringToDay(String dayName);
우리는 한수가 ‘Monday’를 Day.MONDAY로 변환하리라 기대한다. 또한 일반적으로 쓰는 요일 약어도 올바로 변환하리라 기대한다. 대소문자는 당연히 구분하지 않으리라 기대한다.
당연한 동작을 구현하지 않으면 코드를 읽거나 사용하는 사람이 더 이상 함수 이름만으로 함수 기능을 직관적으로 예상하기 어렵다. 저자를 신뢰하지 못하므로 코드를 일일이 살펴야 한다.
G3: 경계를 올바로 처리하지 않는다
코드는 올바로 동작해야 한다. 너무나도 당연한 말이다. 흔히 개발자들은 머릿속에서 코드를 돌려보고 끝낸다. 자신의 직관에 의존할 뿐 모든 경계와 구석진 곳에서 코드를 증명하려 애쓰지 않는다.
부지런함을 대신할 지름길은 없다. 모든 경계 조건, 모든 구석진 곳, 모든 기벽, 모든 예외는 우아하고 직관적인 알고리즘을 좌초시킬 암초다. 스스로의 직관에 의존하지 마라. 모든 경계 조건을 찾아내고, 모든 경계 조건을 테스트하는 테스트 케이스를 작성하라.
G4: 안전 절차 무시
안전 절차를 무시하면 위험하다. 컴파일러 경고를 꺼버리면 빌드가 쉬워질지 모르지만 자칫하면 끝없는 디버깅에 시달린다. 실패하는 테스트 케이스를 일단 제껴두고 나중으로 미루는 태도는 신용카드가 공짜 돈이라는 생각만큼 위험하다.
G5: 중복
론 제프리스는 이 규칙을 “모든 테스트를 통과한다”는 규칙 다음으로 중요하게 꼽았다.
코드에서 중복을 발견할 때마다 추상화할 기회로 간주하라. 중복된 코드를 하위 루틴이나 다른 클래스로 분리하라. 이렇듯 추상화로 중복을 처리하면 설계 언어의 어휘가 늘어난다. 다른 프로그래머들이 그만큼 어휘를 사용하기 쉬워진다. 추상화 수준을 높였으므로 구현이 빨라지고 오류가 적어진다.
가장 뻔한 유형은 똑같은 코드가 여러 차례 나오는 중복이다. 프로그래머가 미친듯이 마우스로 긁어다 여기저기로 복사한 듯이 보이는 코드다. 이런 중복은 간단한 함수로 교체한다.
좀 더 미묘한 유형은 여러 모듈에서 일련의 switch/case나 if/else 문으로 똑같은 조건을 거듭 확인하는 중복이다. 이런 중복은 다형성(polymorphism)으로 대체해야 한다.
더더욱 미묘한 유형은 알고리즘이 유사하나 코드가 서로 다른 중복이다. 중복은 중복이므로 TEMPLATE METHOD 패턴이나 STRATEGY 패턴으로 중복을 제거한다.
G6: 추상화 수준이 올바르지 못하다
추상화는 저차원 상세 개념에서 고차원 일반 개념을 분리한다. 때로 우리는 (고차원 개념을 표현하는) 추상 클래스와 (저차원 개념을 표현하는) 파생 클래스를 생성해 추상화를 수행한다. 추성화로 개념을 분리할 때는 철저해야 한다. 모든 저차원 개념은 파생 클래스에 넣고, 모든 고차원 개념은 기초 클래스에 넣는다.
예를 등러, 세부 구현과 관련한 상수, 유틸리티 함수는 기초 클래스에 넣으면 안 된다. 기초 클래스는 구현 정보에 무지해야 마땅하다.
소스 파일, 컴포넌트, 모듈도 마찬가지다. 우수한 소프트웨어 설계자는 개념을 다양한 차원으로 분리해 다른 컨테이너에 넣는다. 때로는 기초 클래스와 파생 클래스로 분리하도, 때로는 소스파일과 모듈과 컴포넌트로 분리한다. 어느 경우든 철저히 분리해야 한다. 고차원 개념과 저차원 개념을 섞어서는 안 된다.
잘못된 추상화 수준은 거짓말이나 꼼수로 해결하지 못한다. 추상화는 소프트웨어 개발자에게 가장 어려운 작업 중 하나다. 잘못된 추상화를 임시변통으로 고치기는 불가능하다.
G7: 기초 클래스가 파생 클래스에 의존한다
개념을 기초 클래스와 파생 클래스로 나누는 가장 흔한 이유는 고차원 기초 클래스 개념을 저차원 파생 클래스 개념으로부터 분리해 독립성을 보장하기 위해서다. 그로므로 기초 클래스가 파생 클래스를 사용한다면 뭔가 문제가 있다는 말이다. 일반적으로 기초 클래스는 파생 클래스를 아예 몰라야 마땅하다.
G8: 과도한 정보
잘 정의된 모듈은 인터페이스가 아주 작다. 하지만 작은 인터페이스로도 많은 동작이 가능하다. 부실하게 정의된 모듈은 인터페이스가 아주 구질구질하다. 그래서 간단한 동작 하나에도 온갖 인터페이스가 필요하다. 잘 정의된 인터페이스는 많은 함수를 제공하지 않는다. 그래서 결합도(Coupling)가 낮다. 부실하게 정의된 인터페이스는 반드시 호출해야 하는 온갖 함수를 제공한다. 그래서 결합도가 높다.
우수한 소프트웨어 개발자는 클래스나 모듈 인터페이스에 노출할 함수를 제한할 줄 알아야 한다. 클래스가 제공하는 메서드 수는 작을수록 좋다. 함수가 아닌 변수 수도 작을수록 좋다. 클래스에 들어있는 인스턴스 변수 수도 작을수록 좋다.
자료를 숨겨라. 유틸리티 함수를 숨겨라. 상수와 임시 변수를 숨겨라. 메서드나 인스턴스 변수가 넘쳐나는 클래스는 피하라. 하위 클래스에서 필요하다는 이유로 protected 변수나 함수를 마구 생성하지 마라. 인터페이스를 매우 작게 그리고 매우 깐깐하게 만들어라. 정보를 제한해 결합도를 낮춰라.
G9: 죽은 코드
죽은 코드를 발견하면 시스템에서 제거하라. 아무도 호출하지 않는 유틸리티 함수, 불가능한 조건을 확인하는 if문, throw 문이 없는 try 문에서 catch 블록, switch/case 문에서 불가능한 case 조건이 좋은 예다.
G10: 수직 분리
변수와 함수는 사용되는 위치에 가깝게 정의한다. 지역 변수는 처음으로 사용하기 직전에 선언하며 수직으로 가까운 곳에 위치해야 한다. 선언한 위치로부터 몇백 줄 아래에서 사용하면 안 된다.
비공개 함수는 처음으로 호출한 직후에 정의한다. 비공개 함수는 전체 클래스 범위에 속하지만 그래도 정의하는 위치와 호출하는 위치를 가깝게 유지한다. 비공개 함수는 처음으로 호출되는 위치를 찾은 후 아래로 내려가면 쉽게 눈에 띄어야 한다.
G11: 일관성 부족
어떤 개념을 특정 방식으로 구현했다면 유사한 개념도 같은 방식으로 구현한다. 앞서 언급한 ‘최소 놀람의 원칙(The Principle of Least Surprise)’에도 부합한다. 표기법은 신중하게 선택하며, 일단 선택한 표기법은 신중하게 따른다.
한 함수에서 response라는 변수에 HttpServletResponse 인스턴스를 저장했다면 (HttpServletResponse 객체를 사용하는) 다른 함수에서도 일관성 있게 동일한 변수 이름을 사용한다.
착식하게 적용한다면 이처럼 간단한 일관성만으로도 코드를 읽고 수정하기가 대단히 쉬워진다.
G12: 잡동사니
비어 있는 기본 생성자가 왜 필요한가? 쓸데없이 코드만 복잡하게 만든다. 아무도 사용하지 않는 변수, 아무도 호출하지 않는 함수, 정보를 제공하지 못하는 주석 등이 좋은 예다. 모두가 코드만 복잡하게 만들 뿐이므로 제거해야 마땅하다. 소스 파일은 언제나 깔끔하게 정리하라.
G13: 인위적 결합
서로 무관한 개념을 인위적으로 결합하지 않는다. 예를 들어, 일반적인 enum은 특정 클래스에 속할 이유가 없다. enum이 클래스에 속한다면 enum을 사용하는 코드가 특정 클래스를 알아야만 한다. 범용 static 함수도 마찬가지로 특정 클래스에 속할 이유가 없다.
일반적으로 인위적인 결합은 직접적인 상호작용이 없는 두 모듈 사이에서 일어난다. 뚜렷한 목적 없이 변수, 상수, 함수를 당장 편한 위치에 (물론 잘못된 위치에) 넣어버린 결과다. 게으르고 부주의한 행동이다.
함수, 상수, 변수를 선언할 때는 시간을 들여 올바른 위치를 고민한다. 그저 당장 편한 곳에 선언하고 내버려두면 안 된다.
G14: 기능 욕심
클래스 메서드는 자기 클래스의 변수와 함수에 관심을 가져야지 다른 클래스의 변수와 함수에 관심을 가져서는 안 된다. 메서드가 다른 객체의 참조자와 변경자를 사용해 그 객체 내용을 조작한다면 메서드가 그 객체 클래스의 범위를 욕심내는 탓이다.
G15: 선택자 인수
선택자 인수는 큰 함수를 작은 함수 여럿으로 쪼개지 않으려는 게으름의 소산이다. 부울 변수를 인수로 받는 것 뿐만 아니라 enum, int 등 함수 동작을 제어하려는 인수는 하나 같이 바람직하지 않다. 일반적으로, 인수를 넘겨 동작을 선택하는 대신 새로운 함수를 만드는 편이 좋다.
G16: 모호한 의도
코드를 짤 때는 의도를 최대한 분명히 밝힌다. 행을 바꾸지 않고 표현한 수식, 헝가리식 표기법, 매직 번호 등은 모두 저자의 의도를 흐린다.
G17: 잘못 지운 책임
소프트웨어 개발자가 내리는 가장 중요한 결정 중 하나가 코드를 배치하는 위치다.
여기서도 ‘최소 놀람의 원칙(The Principle of Least Surprise)’을 적용한다. 코드는 독자가 자연스럽게 기대할 위치에 배치한다.
때로는 개발자가 ‘영리하게’ 기능을 배치한다. 독자에게 직관적인 위치가 아니라 개발자에게 편한 함수에 배치한다. 예를 들어, 직원이 근무한 총 시간을 보고서로 출력하는 함수가 필요하다. 보고서를 출력하는 함수에서 총계를 계산하는 방법이 있다. 아니면 근무 시간을 입력 받는 코드에서 총계를 보관하는 방법이 있다.
결정을 내리는 한 가지 방법으로, 함수 이름을 살펴본다. 예를 들어, 보고서 모듈에 getTotalHours라는 함수가 있다 가정하자. 근무 시간을 입력 받는 모듈에 saveTimeCard라는 함수가 있다고 가정하자. 이름만 보았을 때 두 함수 중 어느 쪽이 총계를 계산해야 옳을까? 답은 명백하다.
떄로 성능을 높이고자 근무 시간을 입력 받는 모듈에서 총계를 계산하는 편이 좋다고 판단할 수도 있다. 그래도 괜찮지만, 그러려면 이런 사실을 반영해 함수 이름을 제대로 지어야 한다. 예를 들어, 근무 시간을 입력 받는 모듈에 computeRunningTotalOfHours 함수를 만든다.
G18: 부적절한 static 함수
Math.max(double a, double b)는 좋은 static 메서드다. 특정 인스턴스와 관련된 기능이 아니다. new Math().max(a, b)나 a.max(b)라고 하면 오히려 우습다. max 메서드가 사용하는 정보는 두 인수가 전부다. 메서드를 소유하는 객체에서 가져오는 정보가 아니다. 결정적으로 Math.max 메서드를 재정의(override)할 가능성은 거의 아니 전혀 없다.
그런데 간혼 우리는 static으로 정의하면 안되는 함수를 static으로 정의한다.
HourlyPayCalculator.calculatePay(employee, overtimeRate);
언뜻 보면 static 함수로 여겨도 적당하다. 특정 객체와 관련이 없으면서 모든 정보를 인수에서 가져오니까. 하지만 함수를 재정의할 가능성이 존재한다. 수당을 계산하는 알고리즘이 여러 개일지도 모른다. 예를 들어, OvertimeHourlyPayCalculator와 StraightTimeHourlyPayCalculator를 분리하고 싶을지도 모른다.
그러므로 위 함수는 static 함수로 정의하면 안 된다. Employee 클래스에 속하는 인스턴스 함수여야 한다.
일반적으로 static 함수보다 인스턴스 함수가 더 좋다. 조금이라도 의심스럽다면 인스턴스 함수로 정의한다. 반드시 static 함수로 정의해야겠다면 재정의할 가능성은 없는지 꼼꼼히 따져본다.
G19: 서술적 변수
프로그램 가독성을 높이는 가장 효과적인 방법 중 하나가 계산을 여러 단계로 나누고 중간 값으로 서술적인 변수 이름을 사용하는 방법이다.
Matcher match = headerPattern.matcher(line);
if(match.find())
{
String key = match.group(1);
String value = match.group(2);
headers.put(key.toLowerCase(), value);
}
위 코드에서 사용한 String형 key, value 변수처럼 서술적인 이름을 사용한 덕분에 첫 번째로 일치하는 그룹이 키이고 두 번째로 일치하는 그룹이 값이라는 사실이 명확히 드러난다.
서술적인 변수 이름은 많이 써도 괜찮다. 일반적으로는 많을수록 더 좋다. 계산을 몇 단계로 나누고 중간값에 좋은 변수 이름만 붙여도 해독하기 어렵던 모듈이 읽기 쉬운 모듈로 탈바꿈한다.
G20: 이름과 기능이 일치하는 함수
이름만으로 분명하지 않기에 구현을 살피거나 문서를 뒤적여야 한다면 더 좋은 이름으로 바꾸거나 아니면 더 좋은 이름을 붙이기 쉽도록 기능을 정리해야 한다.
G21: 알고리즘을 이해하라
대다수 괴상한 코드는 사람들이 알고리즘을 충분히 이해하지 않은 채 코드를 구현한 탓이다. 코드가 ‘돌아간다’고 말하기는 뭔가 부족하다.
구현이 끝났다고 선언하기 전에 함수가 돌아가는 방식을 확실히 이해하는지 확인하라. 테스트 케이스를 모두 통과한다는 사실만으로 부족하다. 작성자가 알고리즘이 올바르다는 사실을 알아야 한다.
알고리즘이 올바르다는 사실을 확인하고 이해하려면 기능이 뻔히 보일 정도로 함수를 깔끔하고 명확하게 재구성하는 방법이 최고다.
G22: 논리적 의존성은 물리적으로 드러내라
한 모듈이 다른 모듈에 의존한다면 물리적인 의존성도 있어야 한다. 논리적인 의존성만으로는 부족하다. 의존하는 모듈이 상대 모듈에 대해 뭔가를 가정하면(즉, 논리적으로 의존하면) 안 된다. 의존하는 모든 정보를 명시적으로 요청하는 편이 좋다.
상수를 사용하는 대신 get~()함수를 호출하도록 논리적인 의존성을 물리적인 의존성으로 변경해라.
G23: If/Else 혹은 Switch/Case 문보다 다형성을 사용하라
첫째, 대다수 개발자가 switch 문을 사용하는 이유는 그 상황에서 가장 올바른 선택이기보다는 당장 손쉬운 선택이기 때문이다. 그러므로 switch를 선택하기 전에 다형성을 먼저 고려하라는 의미다.
둘째, 유형보다 함수가 더 쉽게 변하는 경우는 극히 드물다. 그러므로 모든 switch문을 의심해야 한다.
G24: 표준 표기법을 따르라
팀은 업계 표준에 기반한 구현 표준을 따라야 한다. 구현 표준은 인스턴스 변수 이름을 선언하는 위치, 클래스/메서드/변수 이름을 정하는 방법, 괄호를 넣은 위치 등을 명시해야 한다. 표준을 설명하는 문서는 코드 자체로 충분해야 하며 별도 문서를 만들 필요는 없어야 한다.
팀이 정한 표준은 팀원들 모두가 따라야 한다. 실제 괄호를 넣는 위치는 중요하지 않다. 모두가 동의한 위치에 넣는다는 사실이 중요하다. 이 사실을 이해할 정도로 팀원들이 성숙해야 한다.
G25: 매직 숫자는 명명된 상수로 교체하라
코드에서 숫자를 사용하지 말라는 규칙이다. 숫자는 명명된 상수 뒤로 숨기라는 의미다.
G26: 정확하라
검색 결과 중 첫 번째 결과만 유일한 결과로 간주하는 행동은 순진하다. 가능성이 희박하다고 잠금과 트랜잭션 관리를 건너뛰는 행동은 아무리 잘 봐줘도 게으름이다. List로 선언한 변수를 ArrayList로 선언하는 행동은 지나친 제약이다. 모든 변수를 protected로 선언한 코드는 무절제하다.
코드에서 뭔가를 결정할 때는 정확히 결정한다. 결정을 내리는 이유와 예외를 처리할 방법을 분명히 알아야 한다. 대충 결정해서는 안 된다. 호출하는 함수가 null을 반환할지도 모른다면 null을 반드시 점검한다. 조회 결과가 하나뿐이라 짐작한다면 하나인지 확실히 확인한다. 통화를 다뤄야 한다면 정수를 사용하고 반올림을 올바로 처리한다. 병행 특성으로 인해 동시에 갱신할 가능성이 있다면 적절한 잠금 매커니즘을 구현한다.
코드에서 모호성과 부정확은 의견차나 게으름의 결과다. 어느 쪽이든 제거해야 마땅하다.
G27: 관례보다 구조를 사용하라
설게 결정을 강제할 때는 규칙보다 관례를 사용한다. 명명 관례도 좋지만 구조자체로 강제하면 더 좋다.
G28: 조건을 캡슐화하라
부울 논리는 (if나 while문에다 넣어 생각하지 않아도) 이해하기 어렵다. 조건의 의도를 분명히 밝히는 함수로 표현하라. 예를 들면,
if (shouldBeDeleted(timer))
라는 코드는 아래 코드보다 좋다.
if (timer.hasExpired() && !timer.isRecurrent())
G29: 부정 조건은 피하라
부정 조건은 긍정 조건보다 이해하기 어렵다. 가능하면 근정 조건으로 표현한다. 예를 들면,
if (buffer.shouldCompact())
라는 코드는 아래 코드보다 좋다.
if (!buffer.shouldNotCompact())
G30: 함수는 한 가지만 해야 한다
두 가지 이상의 일을 하는 함수는 잘개 쪼개야 한다.
G31: 숨겨진 시간적인 결합
때로는 시간적인 결합이 필요하다. 하지만 시간적인 결합을 숨겨서는 안 된다. 함수를 짤 때는 함수 인수를 적절히 배치해 함수가 호출되는 수너를 명백히 드러낸다.
함수의 순서를 바꾸면 문제가 되면 안되므로 시간적인 복잡성을 드러내는 한이 있어도 강제해야 한다. 예를 들면,
public class MoogDiver {
Gradient gradient;
List<Spline> splines;
public void dive(String reason) {
Gradient gradient = saturateGradient();
List<Spline> splines = reticulateSplines(gradient);
diveForMoog(splines, reason);
}
...
}
라는 코드는 아래 코드보다 좋다.
public class MoogDiver {
Gradient gradient;
List<Spline> splines;
public void dive(String reason) {
saturateGradient();
reticulateSplines(gradint);
diveForMoog(reason);
}
...
}
G32: 일관성을 유지하라
코드 구조를 잡을 때는 이유를 고민하라. 그리고 그 이유를 코드 구조로 명백히 표현하라. 구조에 일관성이 없어 보인다면 남들이 맘대로 바꿔도 괜찮다고 생각한다. 시스템 전반에 걸쳐 구조가 일관성이 있다면 남들도 일관성을 따르고 보존한다.
G33: 경계 조건을 캡슐화하라
경계 조건은 빼먹거나 놓치기 십상이다. 경계 조건은 한 곳에서 별도로 처리한다. 코드 여기저기에서 처리하지 않는다. 다시 말해, 코드 여기저기에 +1이나 -1을 흩어놓지 않는다. 예를 들면,
int nextLevel = level + 1;
if (nextLevel < tags.length)
{
parts = new Parse(body, tags, nextLevel, offset + engTag);
body = null;
}
라는 코드는 아래 코드보다 좋다.
if (level + 1 < tags.length)
{
parts = new Parse(body, tags, level + 1, offset + engTag);
body = null;
}
G34: 함수는 추상화 수준을 한 단계만 내려가야 한다
함수 내 모든 문장은 추상화 수준이 동일해야 한다. 그리고 그 추상화 수준은 함수 이름이 의미하는 작업보다 한 단계만 낮아야 한다.
G35: 설정 정보는 최상위 단계에 둬라
추상화 최상위 단계에 둬야 할 기본값 상수나 설정 관련 상수를 저차원 함수에 숨겨서는 안 된다. 대신 고차원 함수에서 저차원 함수를 호출할 때 인수로 넘긴다.
G36: 추이적 탐색을 피하라
일반적으로 한 모듈은 주변 모듈을 모를수록 좋다. 좀 더 구체적으로, A가 B를 사용하고 B가 C를 사용한다 하더라도 A가 C를 알아야 할 필요는 없다는 뜻이다.
이를 디미터의 법칙(Law of Demeter)이라 부른다. 실용주의 프로그래머들은 ‘부끄럼 타는 코드 작성’이라고도 한다. 무엇이라 부르든 요지는 자신이 직접 사용하는 모듈만 알아야 한다는 뜻이다. 내가 아는 모듈이 연이어 자신이 아는 모듈을 따라가며 시스템 전체를 휘저을 필요가 없다는 의미다.
여러 모듈에서 a.getB().getC()라는 형태를 사용한다면 설계와 아키텍처를 바꿔 B와 C사이에 Q를 넣기가 쉽지 않다. a.getB().getC()를 모두 찾아 a.getB().getQ().getC()로 바꿔야 하니까. 너무 많은 모듈이 아키텍처를 너무 많이 안다. 그래서 아키텍처가 굳어진다.
내가 사용하는 모듈이 내게 필요한 서비스를 모두 제공해야 한다. 원하는 메서드를 찾느라 객체 그래프를 따라 시스템을 탐색할 필요가 없어야 한다. 다시 말해, 다음과 같은 간단한 코드로 충분해야 한다.
myCollaborator.doSomething();
이름
N1: 서술적인 이름을 사용하라
이름은 성급하게 정하지 않는다. 대충 정하기게 이름은 너무나도 중요하다. 신중하게 선택한 이름은 추가 설명을 포함한 코드보다 강력하다. 독자는 이름을 보고 모듈 내 다른 함수가 하는 일을 짐작한다.
N2: 적절한 추상화 수준에서 이름을 선택하라
구현을 드러내는 이름은 피하라. 작업 대상 클래스나 함수가 위치하는 추상화 수준을 반영하는 이름은 선택하라. 코드를 볼때마다 추상화 수준이 너무 낮은 변수 이름을 발견하리라. 발견할 때마다 기회를 잡아 바꿔놓아야 한다. 예를 들면,
public interface Modem {
boolean connect(String connectionLocator);
boolean disconnect();
boolean send(char c);
char recv();
String getConnectedLocator();
}
라는 이름은 아래 이름보다 좋다. 연결 대상의 이름을 더 이상 전화번호로 제한하지 않으며 전화번호는 물론이고 다른 연결 방식에도 사용 가능하기 때문이다.
public interface Modem {
boolean dial(String phonNumber);
boolean disconnect();
boolean send(char c);
char recv();
String getConnectedPhoneNumber();
}
N3: 가능하다면 표준 명명법을 사용하라
관례가 있다면 따르는 것이 좋다. 특정 프로젝트에 적용할 표준을 고안했다면 프로젝트에 유효한 의미가 담긴 이름을 많이 사용할수록 독자가 코드를 이해하기 쉬워진다.
N4: 명확한 이름
함수나 변수의 목적을 명확이 밝히는 이름을 선택한다. 예를 들면,
private String renamePageAndOptionallyAllReferences() throws Exception {
...
}
라는 이름은 아래 이름보다 좋다. 길다는 단점을 서술성이 충분히 메꾼다.
아래 코드는 이름만 봐서는 함수가 하는 일이 분명하지 않다. 아주 광범위하며 모호하다. doRename 함수 안에 renamePage라는 함수가 있어 더더욱 모호하다.
private String doRename() throws Exception {
...
renamePage();
}
N5: 긴 범위는 긴 이름을 사용하라
이름 길이는 범위 길이에 비례해야 한다. 범위가 작으면 아주 짧은 이름을 사용해도 괜찮다. 하지만 범위가 길어지면 긴 이름을 사용한다.
범위가 5줄 안팎이라면 i나 j와 같은 변수 이름도 괜찮다. 다음은 전통적인 “볼링 게임”에서 가져온 코드다.
private void rollMany(int n, int pins)
{
for (int i=0; i<n; i++)
g.roll(pins);
}
여기서는 오히려 변수 i를 rollCount라고 썼다면 헷갈린다. 반면, 이름이 짧은 변수나 함수는 범위가 길어지면 의미를 잃는다. 그러므로 이름 범위가 길수록 이름을 정확하고 길게 짓는다.
N6: 인코딩을 피하라
이름에 유형 정보나 범위 정보를 넣어서는 안 된다. 오늘날 개발환경에서는 m_이나 f와 같은 접두어가 불필요하다. 프로젝트 이름이나 하위 시스템 이름에 (시각적 이미지 시스템이라는 뜻으로) vis_와 같은 접두어도 불필요하다. 중복된 정보이며 독자만 혼란하게 만든다. 오늘날 환경은 이름을 조작하지 않고도 모든 정보를 제공한다. 헝가리안 표기법의 오염에서 이름을 보호하라.
N7: 이름으로 부수 효과를 설명하라
함수, 변수, 클래스가 하는 일을 모두 기술하는 이름을 사용한다. 이름에 부수 효과를 숨기지 않는다. 여러 작업을 수행하는 함수에다 동사 하나만 달랑 사용하면 곤란하다.
테스트
T1: 불충분한 테스트
“이 정도면 충분하지 않을까”라는 척도를 사용해선 안 된다. 테스트 케이스는 잠재적으로 깨질 만한 부분을 모두 테스트해야 한다.
T2: 커버리지 도구를 사용하라!
커버리지 도구는 테스트가 빠뜨리는 공백을 알려준다. 커버리지 도구를 사용하면 테스트가 불충분한 모듈, 클래스, 함수를 찾기가 쉬워진다.
T3: 사소한 테스트를 건너뛰지 마라
T4: 무시한 테스트는 모호함을 뜻한다
때로는 요구사항이 불분명하기에 프로그램이 돌아가는 방식을 확신하기 어렵다. 불분명한 요구사항은 케이스를 주석으로 처리하거나 테스트 케이스에 @Ignore를 붙여 표현한다. 선택 기준은 모호함이 존재하는 테스트 케이스가 컴파일이 가능한지 불가능한지에 달려있다.
T5: 경계 조건을 테스트하라
경계 조건은 각별히 신경 써서 테스트한다. 알고리즘의 중앙 조건은 올바로 짜놓고 경계 조건에서 실수하는 경우가 흔하다.
T6: 버그 주변은 철저히 테스트하라
버그는 서로 모이는 경향이 있다. 한 함수에서 버그를 발견했다면 그 함수를 철저히 테스트하는 편이 좋다. 십중팔구 다른 버그도 발견하리라.
T7: 실패 패턴을 살펴라
때로는 테스트 케이스가 실패하는 패턴으로 문제를 진단할 수 있다. 합리적인 순서로 정렬된 꼼꼼한 테스트 케이스는 실패 패턴을 드러낸다.
T8: 테스트 커버리지 패턴을 살펴라
통과하는 테스트가 실행하거나 실행하지 않는 코드를 살펴보면 실패하는 테스트 케이스의 실패 원인이 드러난다.
T9: 테스트는 빨라야 한다
느린 테스트 케이스는 실행하지 않게 된다. 일정이 촉박하면 느린 테스트 케이스를 제일 먼저 건너뛴다. 그러므로 테스트 케이스가 빨리 돌아가게 최대한 노력한다.
Previous
‘[클린 코드 리뷰] 점진적인 개선 14장’ -> Previous