Clean Code #1 - 깨끗한 코드

어째서 나쁜 코드를 짰는가?

• 급해서? 서두르느라?
• 제대로 짤 시간이 없다고 생각해서
• 코드를 다듬느라 시간을 보냈다가 상사한테 욕먹을까 봐
• 지겨워서 빨리 끝내려고
• 다른 업무가 너무 밀려 후딱 해치우고 밀린 업무로 넘어가려고

르블랑의 법칙을 몰랐다. 나중은 결코 오지 않는다.

 

마음가짐

코드가 왜 그렇게 되었을까? 좋은 코드가 어째서 순식간에 나쁜 코드로 전락할까?

• 원래 설계를 뒤집는 방향으로 변한 요구사항
• 일정이 촉박해 제대로 할 시간 없었다
• 멍청한 관리자
• 조급한 고객
• 쓸모없는 마케팅 부서

이러한 이유로 탓을 떠벌린다.

 

관리자 혹은 마케팅은 우리에게 정보를 구한다. 정보를 구하지 않더라도 우리가 적극적으로 정보를 제공해야 마땅하다.

사용자는 요구사항을 내놓으며 우리에게 현실성을 자문한다. 그리므로 프로젝트 실패는 우리에게도 커다란 책임이 있다.

 

의사라 가정하자.

어느 환자가 수술 전에 손을 씻지 말라고 요구한다. 시간이 너무 걸리니까. 확실히 환자는 상사이다.

하지만 의사는 단호하게 거부한다. 왜? 질병과 감염의 위험은 환자보다 의사가 더 잘 아니까.

 

마찬가지다 나쁜 코드의 위험을 이해하지 못하는 관리자 말을 그대로 따르는 행동은 전문가답지 못하다.

 

원초적 난제

프로그래머는 근본적인 가치에서 난제에 봉착한다. 누구나 나쁜 코드가 업무 속도를 늦춘다는 사실을 익히 알고 있다.

그럼에도 모든 프로그래머가 기한을 맞추려면 나쁜 코드를 양산할 수밖에 없다고 느낀다.

 

진짜 전문가는 틀렸다는 사실을 잘 안다. 나쁜 코드를 양산하면 기한을 맞추지 못한다. 오히려 엉망진창이 상태로 속도가 곧바로 늦어지고, 결국 기한을 놓친다.

 

기한을 맞추는 유일한 방법은, 그러니까 빨리 가는 유일한 방법은,

언제나 코드를 최대한 깨끗하게 유지하는 습관이다.

 

깨끗한 코드라는 예술?

나쁜 코드가 심각한 장애물이라는 사실을 납득했다고 가정하자.

빨리 가려면 코드를 깨끗하게 유지해야 한다는 사실도 인정한다고 가정하자.

다음 질문으로 "깨끗한 코드를 어떻게 작성할까?" 깨끗한 코드가 무엇인지 모르면 깨끗한 코드를 만들려고 애써봤자 소용이 없다.

 

그림을 그리는 행위와 비슷하다.

그림을 보면 대부분의 사람은 잘 그렸는지 엉망으로 그렸는지 안다. 그렇지만 잘 그린 그림을 구분하는 능력이 그림을 잘 그리는 능력은 아니다. 다시 말해, 깨끗한 코드와 나쁜 코드를 구분할 줄 안다고 깨끗한 코드를 작성할 줄 안다는 뜻은 아니다.

 

어떤 사람은 코드 감각을 타고난다. 어떤 사람은 투쟁을 해서 얻어야 한다.

코드 감각이 있는 프로그래머는 나쁜 모듈을 보면 좋은 모듈로 개선할 방은을 떠올린다.

 

다시 말해, 깨끗한 코드를 작성하는 프로그래머는 빈 캔버스를 우아한 작품으로 바꿔가는 화가와 같다.

 

깨끗한 코드란?

우리 분야에서 아주 유명하고 노련한 프로그래머들에게 의견을 물었다.

 

Bjarne Stroustrup - 비야네 스트롭스트룹 (C++ 창시자, The C++ Programming Language 저자)

 

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

Grady Booch - 그래디 부치 (Object Oriented Analysis and Design with Application 저자)

 

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

코드는 추축이 아니라 사실에 기반해야 한다.

반드시 필요한 내용만 담아야 한다.

코드를 읽는 사람에게 프로그래머가 단호하다는 인상을 줘야 한다.

 

Dave Thomas - '큰 bing' 데이브 토마스 (OTI 창립자이자 이클립스 전략의 대부)

 

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

데이브는 깨끗한 코드란 다른 사람이 고치기 쉽다고 단언한다.

테스트 케이스가 없는 코드는 깨끗한 코드가 아니다.

 

Michael Feathers - 마이클 페더스 (Working Effectively with Legacy Code 저자)

 

• 깨끗한 코드는 언제나 누군가 주의 깊게 짰다는 느낌을 준다.
• 고치려고 살펴봐도 딱히 손댈 곳이 없다.
• 작성자가 이미 모든 사항을 고려했으므로 고칠 궁리를 하다 보면 언제나 제자리로 돌아온다.

마이클은 정곡을 찌른다.

깨끗한 코드는 주의 깊게 작성한 코드다.

 

Ron Jeffries - 론 제프리스 (Extreme Programming Installed와 Extreme Programming Adventure in C# 저자)

 

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

객체가 여러 기능을 수행한다면 여러 객체로 나눈다.

메서드가 여러 기능을 수행한다면 메서드 추출 리팩토링 기법을 적용해 기능을 명확히 기술하는 메서드 하나와 기능을 실제로 수행하는 메서드 여러 개로 나눈다.

중복과 표현력만 신경 써도 깨끗한 코드라는 목표에 성큼 다가선다.

 

론은 짤막한 문단 몇 개로 이 책 내용을 요약했다.

• 중복을 피하라.
• 한 기능만 수행하라.
• 제대로 표현하라.
• 작게 추상화하라.

이상이다.

 

Ward Cunningham - 워드 커닝햄 (위키 창시자, 피트 창시자, 익스트림 프로그래밍 공동 창시자, 디자인 패턴을 뒤에서 움직이는 전문가, 스몰토크 와 객체지향의 정신적 지도자, 코드를 사랑하는 프로그래머들의 대부)

 

코드를 읽으면서 짐작했던 기능을 각 루틴이 그래도 수행한다면 깨끗한 코드라 불러도 되겠다.

코드가 그 문제를 풀기 위한 언어처럼 보인다면 아름다운 코드라 불러도 되겠다.

 

깨끗한 코드는 읽으면서 놀랄 일이 없어야 한다고 워드는 말한다. 코드를 독해하느라 머리를 쥐어짤 필요가 없어야 한다. 읽으면서 짐작한 대로 돌아가는 코드가 깨끗한 코드다.

프로그램을 단순하게 보이도록 만드는 열쇠는 언어가 아니다. 언어를 단순하게 보이도록 만드는 열쇠는 프로그래머다.

 

우리는 저자다

Javadoc에서 @author 필드는 저자를 소개한다. 우리는 저자다. 저자는 독자가 있다.

여러분의 노력을 보고 판단을 내릴 독자가 있다는 사실을 기억하기 바란다.

 

코드를 읽는 시간 대 코드를 짜는 시간 비율이 10 대 1을 훌쩍 넘는다. 그러므로 읽기 쉬운 코드가 매우 중요하다.

 

주변 코드를 읽지 않으면 새 코드를 짜지 못한다. 주변 코드가 읽기 쉬우면 새 코드를 짜기도 쉽다.

주변 코드를 읽기가 어려우면 새 코드를 짜기도 어렵다.

그러므로 급하다면, 서둘러 끝내려면, 쉽게 짜려면, 읽기 쉽게 만들면 된다.

 

보이스카우트 규칙

잘 짠 코드가 전부는 아니다. 시간이 지나도 언제나 깨끗하게 유지해야 한다.

미국 보이스카우트가 따르는 간단한 규칙이 우리들에게도 유용하다.

 

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

 

한꺼번에 많은 시간과 노력을 투자해 코드를 정리할 필요가 없다. 변수 이름 하나를 개선하고, 조금 긴 함수 하나를 분할하고, 약간의 중복을 제거하고, 복잡한 if문 하나를 정리하면 충분하다.

 

프리퀄과 원칙

많은 면에서 이 책은 2002년에 출간한 Agile Software Development: Principles, Patterns, and Practices의 프리퀄이다.

PPP는 다양한 설계 원칙을 산발적으로 거론한다. SRP, OCP, DIP 등. 같이 읽으면 좋다.

 

결론

예술에 대한 책을 읽는다고 예술가가 된다는 보장은 없다. 책은 단지 다른 예술가가 사용하는 도구와 기법, 그리고 생각하는 방식을 소개할 뿐이다. 이 책을 읽는다고 뛰어난 프로그래머가 된다는 보장은 없다. 기술과 기교와 도구를 소개할 뿐이다.

 

나머지는 여러분에게 달렸다.