[클린 코드] 클린 코드란 무엇인가?

코드는 영원하다

코드는 요구사항을 표현하는 언어입니다. 요구사항에 더욱 가까운 언어를 만들 수도 있고, 요구사항에서 정형 구조를 뽑아내는 도구를 만들 수도 있지만 어느 순간에는 정밀한 표현이 필요하게 됩니다.

 

최근에 코파일럿, AI 페어 프로그래머라고도 불리는 기술이 베타로 발표되었는데요. 제가 봤던 메서드 자동완성 같은 것이 개발에 편의성을 준다는 면에서는 좋다고 느꼈지만 이것이 앞에서 언급한 정밀한 표현을 만족시킬 수는 없는 거 같더군요. 인간과 똑같은 AI가 나오지 않는 이상 코드는 항상 존재해야 한다고 생각합니다.

 

나쁜 코드

나쁜 코드는 프로그램을 망하게 하는 원인입니다. 저 역시도 나쁜 코드를 짜 개인 프로젝트에서 고생을 했던 기억이 있습니다. 기본 기능이 어느 정도 구현되었을 때, 기능을 추가하는 데 그 전보다 훨씬 많은 비용이 들어가더라구요. 그래서 기능을 추가하는 게 쉽지 않았습니다. 저는 개인 프로젝트라 어찌저찌 그 순간만 넘기면 됐지만 회사가 이런 프로그램을 짜게 된다면 그 문제를 해결하기 위해 수 많은 비용이 들 것입니다.

 

그렇다면 나쁜 코드를 짜게 되는 원인이 무엇일까요? 일단 충분히 생각하지 않고 짰기 때문일 수도 있고, 저처럼 충분히 생각을 해도(물론 충분히라는 말이 어느 정도냐에 따라 다르겠지만) 클린 코드가 무엇인지 모르는 상태에서 접근했기 때문일 수도 있을 거 같습니다.

 

나중에 정리하겠다는 다짐으로 일단 나쁜 코드로 어찌저찌 작성해서 프로그램이 잘 작동합니다. 하지만 이미 돌이킬 수 없는 강을 건넜습니다. 나중은 결코 오지 않습니다.

 

클린 코드

클린 코드를 구현하는 행위는 그림을 그리는 행위와 같습니다. 그림을 보면 대부분의 사람은 잘 그려졌는지 엉망으로 그려졌는지 압니다. 그렇지만 잘 그린 그림을 구분하는 능력이 잘 그리는 능력은 아닙니다. 다시 말해, 깨끗한 코드와 나쁜 코드를 구분할 줄 안다고 깨끗한 코드를 작성할 줄 안다는 뜻이 아니라는 거죠.

 

깨끗한 코드를 작성하려면 청결이라는 힘겹게 습득한 감각을 활용해 자잘한 기법들을 적용하는 절제와 규율이 필요합니다. 열쇠는 코드 감각입니다. 코드 감각이 있으면 좋은 코드와 나쁜 코드를 구분합니다. 뿐만 아니라, 절제와 규율을 적용해 나쁜 코드를 좋은 코드로 바꾸는 전략도 파악합니다.

 

클린 코드란 무엇일까요? 권위 있는 프로그래머들은 다음과 같이 정의합니다.

 

비야네 스트롭스트룹의 정의

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

 

그래디 부치의 정의

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

 

빅 데이브 토마스의 정의

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

 

마이클 페더스의 정의

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

 

론 제프리스의 정의

최근 들어 나는 켄트 벡이 제안한 단순한 코드 규칙으로 구현을 시작한다. 중요한 순으로 나열하자면 간단한 코드는

• 모든 테스트를 통과한다.

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

물론 나는 주로 중복에 집중한다. 같은 작업을 여러 차례 반복하다면 코드가 아이디어를 제대로 표현하지 못한다는 증거다. 나는 문제의 아이디어를 찾아내 좀 더 명확하게 표현하려 애쓴다.

내게 있어 표현력은 의미 있는 이름을 포함한다. 보통 나는 확정하기 전에 이름을 여러 차례 바꾼다. 이클립스와 같은 최신 개발 도구는 이름을 바꾸기가 상당히 쉽다. 그래서 별 고충 없이 이름을 바꾼다. 하지만 표현력은 이름에만 국한되지 않는다. 나는 여러 기능을 수행하는 객체나 메서드도 찾는다. 객체가 여러기능을 수행한다면 여러 객체로 나눈다. 메서드가 여러 기능을 수행한다면 메서드 추출 리팩터링 기법을 적용해 기능을 명확히 기술하는 메서드 하나와 기능을 실제로 수행하는 메서드 여러 개로 나눈다.

중복과 표현력만 신경 써도 깨끗한 코드라는 목표에 성큼 다가선다. 지저분한 코드를 손볼 때 이 두 가지만 고려해도 코드가 크게 나아진다. 하지만 나는 한 가지를 더 고려한다. 이는 설명하기 조금 까다롭다.

오랜 경험끝에 나는 모든 프로그램이 아주 유사한 요소로 이뤄진다는 사실을 꺠달았다. 한 가지 예가 집합에서 항목 찾기다. 직원 정보가 저장된 데이터베이스든, 키/값 쌍이 저장된 해시 맵이든, 여러 값을 모아놓은 배열이든, 프로그램을 짜다 보면 어떤 집합에서 특정 항목을 찾아낼 필요가 자주 생긴다. 이런 상황이 발생하면 나느 추상 메서드나 추상 클래스를 만들어 실제 구현을 감싼다. 그러면 여러 가지 장점이 생긴다.

이제 실제 기능은 아주 간단한 방식으로, 예를 들어 해시 맵으로, 구현해도 괜찮다. 다른 코드는 추상 클래스나 추상 메서드가 제공하는 기능을 사용하므로 실제 구현은 언제든지 바꿔도 괜찮다. 지금은 간단하게 재빨리 구현했다가 나중에 필요할 때 바꾸면 된다.

게다가 집합을 추상화하면 진짜 문제에 신경 쓸 여유가 생긴다.간단한 찾기 기능이 필요한데 온갖 집합 기능을 구현하느라 시간과 노력을 낭비할 필요가 없어진다.

중복 줄이기, 표현력 높이기, 초반부터 간단한 추상화 고려하기. 내게는 이 세 가지가 깨끗한 코드를 만드는 비결이다.

 

워드 커닝햄의 정의

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

 

참고

• 클린 코드 | 로버트 C. 마틴 저/박재호, 이해영 역 | 인사이트