[클린코드] 16, 17장

마지막이다!

16장 SerialDate 리팩토링

• SerialDate는 날짜를 표현하는 자바 클래스이다.
• 이장 또한 책에 있는 코드와 함께 보면 좋을 것 같다

17장 냄새와 휴리스틱

📌 주석

C1 : 부적절한 정보

• 다른 시스템에 저장할 정보는 주석으로 적절하지 못하다.
• 주석은 코드와 설계에 기술적인 설명을 부연하는 수단이다.

C2: 쓸모 없는 주석

• 주석은 빨리 낡는다.
• 쓸모 없어질 주서은 아예 달지 않는 편이 좋다.

C3: 중복된 주석

• 코드만으로 충분한데 구구절절 설명하는 주석이 중복된 주석이다.

C4: 성의 없는 주석

• 작성할 가치가 있는 주석은 잘 작성할 가치도 있다.
• 단어를 신중하게 선택한다.
• 문법과 구두점을 올바로 사용한다.

C5: 주석 처리된 코드

• 주석으로 처리된 코드를 발견하면 즉각 지워버려라!
• 걱정할 필요 없다. 소스 코드 관리 시스템이 기억하니까.
• 누군가 정말로 필요하다면 이전 버전을 가져오면 된다.

📌 환경

E1: 여러 단계로 빌드해야 한다

• 빌드는 간단히 한 단계로 끝나야 한다.

E2: 여러 단계로 테스트해야 한다

• 모든 단위테스트는 한 명령으로 돌려야한다.
• 모든 테스트를 한 번에 실행하는 능력은 아주 근본적이고 아주 중요하므로 빠르고, 쉽고 명백해야 한다.

📌 함수

F1: 너무 많은 인수

• 함수에서 인수 개수는 작을수록 좋다.
• 아예 없으면 가장 좋다.

F2: 출력인수

• 출력 인수는 직관을 정면으로 위배한다.
• 함수에서 뭔가의 상태를 변경해야 한다면 함수가 속한 객체의 상태를 변경한다.

F3: 플래그 인수

• boolean 인수는 함수가 여러 기능을 수행한다는 명백한 증거다.
• 플래그 인수는 혼란을 초래 하므로 피해야 마땅하다.

F4: 죽은 함수

• 아무도 호출하지 않는 함수는 삭제한다.
• 죽은 코드는 낭비다. 과감히 삭제하라.

📌 일반

G1: 한 소스 파일에 여러 언어를 사용한다

• 좋게 말하자면 혼란스럽고 나쁘게 말하자면 조잡하다.
• 이상적으로는 소스 파일 하나에 언어 하나만 사용한 방식이 가장 좋다.

G2: 당연한 동작을 구현하지 않는다

• 최소 놀람의 원칙에 의거해함수나 클래스는 프로그래머가 당연하게 여길만한 동작과 기능을 제공해야 한다.
• 당연한 동작을 구현하지 않으면 코드를 읽거나 사용하는 사람이 더 이상 함수 이름만으로 함수 기능을 직관적으로 예상하기 어렵다.

G3: 경계를 올바로 처리하지 않는다

• 모든 경계 조건을 찾아내고, 모든 경계 조건을 테스트하고 테스트케이스를 작성 하라.

G4: 안전 절차 무시

• 안전 절차를 무시하면 위험하다.
• 실패하는 테스트 케이스를 일단 제겨두고 나중으로 미루는 태도는 신용카드가 공짜 돈이라는 생각만큼 위험하다.

G5: 중복

• 코드에서 중복을 발견할 때마다 추상화할 기회로 간주하라.
• 중복된 코드를 하위 루틴이나 다른 클래스로 분리하라.
• 이렇듯 추상화로 중복을 정리하면 설계 언어의 어휘가 늘어난다.

G6: 추상화 수준이 올바르지 못하다

• 추상화는 저차원 상세 개념에서 고차원 일반 개념을 분리한다.
• 기초 클래스는 구현 정보에 무지해야 마땅하다.
• 고차원 개념과 저차원 개념을 섞어서는 안된다.
• 잘못된 추상화 수준은 거짓말이나 꼼수로 해결하지 못한다.

G7: 기초 클래스가 파생 클래스에 의존한다

• 개념을 기초 클래스와 파생 클래스로 나누는 가장 흔한 이유는 고차원 기초 클래스 개념을저차원 파생 클래스 개념으로부터 분리해 독립성을 보장하기 위해서다.
• 그러므로 기초 클래스가 파생 클래스를 사용한다면 뭔가 문제가 있다는 말이다.
• 일반적으로 기초 클래스는 파생 클래스를 아예 몰라야 마땅하다.
• 이렇게 구현하면 변경이 시스템에 미치는 영향이 아주 작아지므로 현장에서 시스템을 유지보수 하기가 한결 수월하게 된다.

G8: 과도한 정보

• 잘 정의된 모듈은 인터페이스가 아주 작다. 하지만 작은 인터페이스로도 많은 동작이 가능하다.
• 부실하게 정의된 모듈은 인터페이스가 구질구질하다. 그래서 간단한 동작 하나에도 온갖 인터페이스가 필요하다.
• 잘 정의된 인터페이스는 많은 함수를 제공하지 않는다. 그래서 결합도가 낮다.

G9: 죽은 코드

• 죽은 코드란 실행되지 않는 코드를 가리킨다.
• 발견시 시스템에서 제거하라.

G10: 수직 분리

• 변수와 함수는 사용되는 위치에 가깝게 정의한다.
• 자역 변수는 처음으로 사용하기 직전에 선언하며 수직으로 가까운 곳에 위치해야 한다.
• 비공개 함수는 처음으로 호출한 직후에 정의한다.
• 비공개 함수는 정의하는 위치와 호출하는 위치를 가깝게 유지한다.
• 비공개 함수는 처음으로 호출되는 위치를 찾은 후 조금만 아래로 내려가면 쉽게눈에 띄어야한다.

G11: 일관성 부족

• 어떤 개념을 특정 방식으로 구현했다면 유사한 개념도 같은 방식으로 구현하라.
• 표기법은 신중하게 선택하며, 일단 선택한 표기법은 신중하게 따른다.

G12: 잡동사니

• 비어 있는 기본 생성자가 왜 필요한가? 쓸데없이 코드만 복잡하게 만든다.
• 소스 파일은 언제나 깔끔하게 정리하라! 잡동사니를 없애라!
  • 사용하지 않는 변수
  • 아무도 호출하지 않는 함수
  • 정보를 제공하지 못하는 주석

G13: 인위적 결합

• 서로 무관한 개념을 인위적으로 결합하지 않는다.
• 일반적인 enum은 특정 클래스에 속할 이유가 없다.
• 범용 static 함수도 마찬가지로 특정 클래스에 속할 이유가 없다.
• 함수, 상수, 변수를 선언할 때는 시간을 들여 올바른 위치를 고민한다.
• 그저 당장 편한곳에 선언하고 내버려두면 안 된다.

G14: 기능 욕심

• 클래스 메서드는 다른 클래스의 변수와 함수에 관심을 가져서는 안 된다.
• 다른 객체의 참초자와 변경자를 사용해 그 객체를 조작하면 그 객체 클래스 범위를 욕심내는 탓이다.

G15: 선택자 인수

• 선택자 인수는 큰 함수를 작은 함수 여럿으로 쪼개지 않으려는 게으름의 소산이다.
• 일반적으로, 인수를 넘겨 동작을 선택하는 대신 새로운 함수를 만드는 편이 좋다.

G16: 모호한 의도

• 코드를 짤 때는 의도를 최대한 분명히 밝힌다.
• 행을 바꾸지 않고 표현한 수식, 헝가리식 표기법, 매직 번호 등은 모두 저자의 의도를 흐린다.
• 독자에게 의도를 분명히 표현하도록 시간을 투자할 가치가 있다.

G17: 잘못 지운 책임

• 소프트웨어 개발자가 내리는 가장 중요한 결정 중 하나가 코드를 배치하는 위치다.
• 때로는 개발자가 ‘영리하게’ 기능을 배치한다. 독자에게 직관적인 위치가 아니라 개발자에게 편한 함수에 배치한다.

G18: 부적절한 static 함수

• 메서드를 소유하는 객체에서 가져오는 정보가 아니고 인수에서만 정보를 가져와야한다.
• 일반적으로 static 함수보다 인스턴스 함수가 더 좋다.
• 조금이라도 의심스럽다면 인스턴스 함수로 정의한다.
• 반드시 static 함수로 정의해야겠다면 재정의할 가능성은 없는지 꼼꼼히 따져본다.

G19: 서술적 변수

• 프로그램 가독성을 높이는 가장 효과적인 방법
  • 계산을 여러 단계로 나눈다.
  • 중간 값으로 서술적인 변수 이름을 사용.
• 서술적인 변수 이름은 많이 써도 괜찮다.
• 일반적으로는 많을수록 더 좋다.

G20: 이름과 기능이 일치하는 함수

• 이름만으로 분명하지 않기에 구현을 살피거나 문서를 뒤적여야 한다면더 좋은 이름으로 바꾸거나 아니면 더 좋은 이름을 붙이기 쉽도록 기능을 정리해야한다.

G21: 알고리즘을 이해하라

• 대다수 괴상한 코드는 사람들이 알고리즘을 충분히 이해하지 않은 채 코드를 구현한 탓이다.
• 구현이 끝났다고 선언하기 전에 함수가 돌아가는 방식을 확실히 이해하는지 확인하라.
• 작성자가 알고리즘이 올바르다는 사실을 알아야 한다.

G22: 논리적 의존성은 물리적으로 드러내라

• 한 모듈이 다른 모률에 의존한다면 물리적인 의존성도 있어야 한다.
• 논리적인 의존성만으로는 부족하다.
• 의존하는 모든 정보를 명시적으로 요청하는 편이좋다.

G23: if/else 혹은 switch/case 보다는 다형성을 사용하라

• 선택 유형 하나에는 switch 문을 한 번만 사용한다.
• 같은 선택을 수행하는 다른 코드에서는 다형성 객체를 생성해 switch 문을 대신한다.

G24: 표준 표기법을 따르라

• 팀은 업계 표준에 기반한 구현 표준을 따라야 한다.
• 표준을 설명하는 문서는 코드 자체로 충분해야 하며 별도 문서를 만들 필요는 없어야 한다.
• 팀이 정한 표준은 팀원 모두가 따라야 한다.
• 모두가 동의한 위치에 넣는다는 사실이 중요하다.
• 이 사실을 이해할 정도로 팀원들이 성숙해야 한다.

G25:매직 숫자는 명명된 상수로 교체하라

• 매직숫자는 상수로 변경하라.
• 어떤 상수는 이해하기 쉬우므로, 코드 자체가 자명하다면, 상수 뒤로 숨길 필요가 없다.

G26: 정확하라

• 검색 결과 중 첫 번째 결과만 유일한 결과로 간주하는 행동은 순진하다.
• 코드에서 뭔가를 결정할 때는 정확히 결정한다.
• 결정을 내리는 이유, 예외 처리 방법을 분명히 알아야한다.
• 호출하는 함수가 null을 반환할지도 모른다면 null을 반드시 점검한다.

G27: 관례보다 구조를 사용하라

• 설계 결정을 강제할 때는 규칙보다 관례를 사용한다.
• 명명 관례도 좋지만 구조 자체로 강제하면 더 좋다.
• enum 변수가 멋진 switch/case 문보다 추상 메서드가 있는 기초 클래스가 더 좋다.

G28: 조건을 캡슐화하라

• 조건의 의도를 분명히 밝히는 함수로 표현하라.

G29: 부정 조건은 피하라

• 가능하면 긍정 조건으로 표현한다.

G30: 함수는 한 가지만 해야 한다

• 함수를 짜다보면 한 함수 안에 여러 단락을 이어 일련의 작업을 수행하고픈 유혹에 빠진다.
• 한 가지만 수행하는 좀 더 작은 함수 여럿으로 나눠야 마땅하다.

G31: 숨겨진 시간적인 결합

• 시간적인 결합이 필요하다, 하지만 시간적인 결합을 숨겨서는 안 된다.
• 함수를 짤 때는 함수 인수를 적절히 배치해 함수가 호출되는 순서를 명백히 드러낸다.

G32: 일관성을 유지하라

• 코드 구조를 잡을 때는 이유를 고민해야한다.
• 그리고 그 이유를 코드 구조로 명백히 표현해야한다.
• 시스템 전반에 걸쳐 구조가 일관성이 있다면 남들도 일관성을 따르고 보존한다.

G33: 경계 조건을 캡슐화하라

• 경계 조건은 빼먹거나 놓치기 십상이다.
• 경계 조건은 한 곳에서 별도로 처리한다.
• 코드 여기저기에서 처리하지 않는다.

G34: 함수는 추상화 수준을 한 단계만 내려가야 한다

• 함수내 모든 문장은 추상화 수준이 동일해야한다.
• 그리고 그 추상화 수준은 함수 이름이 의미하는 작업보다 한 단계만 낮아야 한다.
• 개념은 아주 간단하지만 인간은 추상화 수준을 뒤섞는 능력이 너무나도 뛰어나다.
• 추상화 수준 분리는 리팩터링을 수행하는 가장 중요한 이유 중 하나다.

G35: 설정 정보는 최상위 단계에 둬라

• 추상화 최상위 단계에 둬야 할 기본값 상수나 설정 관련 상수를 저차원 함수에 숨기면 안된다.
• 대신 고차원 함수에서 저차원 함수를 호출할 때 인수로 넘긴다.

G36: 추이적 탐색을 피하라

• 일반적으로 한 모듈은 주변 모듈을 모를수록 좋다.
• 이를 디미터의 법칙이라 부른다.
• 실용주의 프로그래머들은 부끄럼 타는 코드 작성 이라고도 한다.
• 무엇이라 부르든 요지는 자신이 직접 사용하는 모듈만 알아야 한다는 뜻이다.

자바

J1: 긴 import 목록을 피하고 와일드카드를 사용하라

• 패키지에서 클래스를 둘 이상 사용한다면 와일드카드를 사용해 패키지 전체를 가져오라.
• 와일드카드 import 문은 때로 이름 충돌이나 모호성을 초래한다.
• 다소 번거롭지만 자주 발생하지 않으므로 여전히 와일드카드 import 문이 명시적인 import 문보다 좋다.

J2: 상수는 상속하지 않는다

• 어떤프로그래머는 상수를 인터페이스에 넣은 다음 그 인터페이스를 상속해 해당 상수를 사용한다.
• 참으로 끔직한 관행이다! 상수를 상속 계층 맨 위에 숨겨놨다.
• 언어의 범위 규칙을 속이는 행위다.
• 대신 static import 를사용하라.

J3: 상수 대 Enum

• 자바 5는 enum을 제공한다.
• 마음껏 활용하라! public static final int라는 옛날 기교를 더 이상 사용할 필요가 없다.

📌 이름

N1: 서술적인 이름을 사용하라

• 이름은 성급하게 정하지 않는다. 서술적인 이름을 신중하게 고른다.
• 신중하게 선택한 이름은 추가 설명을 포함한 코드보다 강력하다.

N2: 적절한 추상화 수준에서 이름을 선택하라

• 구현을 드러내는 이름은 피하라.
• 작업 대상 클래스나 함수가 위치하는 추상화 수준을 반영하는 이름을 선택하라.

N3: 가능하다면 표준 명명법을 사용하라

• 기존 명명법을 사용하는 이름은 이해하기 더 쉽다.
• DECORATOR 패턴을 활용 한다면 장식하는 클래스 이름에 Decorator 라는 단어를 사용해야 한다.
• ToString 과 같이 관례가 존재하는 이름은 관례를 따른다.
• 프로젝트에 유효한 의미가 담긴 이름을 많이 사용할수록 독자가 코드를 이해하기 쉬워진다.

N4: 명확한 이름

• 함수나 변수의 목적을 명확히 밝히는 이름을 선택한다.
• 길더라도 명확하고 서술적으로 지어야 한다.

N5: 긴 범위는 긴 이름을 사용하라

• 이름 길이는 범위 길이에 비례해야 한다.
• 범위가 작으면 아주 짧은 이름을 사용해도 괜찮다.
• 하지만 범위가 길어지면 긴 이름을 사용한다.
• 이름 범위가 길수록 이름을 정확하고 길게 짓는다.

N6: 인코딩을 피하라

• 이름에 유형 정보나 범위 정보를 넣어서는 안 된다.

N7: 이름으로 부수 효과를 설명하라

• 함수, 변수, 클래스가 하는 일을 모두 기술하는 이름을 사용한다.
• 실제로 여러 작업을 수행하는 함수에다 동사 하나만 달랑 사용하면 곤란하다.

📌 테스트

T1: 불충분한 테스트

• 테스트 케이스는 몇 개나 만들어야 충분할까?
• 잠재적으로 깨질 만한 부분을 모두 테스트해야 한다.
• 테스트 케이스가 확인하지 않는 조건이나 검증하지 않는 계산이 있다면 그 테스트는 불완전하다.

T2: 커버리지 도구를 사용하라

• 커버리지 도구는 테스트가 빠뜨리는 공백을 알려준다.
• 대다수 IDE는 테스트 커버리지를 시각적으로 표현한다.

T3: 사소한 테스트를 건너뛰지 마라

• 사소한 테스트는 짜기 쉽다.

T4: 무시한 테스트는 모호함을 뜻한다

• 때로는 요구사항이 불분명하기에 프로그램이 돌아가는 방식을 확신하기 어렵다.
• 선택 기준은 모호함이 존재하는 테스트 케이스가 컴파일이 가능한지 불가능한지에 달려있다.

T5: 경계 조건을 테스트하라

• 경계 조건은 각별히 신경 써서 테스트한다.
• 알고리즘의 중앙 조건은 올바로 놓고 경계 조건에서 실수하는 경우가 흔하다.

T6: 버그 주변은 철저히 테스트하라

• 버그는 서로 모이는 경향이 있다.
• 한 함수에서 버그를 발견했다면 그 함수를 철저히 테스트하는 편이 좋다.
• 십중팔구 다른 버그도 발견하리라.

T7: 실패 패턴을 살펴라

• 때로는 테스트 케이스가 실패하는 패턴으로 문제를 진단할 수 있다.
• 테스트 케이스를 최대한 꼼꼼히 짜라는 이유도 여기에 있다.
• 합리적인 순서로 정렬된 꼼꼼한 테스트 케이스는 실패 패턴을 드러낸다.

T8: 테스트 커버리지 패턴을 살펴라

• 통과하는 테스트가 실행하거나 실행하지 않는 코드를 살펴보면 실패하는 테스트 케이스의 실패 원인이 드러난다.

T9: 테스트는 빨라야 한다

• 느린 테스트 케이스는 실행하지 않게 된다.
• 일정이 촉박하면 느린 테스트 케이스를 제일 먼저 건너뛴다.
• 그러므로 테스트 케이스가 빨리 돌아가게 최대한 노력한다.

📌 후기

드디어 끝났다
수학의 정석 처럼 계속해서 읽어야 내가 제대로 사용할 수 있을 것 같았다.
이해는 되지만 직접 사용해봐야 지속적으로 클린한 코드를 만들 수 있을 것 같다.
모두 읽어보면 좋을 것 같다.