1장. 깨끗한 코드

코드가 존재하리라

• 코드는 요구사항을 상세히 표현하는 수단이자 언어이다. 기계가 실행할 정도로 상세하게 요구사항을 명시하는 작업, 바로 이것이 프로그래밍이다.

나쁜 코드와 나쁜 코드로 인해 치르는 대가

르블랑의 법칙 : "Later equals Never" 나중은 결코 오지 않는다.

• 우리는 시간에 쫓겨, 상사에게 혼날까 봐, 지겨워서, 업무가 많아서, 나쁜 코드를 짜고 나중에 수정하고자 한다. 그러나, 나중은 없다.
• 나쁜 코드는 개발 속도를 떨어뜨리고, 팀 생산성을 떨어트린다. 우리는 매번 나쁜 코드를 해독하느라 많은 시간을 낭비해야 한다.

- 원대한 재설계의 꿈

• 시스템을 처음부터 재설계하는 하는 팀 vs 기존의 시스템을 유지보수하는 팀의 끊임없는 경주가 시작된다.
• 경쟁은 길어지고, 재설계 팀원이 모두 떠나면, 결국 또 다른 재설계 팀이 꾸려진다. 또다시 끝없는 경주가 시작된다.

- 태도

• 코드를 작성하는 책임은 온전히 코드 전문가인 우리에게 있다. 우리를 닦달하는 클라이언트도, 무능한 관리자도, 변화무쌍한 요구사항도 나쁜 코드에 대한 책임을 지지 않는다.
• 나쁜 코드의 위험을 이해하지 못하는 관리자의 말을 그대로 따르는 행동은 전문가답지 못하다.

- 원초적 난제

• 시간에 쫓겨 나쁜 코드를 작성하면, 결국 이 코드를 해독하고 이해하느라 다음 프로세스가 늦어진다.
• 다음 프로세스가 늦어지면 시간에 또 쫓기게 된다.
• 결국 빨리 가는 유일한 방법은, 언제나 코드를 최대한 깨끗하게 유지하는 습관이다.

깨끗한 코드란 무엇인가?

- 비야네 스트롭스트룹

나는 우아하고 효율적인 코드를 좋아한다. 논리가 간단해야 버그가 숨어들지 못한다. 의존성을 최대한 줄여야 유지보수가 쉬워진다. 오류는 명백한 전략에 의거해 철저히 처리한다. 성능을 최적으로 유지해야 사람들이 원칙 없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다. 깨끗한 코드는 한 가지를 제대로 한다.

• '우아한' 코드
  • 깨끗한 코드는 '보기에 즐거운' 코드이다.
• '효율적인' 코드
  • 깨끗한 코드는 효율적이다. 이는 단순히 속도의 측면에서만이 아니다. 시스템 자원적인 측면에서도 효율적이어야 한다.
• '유혹에 빠지지 않는' 코드
  • 깨진 창문 이론처럼, 나쁜 코드가 존재하는 프로그램은 나쁜 코드의 유혹에 넘어가기 쉽다.
• '오류 처리 전략이 명백한' 코드
  • 메모리 누수, 레이스 건디션, 일관성 없는 명명법과 같이 세세한 부분까지 꼼꼼히 신경 쓰는 코드여야 한다.
• '한 가지를 제대로 하는' 코드
  • 모든 함수, 클래스, 모듈은 맡은 한 가지 일만을 제대로 처리해야 한다. 여러 기능과 역할, 책임이 스며든다면 해당 요소가 존재하는 목적이 모호해진다.

- 그래디 부치

깨끗한 코드는 단순하고 직접적이다. 깨끗한 코드는 잘 쓴 문장처럼 읽힌다. 깨끗한 코드는 결코 설계자의 의도를 숨기지 않는다. 오히려 명쾌한 추상화와 단순한 제어문으로 가득하다.

• '잘 쓴 문장처럼 읽히는' 코드
  • 깨끗한 코드는 가독성이 높아야한다. 코드를 통해 해결할 문제의 긴장을 명확히 드러내야 한다.
• '설계자의 의도를 숨기지 않는' 코드
  • 코드는 추측이 아니라 사실에 기반해야 한다. 불필요한 내용은 제거하고, 반드시 필요한 내용만을 담아야 한다.

- 데이브 토마스

깨끗한 코드는 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다. 단위 테스트 케이스와 인수 테스트 케이스가 존재한다. 깨끗한 코드에는 의미 있는 이름이 붙는다. 특정 목적을 달성하는 방법은 (여러 가지가 아니라) 하나만 제공한다. 의존성은 최소이며 각 의존성을 명확히 정의한다. API는 명확하며 최소로 줄였다. 언어에 따라 필요한 모든 정보를 코드만으로 표현할 수 없기에 코드는 문학적으로 표현해야 마땅하다.

• '다른 사람도 읽기 쉽고 고치기 쉬운, 의미 있는 이름이 붙은' 코드
  
  • 코드에는 의미있는 이름이 붙고 가독성이 높아야 한다. 내 코드는 나만 읽는 것이 아니다, 다른 사람이 읽어도 충분히 이해할 수 있고 수정할 수 있는 코드여야 한다.
• '단위 테스트 케이스와 인수 테스트 케이스가 존재하는' 코드
  • 깨끗한 코드가 되기 위해서는 테스트 케이스가 존재해야 한다. 테스트 케이스를 통해, 해당 코드가 적절히 구현됨을 확인할 수 있어야 하며 수정이 올바르게 되었는지를 확인할 수 있어야 한다.
• '특정 목적을 달성하는 방법은 하나만 제공하는' 코드
  • 지나치게 길게 늘어지는 코드는 읽기도 힘들뿐더러, 여러 역할을 수행하고 있을 가능성이 높다. 코드는 짧고 단순할수록 좋다.
• '문학적인' 코드
  • 코드를 수행하는 개체는 기계지만, 코드를 읽고 수정하고 개선하는 개체는 인간이다. 코드는 인간이 읽기 쉽게 문학적이어야 한다. 다시 말해, 가독성이 높아야 한다.

- 마이클 페더스

깨끗한 코드의 특징은 많지만 그 중애서도 모두를 아우르는 특징이 하나 있다. 깨끗한 코드는 언제나 누군가 주의 깊게 짰다는 느낌을 준다. 고치려고 살펴봐도 딱히 손댈 곳이 없다. 작성자가 이미 모든 사항을 고려했으므로, 고칠 궁리를 하다 보면 언제나 제자리로 돌아온다. 그리고는 누군가 남겨준 코드, 누군가 주의 깊게 짜놓은 작품에 감사를 느낀다.

• '주의 깊게 작성한' 코드
  • 한 줄의 코드를 작성하더라도 시간을 들여 깔끔하고 단정하게, 세세한 사항까지 꼼꼼하게 신경써서 작성해야 한다. 얼렁뚱땅 작성한 코드는, 수정해야 할 부분을 여러 군데에 남겨놓기 마련이다.

- 론 제프리스

최근 들어 나는 켄트 벡이 제안한 단순한 코드 규칙으로 구현을 시작한다(그리고 같은 규칙으로 구현을 거의 끝낸다). 중요한 순으로 나열하자면 간단한 코드는

- 모든 테스트를 통과한다.
- 중복이 없다.
- 시스템 내 모든 설계 아이디어를 표현한다.
- 클래스, 메서드, 함수 등을 최대한 줄인다.

• '중복이 없는' 코드
  • 코드에 중복이 많고 같은 작업을 여러 차례 반복한다면, 코드가 아이디어를 제대로 표현해내지 못한다는 증거다. 중복되는 코드가 있다면, 이를 추상화하여 하나의 기능이나 역할로 구분해야 한다.
• '시스템 내 모든 설계 아이디어를 표현하는' 코드
  • 표현력은 결국 의미 있는 이름을 포함한다. 동시에, 하나의 객체, 하나의 메서드는 하나의 역할만을 해야 한다. 객체가 여러 기능을 수행한다면 객체를 분리하고, 메서드가 여러 기능을 한다면 기능별로 메서드를 추출해 기능을 명확히 기술하는 메서드 하나와 실제로 기능을 수행하는 여러 메서드로 나눠야 한다.
• '클래스, 메서드, 함수 등을 최대한 줄인' 코드
  • 수준 높은 추상화는 불필요한 확장을 줄인다. 기능 구현에 집중하기 이전에 먼저 추상화를 고려하면, 쓸 데 없이 많은 코드의 양을 줄일 수 있고, 다른 코드는 추상화 된 상위 기능을 사용하기 때문에 이를 구체화 한 실제 구현의 수정도 용이하게 할 수 있다.

- 워드 커닝햄

코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다. 코드가 그 문제를 풀기 위한 언어처럼 보인다면 아름다운 코드라 불러도 되겠다.

• '짐작했던 기능을 수행하는' 코드
  • 코드를 독해하느라 시간을 낭비하는 일이 없어야 한다. 코드는 메서드나 객체의 이름을 통해 짐작했던 기능을 그대로 수행해야 한다.
• '문제를 풀기 위한 언어처럼 보이는' 코드
  • 언어가 문제에 적합하지 않은 것이 아니다. 특정 문제를 해결하기에 적합한 언어처럼 보이게 만드는 것은 우리의 책임이다. 

우리는 저자다

• 개발을 하다 보면, 코드를 짜는 시간보다 코드를 읽는 시간이 훨씬 길다. 새로운 코드를 짜기 위해서는 기존 코드를 끊임없이 읽어보며 확인해야 하기 때문이다. 
• 결국 우리는, 읽는 독자가 읽기 쉬운 코드를 짜는 저자여야 한다. 코드를 읽기 쉽게 만들면 사실은 짜기도 쉬워진다.
• 그러므로 급하다면, 서둘러 끝내려면, 쉽게 짜려면, 읽기 쉽게 만들면 된다.

보이스카우트 규칙

캠프장은 처음 왔을 때보다 더 개끗하게 해놓고 떠나라.

• 잘 짠 코드가 전부는 아니다. 잘 짠 코드도 운영하는 과정에서 언제든 나쁜 코드로 전락할 수 있다. 그러므로 우리는 적극적으로 코드의 퇴보를 막아야 한다.
• 코드의 지속적인 개선이야말로 전문가 정신의 본질이다.

마치며

• 그래서, 이러한 지식들을 전부 안다고 해서 끝인가? 절대 아니다. 이러한 지식은 결국 남의 지식일 뿐이다. 끊임없는 연습과 구현을 통해 필요한 지식들과 그렇지 않은 것을 구분해야 하며, 이들을 체화하고 내 것으로 만들어야 한다.