본문 바로가기
프로그래밍 놀이터/디자인 패턴, 리펙토링

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

by 돼지왕 왕돼지 2012. 2. 28.
반응형


클린코드란?


The C++ Programming Language 저자 Bjane Stroustrup

'보기에 즐거운' 코드. ( 오류, 메모리 누수, Race Condition, 일관성 없는 명명법 등은 즐겁지 않6다. )
'한가지를 잘 하는' 코드. ( 함수, 클래스, 모듈은 주변과 연관성이 없이 (혹은 적게) 한가지 일만 한다. )

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



Object Oriented Analysis and Design with Application 저자 Grady Booch

'가독성이 좋은' 코드. ( 책을 읽듯 읽혀야 한다. )

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



OTI 창립자이자 이클립스 전략의 대부 Dave Thomas

- 가독성과 함께, 다른 사람이 고치기 쉬운 코드.
테스트 케이스가 있는 코드.
단위가 작은 코드. ( 함수던, 클래스던 작아야 한다. )

클린 코드는 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다.
단위 테스트 케이스와 수용 테스트 케이스
가 존재한다.
의미 있는 이름이다.
특정한 목적을 달성하는 방법은 (여러가지가 아니라) 하나만 제공한다.
의존성은 최소이며 각 의존성을 명확히 정의한다.
API 는 명확하며 최소로 줄였다.
때로는 필요한 정보 전부를 코드만으로 명확하게 드러내기 어려우므로 언어에 따라 문학적 표현이 필요하다.



Working Effectively with Legacy Code 저자 Michael Feather.

주의 깊게 짜진 코드. ( 세세한 사항까지 꼼꼼하게 신경 쓴 )

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



Extreme Programming Installed 와 Extreme Programming Adventure in C# 저자 Ron Jeffries

최근 들어 나는 켄트 벡이 제안한 간단한 코드 규칙으로 구현을 시작한다. ( 그리고 같은 규칙으로 구현을 거의 끝낸다. )
중요한 순으로 나열하자면 간단한 코드는
 - 모든 테스트를 통과한다.
 - 중복이 없다.
 - 시스템 내 모든 설계 아이디어를 표현한다.
 - 클래스, 메소드, 함수 등을 최대한 줄인다.
물론 나는 주로 중복에 집중한다.
같은 작업을 여러 차례 반복한다면 코드가 아이디어를 제대로 표현하지 못한다는 증거다.
나는 문제의 아이디어를 찾아내 좀 더 명확하게 표현하려 애쓴다.
내게 있어 표현성은 의미 있는 이름을 포함한다.
보통 나는 확정하기 전에 이름을 여러차례 바꾼다.
이클립스와 같은 현대적인 개발 도구는 이름을 바꾸기가 상당히 쉽다.
그래서 별다른 고충 없이 이름을 바꾼다.
하지만 표현성은 이름에만 국한되지 않는다.
나는 여러 기능을 수행하는 개체나 메소드도 찾는다.
개체가 여러 기능을 수행한다면 여러 개체로 나눈다.
메소드가 여러 기능을 수행한다면 메소드 추출( Extrac Method ) 
리펙토링 기법을 적용해 기능을 명확히 기술하는 메소드 하나와 기능을 실제로 수행하는 메소드 여러개로 나눈다.
중복과 표현성만 신경을 써도 ( 내가 생각하는 ) 클린 코드라는 목표에 성큼 다가선다.
지저분한 코드를 손볼 때 이 두가지만 고려해도 코드가 크게 나아진다.
하지만 나는 한가지를 더 고려한다.
조금 설명하기 까다롭다.
오랜 경험 끝에 나는 모든 프로그램이 아주 유사한 요소로 이루어진다는 사실을 깨달았다.
한 가지 예가 '집합에서 항목 찾기'다.
직원 정보가 저장된 데이터베이스든, 키/값 쌍이 저장된 해시 맵이든, 여러 값을 모아놓은 배열이든, 프로그램을 짜다 보면 어떤 집합에서 특정 항목을 찾아낼 필요가 자주 생긴다.
이런 상황이 발생하면 나는 추상 메소드나 추상 클래스를 만들어서 실제 구현을 감싼다.
그러면 여러 가지 장점이 생긴다.
이제 실제 기능은 아주 간단한 방식으로, 예를 들어 해시 맵으로, 구현해도 괜찮다.
다른 코드는 추상 클래스나 추상 메소드가 제공하는 기능을 사용하므로 실제 구현은 언제든지 바꿔도 괜찮다.
지금은 간단하게 재빨리 구현했다가 나중에 필요할 때 바꾸면 된다.
게다가 집합을 추상화하면 '진짜' 문제에 신경을 쓸 여유가 생긴다.
간단한 찾기 기능이 필요한데 온갖 집합 기능을 구현하느라 시간과 노력을 낭비할 필요가 없어진다.
중복 줄이기, 표현성 높이기, 초반부터 간단한 추상화 고려하기.
내게는 이 세가지가 클린 코드를 만드는 비결이다.



Wiki 창시자, Fit 창시자, eXtreme Programming 공동 창시자, 디자인 패턴을 뒤에서 움직이는 전문가, Smalltalk와 OO의 정신적 지도자, 코드를 사랑하는 프로그래머의 대부 Ward Cunningham.

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



반응형

댓글0