5장 형식 맞추기

클린 코드 5장을 요약한 내용 입니다.

프로그래머라면 한번 쯤은 이런 생각을 해봤을지도 모른다...

• 뚜껑을 열었을 때 독자들이 코드가 깔끔하고, 일관적이며, 꼼꼼하다고 감탄하면 좋겠다.

• 질서 정연하다고 탄복하면 좋겠다.

• 모듈을 읽으며 두 눈이 휘둥그래 놀라면 좋겠다.

• 전문가가 짰다는 인상을 심어주면 좋겠다.

팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.

형식을 맞추는 목적

어쩌면 '돌아가는 코드'가 전문 개발자의 일차적인 의무라 여길지도 모르겠다. 하지만 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

그렇다면 원활한 소통을 장려하는 코드 형식은 무엇일까?

신문 기사처럼 작성하라

아주 좋은 신문 기사를 떠올려보라. 독자는 표제를 보고서 기사를 읽을지 말지 결정한다. 첫 문단은 전체 기사 내용을 요약한다. 세세한 사실은 숨기고 커다란 그림을 보여준다. 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다.

소스 파일도 신문 기사와 비슷하게 작성한다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하라

각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각사이는 빈 행을 넣어 분리해야 마땅하다.

// Option 1. 분리하지 않은 코드
pacakge fitnesse.wikitext,widgets;

import java.util.regex.*;

public class BoldWidget extends ParentWidget {
    public static final String RegEXP = "'''.+?'''";
    ...
}
public BoldWidget(ParentWidget parent, String text) throws Exception {
    super(parent);
    ...
}
public render( ) throws Exception {
    StringBuffer html = new StringBuffer("<b>");
    ...
}

// Option 2. 행으로 분리된 코드
pacakge fitnesse.wikitext,widgets;

import java.util.regex.*;

public class BoldWidget extends ParentWidget {
    public static final String RegEXP = "'''.+?'''";
    ...
}

public BoldWidget(ParentWidget parent, String text) throws Exception {
    super(parent);
    ...
}

public render( ) throws Exception {
    StringBuffer html = new StringBuffer("<b>");
    ...
}

Option 1은 코드 가독성이 현저하게 떨어져 암호처럼 보인다.

세로 밀집도

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.

// Option 1. 연관되어 있지만 세로 밀집도가 약한 코드
public class ReporterConfig {
    /**
    *  리포터 리스너의 클래스 이름
    */
    private String m_className;
    
    /**
    *  리포터 리스너의 속성 
    */
    private List<Property> m_properties = new ArrayList<Property>();
    ...
    
    
// Option 2. 연관되어 있는 세로 밀집도가 높은 코드
public class ReporterConfig {
    private String m_className;
    private List<Property> m_properties = new ArrayList<Property>();
...

수직 거리

서로 밀접한 개념은 세로로 가까이 둬야 한다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

변수 선언

변수는 사용하는 위치에 최대한 가까이 선언한다. 우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다.

private static void readPreferences() {
		InputStream is = null;
		try {
				is = new FileInputStream(getPerferencesFile());
				setPerferences(new Properties(getPreferences()));
				getPreferences().load(is);
		} catch (IOException e) {
				try {
						if (is != null)
								is.close();
				} catch (IOException e1) {
						...
				}
		}
}

인스턴스 변수

인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다.

종속 함수

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.

개념적 유사성

어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다. 앞서 보았듯이, 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성이 한 예다. 변수와 그 변수를 사용하는 함수도 한 예다.

가로 형식 맞추기

한 행은 가로로 얼마나 길어야 적당할까? 프로그래머는 명백하게 짧은 행을 선호한다. 그러므로 짧은 행이 바람직하다. 옛날 홀러리스가 내놓은 80자 제한은 다소 인위적이다. 100자나 120자에 달해도 나쁘지 않다. 하지만 그 이상은 솔직히 주의부족이다.

팀 규칙

프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다. 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로국밥처럼 맘대로 짜대는 코드는 피해야 한다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.

이 장을 마무리 하며..

성능을 위해 포기했던 가독성에 대한 오해

루프문 밖에서 변수를 사용하여 재사용한 경험이 있다. 이는 루프문 안에서 매번 변수를 선언할 경우 힙 메모리에 인스턴스 변수를 생성하게 되고 한번 사용된 인스턴스는 무분별한 GC가 발생하여 애플리케이션에 부하가 발생한다고 생각했다. 하지만 실제 퍼포먼스를 체크해보면 이는 별로 차이가 나지 않다는 것을 알수 있다.

Integer age;
for(int i=0; i < 100; i++) {
		age = i;
}