[Clean Code] Chapter 5. 형식 맞추기

joyful·2024년 8월 4일

개발서적

목록 보기

5/9

들어가기 앞서

이 글은 개발자 필독서인 클린 코드를 읽으며 습득한 내용을 정리한 글입니다. 모든 출처는 해당 저서에 있습니다.

코드가 어수선해 보인다면 독자들은 프로젝트의 다른 측면도 무성의한 태도로 처리했으리라 생각하게 된다.
코드 형식을 맞추기 위한 규칙을 정하고, 규칙을 따르도록 한다.
- 팀의 경우, 팀과의 합의를 통하여 규칙을 정하고 모두 따라야 한다.
- 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.

1. 형식을 맞추는 목적

코드 형식은 중요하다. 이는 의사소통의 일환이며, 개발자의 일차적인 의무다.
구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속해서 영향을 미친다.

2. 적절한 행 길이를 유지하라

대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다. 아무리 길어도 500줄은 넘기지 않도록 한다.
일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

2.1 신문 기사처럼 작성하라

이름은 간단하면서도 설명적으로 짓는다. 이름만 보고도 올바른 모듈인지 판단할 수 있을 정도로 신경써서 짓도록 한다.
소스파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
아래로 내려갈 수록 의도를 세세하게 묘사한다.
마지막에는 가장 저차원 함수와 세부 내역을 작성한다.
길이는 너무 길지 않게 작성하도록 한다.

2.2 개념은 빈 행으로 분리하라

대부분의 코드는 왼쪽에서 오른쪽, 위에서 아래로 읽힌다.
각 행은 수식이나 절을 나타내고, 행 묶음은 완결된 생각 하나를 표현한다.

생각 사이는 빈 행을 넣어 분리하도록 한다.
ex) 패키지 선언부, import 문, 각 함수 사이

빈 행은 새로운 개념을 시작한다는 시각적 단서를 제공한다.

package fitnesse.wikitext.widgets;

import java.util.regex.*;

public class BoldWidget extends ParentWidget {
	public static final String REGEXP = "'''.+?'''";
    private static final Pattern pattern = Pattern.compile(
        	"'''(.+?)'''", Pattern.MULTILINE + Pattern.DOTALL
    );
    
    public BoldWidget(ParentWidget parent, String text) throws Exception {
    	super(parent);
        Matcher match = pattern.matcher(text);
        match.find();
        addChildWidgets(match.group(1));
    }
    
    public String render() throws Exception {
    	StringBufer html = new TringBuffer("<b>");
        html.append(childHtml()).append("</b>");
        return html.toString();
    }
}

빈 행으로 분리하지 않을 경우, 코드 가독성이 떨어지게 된다.

package fitnesse.wikitext.widgets;
import java.util.regex.*;
public class BoldWidget extends ParentWidget {
	public static final String REGEXP = "'''.+?'''";
    private static final Pattern pattern = Pattern.compile(
        	"'''(.+?)'''", Pattern.MULTILINE + Pattern.DOTALL
    );
    public BoldWidget(ParentWidget parent, String text) throws Exception {
    	super(parent);
        Matcher match = pattern.matcher(text);
        match.find();
        addChildWidgets(match.group(1));
    }
    public String render() throws Exception {
    	StringBufer html = new TringBuffer("<b>");
        html.append(childHtml()).append("</b>");
        return html.toString();
    }
}

2.3 세로 밀집도

세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드 행은 세로로 가까이 놓도록 한다.

💻 개선 전

public class ReporterConfig {
	/**
     * 리포터 리스너의 클래스 이름
     */
    private String m_className;
    /**
     * 리포터 리스너의 속성
     */
    private List<Property> m_properties = new ArrayList<>();
    
    public void addProperty(Property property) {
    	m_properties.add(property);
    }
}

의미 없는 주석으로 인스턴스 변수를 떨어뜨려 놓아 코드를 파악하는 데 시간이 조금 더 걸린다.

💻 개선 후

public class ReporterConfig {
	private String m_className;
    private List<property> m_properties = new ArrayList<>();
    public void addProperty(Property property) {
    	m_properties.add(property);
    }
}

코드가 한눈에 들어온다.

2.4 수직 거리

서로 밀접한 개념은 세로로 가까이 두어야 하며, 한 파일에 속해야 한다.
세로 거리로 연관성을 표현한다.
- 연관성 : 한 개념을 이해하는 데 다른 개념이 중요한 정도
- 연관성이 깊은 두 개념이 가까이 있어야 코드를 읽는 사람이 편리하다.

2.4.1 변수 선언

변수는 사용하는 위치에 최대한 가까이 선언한다.
지역 변수는 각 함수 맨 처음에 선언한다.

루프를 제어하는 변수는 루프 문 내부에 선언한다.

public int countTestCases() {
	int count = 0;
  	for (Test each : tests) {
      count += each.countTestCases();
    }
    return count;
}

긴 함수라면 블록 상단이나 루프 직전에 변수를 선언해도 괜찮다.

...
for( XmlTest test : m_suite.getTests()) {
	TestRunner tr = m_runnerFactory.netTestRunner(this, test);
  	tr.addListener(m_testReporter);
  	m_testRunners.add(tr);
  
  	invoker = tr.getInvoker();
  
  	for (ITestNGMethod m : tr.getBeforeSuiteMethods()) {
  		beforeSuiteMethods.put(m.getMethod(), m);
  	}
  
  	for (ITestNGMethod m : tr.getAfterSuiteMethods()) {
  		afterSuiteMethods.put(m.getMethod(), m);
  	}
}

2.4.2 인스턴스 변수

인스턴스 변수는 클래스 맨 처음에 선언하며, 변수 간에 세로로 거리를 두지 않는다.
- 잘 설계한 클래스는 대다수의 클래스 메소드가 인스턴스 변수를 사용하기 때문이다.
잘 알려진 위치에 인스턴스 변수를 모아 변수 선언을 찾는 위치를 알기 쉽도록 한다.

2.4.3 종속 함수

한 함수에서 다른 함수를 호출하는 경우, 두 함수를 세로로 가까이 배치한다.
또한 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
- 호출되는 함수를 찾기가 쉬워지며, 모듈 전체의 가독성이 향상된다.

2.4.4 개념적 유사성

친화도가 높을수록 코드를 가까이 배치한다.

한 함수가 다른 함수를 호출하는 경우
함수가 함수의 외부 변수를 사용하는 경우

비슷한 동작을 수행하는 함수군

public class Assert {
	static public void assertTrue(String message, boolean condition) {
    	if (!condition) {
        	fail(message);
        }
    }
    
    static public void assertTrue(boolean condition) {
    	assertTrue(null, condition);
    }
    
    static public void assertFalse(String message, boolean condition) {
    	assertTrue(message, !condition);
    }
    
    static public void assertFalse(boolean condition) {
    	assertFalse(null, condition);
    }
}
...

명명법이 같고, 기본 기능이 유사하고 간단함
종속적인 관계가 없더라도 가까이 배치해야 함

2.5 세로 순서

함수 호출 종속성을 아래 방향으로 유지한다.
- 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
가장 중요한 개념을 가장 먼저 표현한다.
- 세세한 사항은 최대한 배제하며, 세세한 사항은 가장 마지막에 표현한다.
- 독자들이 소스 파일에서 개념을 파악하기 쉬워진다.

3. 가로 형식 맞추기

짧은 행이 바람직하다. 20자에서 60자 사이를 권장하며, 아무리 길어도 120자는 넘지 않도록 한다.

3.1 가로 공백과 밀집도

공백을 사용해 밀접/느슨한 개념을 표현한다.
할당문의 경우, 왼쪽 요소와 오른쪽 요소가 분명히 나뉘므로 공백을 넣도록 한다.
```
int lineSize = line.length();
```
함수 이름과 이어지는 괄호 사이에는 공백을 없애도록 한다.
- 함수와 인수는 서로 밀접하며, 공백을 넣을 경우 한 개념이 아닌 별개로 인식하게 된다.
```
private void measureLine(String line) { ... }
```
괄호 안 인수는 공백으로 분리하여 인수가 별개임을 인식하도록 한다.
```
recordWidestLine(lineSize);
```

연산자 우선순위를 강조하는 경우 공백을 사용한다.

public class Quadratic {
	public static double root(double a, double b, double c) {
  	double determinant = determinant(a, b, c);
      return (-b + Math.sqrt(determinant)) / (2*a);
  }
  
  private static double determinant(double a, double b, double c) {
  	return b*b - 4*a*c;
  }
}

곱셈은 우선순위가 가장 높으므로 공백을 사용하지 않는다.
항 사이는 공백을 사용한다. 이는 덧셈과 뺄셈은 우선순위가 곱셈보다 낮기 때문이다.

3.2 가로 정렬

가로 정렬은 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지게 된다.

public class FitNesseExpediter implements ResponseSender {
	private		Socket				socket;
  	private		InputStream			input;
  	private		OutputStream		output;
  	private		FitNesseContext		context;
  	protected	long				requestParsingTimeLimit;
      
  	...
  
  	public FitNesseExpediter(Socket			 s,
      						 FitNesseContext context) throws Exception {
  		this.context =			 context;
      	socket =				 s;
      	input =					 s.getInputStream();
      	output =				 s.getOutputStream();
      	requestParsingTimeLimt = 10000;
  	}
}

변수 유형은 무시하고 변수 이름부터 읽게 된다.

선언문과 할당문을 별도로 정렬하지 않도록 한다.
- 가로 정렬을 사용하지 않음으로써 중대한 결함을 찾기 쉽다.
정렬이 필요할 정도로 목록이 길다면 클래스를 쪼개야 한다.

3.3 들여쓰기

소스 파일은 계층이 존재한다.

파일 전체 ⊃ 파일 내 개별 클래스 ⊃ 클래스 내 각 메소드 ⊃ 블록 내 블록
- 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위이다.

범위(scope)로 이루어진 계층을 표현하기 위해 코드 들여쓰기를 한다.

들여 쓰는 정도는 계층에서 코드가 자리 잡은 수준에 비례한다.

수준	들여쓰는 정도	비고
파일	들여쓰지 않음	클래스 정의
클래스 내 메소드	클래스보다 한 수준 들여씀
메소드 코드	메소드 선언보다 한 수준 들여씀
블록 코드	블록을 포함하는 코드보다 한 수준 들여씀

왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표현한다.
이를 통해 구조가 한 눈에 들어와 파악하기 쉬워진다.

3.3.1 들여쓰기 무시하기

한 행에 범위를 뭉뚱그린 코드는 피한다.

public class CommentWidget extends TextWidget {
	public static final String REGEXP = "^#[^\r\n]*(?:(?:\r\n)|\n|\r)?";
  
  	public CommentWidget(ParentWidget parent, String text){super(parent, text);}
  	public String render() throws Exception {return ""; }
}

들여쓰기로 범위를 제대로 표현하도록 한다.

public class CommentWidget extends TextWidget {
	public static final String REGEXP = "^#[^\r\n]*(?:(?:\r\n)|\n|\r)?";
  
  	public CommentWidget(ParentWidget parent, String text) {
    	super(parent, text);
    }
    
  	public String render() throws Exception {
    	return "";
    }
}

3.4 가짜 범위

빈 블록은 올바로 들여 쓰고 괄호로 감싼다.
세미콜론(;)은 새 행에 제대로 들여 써서 넣어주어 눈에 잘 띄도록 한다.
```
while (dis.read(buf, 0, readBufferSize) != -1)
	;
```

4. 팀 규칙

팀에 속한다면 팀 규칙에 따라야 한다.
팀은 한 가지 규칙에 합의해야 하며, 모든 팀원은 그 규칙을 따라야 한다.
- 이는 소프트웨어의 일관적인 스타일을 유지할 수 있도록 해준다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이루어진다.
- 스타일이 일관적이고 매끄러워야 한다.
- 한 소스 파일에서 보았던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 주어야 한다.

📖 참고

로버트 C. 마틴, 『Clean Code 클린 코드 애자일 소프트웨어 장인 정신』, 박재호·이해영 옮김, 케이앤피북스(2010), p125-146.

joyful

기쁘게 코딩하고 싶은 백엔드 개발자

이전 포스트

[Clean Code] Chapter 4. 주석

다음 포스트