[클린 코드] 17장. 냄새와 휴리스틱

주석

• 코드를 읽으면서 나쁜 냄새와 기교 및 휴리스틱를 정리해보자.
• 1) 부적절한 정보
  주석은 코드와 설계에 기술적인 설명을 부연하는 수단이므로
  일반적으로 작성자, 최종 수정일, SPR 번호 등과 같은 메타 정보만 넣는다.
• 2) 쓸모 없는 주석
  오래된 주석, 엉뚱한 주석, 잘못된 주석은 더 이상 쓸모가 없다. 쓸모 없어진 주석은 재빨리 삭제하는 편이 가장 좋다.
• 3) 중복된 주석
  코드만으로 충분한데 구구절절 설명하는 주석인 중복된 주석은 필요 없다. 주석은 코드만으로 다하지 못하는 설명을 부언한다.
• 4) 성의 없는 주석
  주석을 달 참이라면 시간을 들여 최대한 멋지게 작성한다. 단어를 신중하게 선택하고 문법과 구두점을 올바로 사용한다.
  주절대지 않는다. 당연한 소리를 반복하지 않는다. 간결하고 명료하게 작성한다.
• 5) 주석 처리된 코드
  주석으로 처리된 코드는 얼마나 오래된 코드인지, 중요한 코드인지 아닌지, 알 길이 없다. 그럼에도 아무도 삭제하지 않는다.
  주석으로 처리된 코드를 발견하면 즉각 지워버려라! 걱정할 필요 없다. 소스 코드 관리 시스템이 기억하니까.

환경

• 1) 여러 단계로 빌드해야 한다.
  빌드는 간단히 한 단계로 끝나야 한다. 한 명령으로 전체를 체크아웃해서 한 명령으로 빌드할 수 있어야 한다.
• 2) 여러 단계로 테스트해야 한다.
  모든 단위 테스트는 한 명령으로 돌려야 한다. 모든 테스트를 한 번에 실행하는 능력은 아주 근본적이고 아주 중요하다.
  따라서 그 방법이 빠르고, 쉽고, 명백해야 한다.

함수

• 1) 너무 많은 인수
  함수에서 인수 개수는 작을수록 좋다. 아예 없으면 가장 좋다. 다음으로 하나, 둘, 셋이 차례로 좋다.
  넷 이상은 그 가치가 아주 의심스러우므로 최대한 피한다.
• 2) 출력 인수
  출력 인수는 직관을 정면으로 위배한다. 함수에서 무너가의 상태를 변경해야 한다면 함수가 속한 객체의 상태를 변경한다.
• 3) 플래그 인수
  boolean 인수는 함수가 여러 기능을 수행한다는 명백한 증거이다. 플래그 인수는 혼란을 초래하므로 피해야 마땅하다.
• 4) 죽은 함수
  아무도 호출하지 않는 함수는 삭제한다. 소스 코드 관리 시스템이 모두 기억하므로 걱정할 필요 없다.

일반

• 1) 한 소스 파일에 여러 언어를 사용한다.
  이상적으로는 소스 파일 하나에 언어 하나만 사용하는 방식이 가장 좋다.
  현실적으로는 여러 언어가 불가피하지만 각별한 노력을 기울여 소스 파일에서 언어 수와 범위를 최대한 줄이도록 애써야 한다.
• 2) 당연한 동작을 구현하지 않는다.
  최소 놀람의 원칙에 의거해 함수나 클래스는 다른 프로그래머가 당연하게 여길 만한 동작과 기능을 제공해야 한다.
  당연한 동작을 구현하지 않으면 코드를 읽거나 사용하는 사람이 함수 이름만으로 함수 기능을 직관적으로 예상하기 어려우므로
  저자를 신뢰하지 못하여 코드를 일일이 살펴야 한다.
• 3) 경계를 올바르게 처리하지 않는다.
  흔히 개발자들은 머릿속에서 코드를 돌려보고 직관에 의존할 뿐 모든 경계와 구석진 곳에서 코드를 증명하려 애쓰지 않는다.
  스스로의 직관에 의존하지 마라. 모든 경계 조건을 찾아내고, 모든 경계 조건을 테스트하는 테스트 케이스를 작성하라.
• 4) 안전 절차 무시
  실패하는 테스트 케이스를 일단 제껴두고 나중으로 미루는 태도는 신용카드가 공짜 돈이라는 생각만큼 위험하다.
• 5) 중복
  코드에서 중복을 발견할 때마다 추상화할 기회로 간주하라. 중복된 코드를 하위 루틴이나 다른 클래스로 분리하라.
  추상화로 중복을 정리하여 추상화 수준을 높이면 설계 언어의 어휘가 늘어나고 구현이 빨라지고 오류가 적어진다.
  또한 여러 모듈에서 일련의 switch/case나 if/else 문으로 똑같은 조건을 거듭 확인하는 중복의 경우 다형성으로 대체해야 한다.
  그 외에도 TEMPLATE METHOD 패턴이나 STRATEGY 패턴으로 중복을 제거한다.
• 6) 추상화 수준이 올바르지 못하다.
  추상화로 개념을 분리할 때는 철저해야 한다. 모든 저차원 개념은 파생 클래스에 넣고, 모든 고차원 개념은 기초 클래스에 넣는다.
  기초 클래스는 구현 정보에 무지해야 마땅하다. 
• 7) 기초 클래스가 파생 클래스에 의존한다.
  개념을 기초 클래스와 파생 클래스로 나누는 가장 흔한 이유는
  고차원 기초 클래스 개념을 저차원 파생 클래스 개념으로부터 분리해 독립성을 보장하기 위해서다.
  그러므로 기초 클래스가 파생 클래스를 사용한다면 문제가 있는 것이므로 기초 클래스는 파생 클래스를 아예 몰라야 마땅하다. 
  일반적으로 기초 클래스와 파생 클래스를 다른 JAR 파일로 배포하는 편이 좋다.
  기초 클래스와 파생 클래스를 다른 JAR 파일로 배포하면, 그리고 기초 JAR 파일이 파생 JAR 파일을 전혀 모른다면,
  독립적인 개별 컴포넌트 단위로 시스템을 배치할 수 있다. 만약 컴포넌트를 변경한다면 해당 컴포넌트만 다시 배치하면 된다.
  즉, 변경이 시스템에 미치는 영향이 아주 작아지므로 현장에서 시스템을 유지보수하기가 한결 수월하게 된다.
• 8) 과도한 정보
  잘 정의된 모듈은 인터페이스가 아주 작다. 하지만 작은 인터페이스로도 많은 동작이 가능하다.
  부실하게 정의된 모듈은 인터페이스가 구질구질하다. 그래서 간단한 동작 하나에도 온갖 인터페이스가 필요하다.
  잘 정의된 인터페이스는 많은 함수를 제공하지 않아 결합도가 낮다. 
  클래스가 제공하는 메서드 수는 작을수록 좋다. 함수가 아는 변수 수도 작을수록 좋다. 인스턴스 변수 수도 작을수록 좋다.
  정보를 제한해 결합도를 낮춰라.
• 9) 죽은 코드
  죽은 코드는 불가능하거나 아무도 호출하지 않아 실행되지 않는 코드를 가리키며 설계가 변해도 제대로 수정되지 않는다.
  죽은 코드를 발견하면 시스템에서 제거하라.
• 10) 수직 분리
  변수와 함수는 사용되는 위치에 가깝게 정의한다.
  지역 변수는 처음으로 사용하기 직전에 선언하며 수직으로 가까운 곳에 위치해야 한다.
  비공개 함수는 처음으로 호출한 직후에 정의한다. 
• 11) 일관성 부족
  어떤 개념을 특정 방식으로 구현했다면 유사한 개념도 같은 방식으로 구현한다.
  표기법은 신중하게 선택하며, 일단 선택한 표기법은 신중하게 따른다.
• 12) 잡동사니
  비어 있는 기본 생성자, 아무도 사용하지 않는 변수, 아무도 호출하지 않는 변수, 정보를 제공하지 못하는 주석 등은
  쓸데없이 코드만 복잡하게 만들 뿐이므로 제거해야 마땅하다. 소스 파일은 언제나 깔끔하게 정리하라! 
• 13) 인위적 결합
  서로 무관한 개념을 인위적으로 결합하지 않는다.
  뚜렷한 목적 없이 변수, 상수, 함수를 당장 편한 위치에 넣어버릴 경우 인위적인 결합이 일어난다.
  함수, 상수, 변수를 선언할 때는 시간을 들여 올바른 위치를 고민한다. 그저 당장 편한 곳에 선언하고 내버려두면 안 된다.
• 14) 기능 욕심
  클래스 메서드는 자기 클래스의 변수와 함수에 관심을 가져야지 다른 클래스의 변수와 함수에 관심을 가져서는 안된다.
• 15) 선택자 인수
  선택자 인수는 목적을 기억하기 어려울 뿐 아니라 각 선택자 인수가 여러 함수를 하나로 조합한다.
  선택자 인수는 큰 함수를 작은 함수 여럿으로 쪼개지 않으려는 게으름의 소산이다.
  일반적으로, 인수를 넘겨 동작을 선택하는 대신 새로운 함수를 만드는 편이 좋다.
• 16) 모호한 의도
  코드를 짤 때는 의도를 최대한 분명히 밝힌다.
  행을 바꾸지 않고 표현한 수식, 헝가리식 표기법, 매직 번호 등은 모두 저자의 의도를 흐린다.
• 17) 잘못 지운 책임
  코드는 독자가 자연스럽게 기대할 위치에 배치한다.
  때로는 개발자가 영리하게 기능을 배치한다. 독자에게 직관적인 위치가 아니라 개발자에게 편한 함수에 배치한다.
  그리고 이런 사실을 반영해 함수 이름을 제대로 지어야 한다.
• 18) 부적절한 static 함수
  간혹 우리는 static으로 정의하면 안 되는 함수를 static으로 정의한다. 조금이라도 의심스럽다면 인스턴스 함수로 정의한다.
  반드시 static 함수로 정의해야겠다면 재정의할 가능성은 없는지 꼼꼼히 따져본다.
• 19) 서술적 변수
  프로그램 가독성을 높이는 가장 효과적인 방법 중 하나가
  계산을 여러 단계로 나누고 중간 값으로 서술적인 변수 이름을 사용하는 방법이다.
  서술적인 변수 이름은 많이 써도 된다. 일반적으로는 많을수록 더 좋다.
• 20) 이름과 기능이 일치하는 함수
  이름만으로 분명하지 않기에 구현을 살피거나 문서를 뒤적여야 한다면 더 좋은 이름으로 바꾸거나
  아니면 더 좋은 이름을 붙이기 쉽도록 기능을 정리해야 한다.
• 21) 알고리즘을 이해하라.
  대다수 괴장한 코드는 사람들이 알고리즘을 충분히 이해하지 않은 채 코드를 구현한 탓이다.
  구현이 끝났다고 선언하기 전에 함수가 돌아가는 방식을 확실히 이해하는지 확인하라.
  테스트 케이스를 모두 통과한다는 사실만으로 부족하다. 작성자가 알고리즘이 올바르다는 사실을 알아야 한다.
  알고리즘이 올바르다는 사실을 확인하고 이해하려면 기능이 뻔히 보일 정도로 함수를 깔끔하고 명확하게 재구성한다.
• 22) 논리적 의존성은 물리적으로 드러내라.
  한 모듈이 다른 모듈에 의존한다면 물리적인 의존성도 있어야 한다. 논리적 의존성만으로는 부족하다.
  의존하는 모듈이 상대 모듈에 대한 뭔가를 가정하면 안 되며 의존하는 모든 정보를 명시적으로 요청하는 편이 좋다.
• 23) If/Else 혹은 Switch/Case 문보다 다형성을 사용하라.
  'switch 문 하나' 규칙을 따른다. 선택 유형 하나에는 switch 문을 한 번만 사용한다. 
  같은 선택을 수행하는 다른 코드에서는 다형성 객체를 생성해 switch 문을 대신한다.
• 24) 표준 표기법을 따르라.
  팀은 업계 표준에 기반한 구현 표준을 따라야 한다. 팀이 정한 표준은 팀원들 모두가 따라야 한다.
• 25) 매직 숫자는 명명된 상수로 교체하라.
  일반적으로 코드에서 숫자를 사용하지 마라. 숫자는 명명된 상수 뒤로 숨기라는 의미다.
  반면 어떤 상수는 이해하기 쉬우므로, 코드 자체가 자명하다면, 상수 뒤로 숨길 필요가 없다.
  '매직 숫자'라는 용어는 단지 숫자만 의미하지 않는다. 의미가 분명하지 않은 토큰을 모두 가리킨다.
• 26) 정확하라.
  코드에서 뭔가를 결정할 때는 정확히 결정한다. 결정을 내리는 이유와 예외를 처리할 방법을 분명히 알아야 한다.
  코드에서 모호성과 부정확은 의견차나 게으름의 결과다. 어느 쪽이든 제거해야 마땅하다.
• 27) 관례보다 구조를 사용하라.
  설계 결정을 강제할 때는 규칙보다 관례를 사용한다. 명명 관례도 좋지만 구조 자체를 강제하면 더 좋다.
• 28) 조건을 캡슐화하라.
  부울 논리는 이해하기 어렵다. 조건의 의도를 분명히 밝히는 함수로 표현하다.
• 29) 부정 조건은 피하라.
  부정 조건은 긍정 조건보다 이해하기 어렵다. 가능하면 긍정 조건으로 표현한다.
• 30) 함수는 한 가지만 해야 한다.
  한 가지만 수행하는 좀 더 작은 함수 여럿으로 나눠야 마땅하다.
• 31) 숨겨진 시간적인 결합
  때로는 시간적 결합이 필요하다. 하지만 시간적인 결합을 숨겨서는 안 된다.
  함수를 짤 때는 함수 인수를 적절히 배치해 함수가 호출되는 순서를 명백히 드러낸다.
  의도적으로 각 함수가 내놓는 결과를 다음 함수에 필요하도록 추가하면 구문적 복잡성이 원래 있던 시간적 복잡성을 드러낸다.
• 32) 일관성을 유지하라.
  코드 구조를 잡을 때는 이유를 고민하라. 그리고 그 이유를 코드 구조로 명백히 표현하라.
  시스템 전반에 걸쳐 구조가 일관성이 있다면 남들도 일관성을 따르고 보존한다.
• 33) 경계 조건을 캡슐화하라.
  경계 조건을 빼먹거나 놓치기 십상이다. 경계 조건은 한 곳에서 별도로 처리한다. 코드 여기저기에 처리하지 않는다.
  코드 여기저기에 +1이나 -1을 흩어놓지 않고 변수로 캡슐화하는 편이 좋다.
• 34) 함수는 추상화 수준을 한 단계만 내려가야 한다.
  함수 내 모든 문장은 추상화 수준이 동일해야 한다. 그리고 추상화 수준은 함수 이름이 의미하는 작업보다 한 단계만 낮아야 한다.
  뒤섞인 추상화 수준이 있다면 멋지게 분리한다. 추상화 수준 분리는 리팩터링을 수행하는 가장 중요한 이유 중 하나다.
  함수에서 추상화 수준을 분리하면 앞서 드러나지 않았던 새로운 추상화 수준이 드러나는 경우가 빈번하다.
• 35) 설정 정보는 최상위 단계에 둬라.
  추상화 최상위 단계에 둬아 할 기본값 상수나 설정 관련 상수를 저차원 함수에 숨겨서는 안 된다.
  대신 고차원 함수에서 저차원 함수를 호출할 때 인수로 넘긴다.
• 36) 추이적 탐색을 피하라.
  일반적으로 한 모듈은 주변 모듈을 모를수록 좋다. 자신이 직접 사용하는 모듈만 알아야 한다.
  A가 B를 사용하고 B가 C를 사용하더라도 A가 C를 알아야 할 필요가 없는 것을 디미터 법칙(부끄럼 타는 코드 작성)이라고 한다.
  내가 아는 모듈이 연이어 자신이 아는 모듈을 따라가며 시스템 전체를 휘저을 필요가 없다.

자바

• 1) 긴 import 목록을 피하고 와일드카드를 사용하라.
  패키지에서 클래스를 둘 이상 사용한다면 와일드카드를 사용해 패키지 전체를 가져오라.
  명시적인 import 문은 강한 의존성을 생성하지만 와일드카드는 그렇지 않다.
  명시적으로 클래스를 import하면 그 클래스가 반드시 존재해야 한다.
  하지만 와일드카드로 패지키를 지정하면 특정 클래스가 존재할 필요가 없다.
  import 문은 패키지를 단순히 검색 경로에 추가하므로 진정한 의존성이 생기지 않는다. 그러므로 모듈 간에 결합성이 낮아진다.
  만약 이름이 같으나 패키지가 다른 클래스가 있을 경우에는 코드에서 클래스를 사용할 때 전체 경로를 명시한다.
• 2) 상수는 상속하지 않는다.
  상수를 인터페이스에 넣은 다음 그 인터페이스를 상속해 해당 상수를 사용하면 안 된다. 언어의 범위 규칙을 송이를 행위다.
  대신 static import를 사용하라.
• 3) 상수 대 Enum
  public static final int라는 옛날 기교를 더 이상 사용할 필요가 없다. int는 코드에서 의미를 잃어버리기도 한다.
  반면 enum은 이름이 부여된 여거체에 속하므로 의미를 잃어버리지 않는다.

이름

• 1) 서술적인 이름을 사용하라.
  이름은 성급하게 정하지 않는다. 서술적인 이름을 신중하게 고른다. 
  소프트웨어 가독성의 90%는 이름이 결정한다. 그러므로 시간을 들여 현명한 이름을 선택하고 유효한 상태로 유지한다.
  신중하게 선택한 이름은 추가 설명을 포함한 코드보다 강력하다.
  신중하게 선택한 이름을 보고 독자는 모듈 내 다른 함수가 하는 일을 짐작한다.
• 2) 적절한 추상화 수준에서 이름을 선택하라.
  구현을 드러내는 이름은 피하라. 작업 대상 클래스나 함수가 위치하는 추상화 수준을 반영하는 이름을 선택하라.
  코드를 살펴볼 때마다 추상화 수준이 너무 낮은 변수 이름을 발견하리라. 발견할 때마다 기회를 잡아 바꿔놓아야 한다.
• 3) 가능하다면 표준 명명법을 사용하라.
  기존 명명법을 사용하는 이름은 이해하기 더 쉽다. 패턴은 한 가지 표준에 불과하므로 관계를 따르는 편이 좋다.
  또한 프로젝트에 유효한 의미가 담긴 이름을 많이 사용할수록 독자가 코드를 이해하기 쉬워진다.
• 4) 명확한 이름
  함수나 변수의 목적을 명확히 밝히는 이름을 선택한다. 이름이 길 경우의 단점은 서술성이 충분히 메꿀 수 있다.
• 5) 긴 범위는 긴 이름을 사용하라.
  이름 길이는 범위 길이에 비례해야 한다.
  범위가 작으면 아주 짧은 이름을 사용해도 괜찮다. 하지만 범위가 길어지면 긴 이름을 사용한다.
• 6) 인코딩을 피하라.
  이름에 유형 정보나 범위 정보를 넣어서는 안 된다. 오늘날 개발 환경에서는 이름 앞에 m_이나 f와 같은 접두어가 불필요하다.
  중복된 정보이며 독자만 혼란하게 만든다. 오늘날 환경은 이름을 조작하지 않고도 모든 정보를 제공한다.
  헝가리안 표기법의 오염에서 이름을 보호하라.
• 7) 이름으로 부수 효과를 설명하라.
  함수, 변수, 클래스가 하는 일을 모두 기술하는 이름을 사용한다. 이름에 부수 효과를 숨기지 않는다.
  
  

테스트

• 1) 불충분한 테스트
  테스트 케이스는 잠재적으로 깨질 만한 부분을 모두 테스트해야 한다.
  테스트 케이스가 확인하지 않는 조건이나 검증하지 않는 계산이 있다면 그 테스트는 불완전하다.
• 2) 커버리지 도구를 사용하라!
  커버리지 도구는 테스트가 빠뜨리는 공백을 알려준다. 
  커버리지 도구를 사용하면 테스트가 불충분한 모듈, 클래스, 함수를 찾기가 쉬워진다.
• 3) 사소한 테스트를 건너뛰지 마라.
  사소한 테스트는 짜기 쉽다. 사소한 테스트가 제공하는 문서적 가치는 구현에 드는 비용을 넘어선다.
• 4) 무시한 테스트는 모호함을 뜻한다.
  때로는 요구사항이 불분명하기에 프로그램이 돌아가는 방식을 확신하기 어렵다.
  불분명한 요구사항은 테스트 케이스를 주석으로 처리하거나 테스트 케이스에 @Ignore를 붙여 표현한다.
  선택 기준은 모호함이 존재하는 테스트 케이스가 컴파일이 가능한지 불가능한지에 달려있다.
• 5) 경계 조건을 테스트하라.
  경계 조건은 각별히 신경 써서 테스트한다.
• 6) 버그 주변은 철저히 테스트하라.
  버그는 서로 모이는 경향이 있다. 한 함수에서 버그를 발견했다면 그 함수를 철저히 테스트하는 편이 좋다.
• 7) 실패 패턴을 살펴라.
  때로는 테스트 케이스가 실패하는 패턴으로 문제를 전달할 수 있다.
  합리적인 순서로 정렬된 꼼꼼한 테스트 케이스는 실패 패턴을 드러낸다.
• 8) 테스트 커버리지 패턴을 살펴라.
  통과하는 테스트가 실행하거나 실행하지 않는 코드를 살펴보면 실패하는 테스트 케이스의 실패 원인이 드러난다.
• 9) 테스트는 빨라야 한다.
  느린 테스트 케이스는 실행하지 않게 된다. 그러므로 테스트 케이스가 빨리 돌아가게 최대한 노력한다.