CS Clean Code - 형식 맞추기
프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
- 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.
- 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.
- 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.
형식을 맞추는 목적
코드 형식은 중요하다! 너무 중요해서 무시하기 어렵다. 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 원래 코드가 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.
의사소통할 때 물과 불을 바꿔서 말하면 혼란이 올 것이다. 코드 형식이 다르다면 코드를 분석할 때 어려울 것이다. 이를 해결하기 위해 한명의 개발자가 코드를 바꿔서 원래 코드가 사라질지라도 다른 개발자의 스타일과 규율은 사라지지 않는다. 결국 악순환의 반복이다.
개발자가 프레임워크를 사용하는 이유는 프레임워크가 자유도를 해치는 단점이 있지만 형식화된 코드를 만들어 빠른 개발과 유지 보수의 장점이 있는 이유와 같은 맥락이다.
적절한 행 길이를 유지하라
JUnit, FitNesse, Time And Money는 상대적으로 파일 크기가 작다. 500줄을 넘어가는 파일이 없으며 대다수가 200줄 미만이다. 즉 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실이다.
반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋겠다. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
신문 기사처럼 작성하라
아주 좋은 신문 기사를 떠올려보라. 독자는 위에서 아래로 기사를 읽는다. 최상단에 기사를 몇 마디로 요약하는 표제가 나온다. 독자는 표제를 보고서 기사를 읽을지 말지 결정한다.
소스 파일도 신문 기사와 비슷하게 작성한다. 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경써서 짓는다.
개념은 빈 행으로 분리하라
거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다. 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
public class Calculator {
public static int plus(int x, int y) {
return x + y;
}
public static int minus(int x, int y) {
return x - y;
}
public static int multiply(int x, int y) {
return x * y;
}
public static int division(int x, int y) {
return x / y;
}
}
public class Calculator {
public static int plus(int x, int y) {
return x + y;
}
public static int minus(int x, int y) {
return x - y;
}
public static int multiply(int x, int y) {
return x * y;
}
public static int division(int x, int y) {
return x / y;
}
}눈의 초첨을 흐리게 하고 코드를 바라보면 효과는 더욱 분명하게 드러난다. 위 코드는 행 묶음이 분리되어 보인다. 반면, 아래 코드는 전체가 한 덩이로 보인다.
세로 밀집도
줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
public class ReportConfig {
/*
리포터 리스너의 클래스 이름
*/
private String m_className;
/*
리포터 리스너의 속성
*/
private List<Property> m_properties = new ArrayList<>();
public void addProperty(Property property) {
m_properties.add(property);
}
}
public class ReportConfig {
private String m_className;
private List<Property> m_properties = new ArrayList<>();
public void addProperty(Property property) {
m_properties.add(property);
}
}
수직거리
서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만 타당한 근거가 없다면 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.
- 함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며 소스 파일을 위아래로 뒤지는 등 뺑뺑이를 돌았으나 미로 같은 코드 때문에 혼란만 가중된 경우
- 함수나 변수가 정의된 코드를 찾으려 상속 관계를 줄줄이 거슬러 올라간 경우
1. 변수 선언
변수는 사용하는 위치에 최대한 가까이 선언한다.
private static void readPreferences() {
InputStream is = null;
try {
is = new FileInputStream(getPreferencesFile());
setPreferences(new Properties(getPreferences()));
getPreferences().load(is);
} catch (IOException e) {
try {
if (is != null)
is.close();
} catch (IOException e1) {
}
}
}짧은 함수에서 지역 변수는 각 함수 맨 처음에 선언한다.
public int countTestCases() {
int count = 0;
for (Test each : tests)
count += each.countTestCases();
return count;
}루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.
public int countTestCases() {
...
for (XmlTest test : m_suite.getTests()) {
TestRunner tr = m_runnerFactory.newTestRunner(this, test);
...
}
...
}아주 드물지만 다소 긴 함수에서 블록 상단이나 루프 직전에 변수를 선언하는 사례도 있다.
2. 인스턴스 변수
인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
3. 종속함수
한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
4. 개념적 유사성
어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다.
- 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
- 변수와 그 변수를 사용하는 함수
- 비슷한 동작을 수행하는 일군의 함수
public class Assert {
public static void assertTrue(String message, boolean condition) {
}
public static void assertTrue(boolean condition) {
}
public static void assertFalse(String message, boolean condition) {
}
public static void assertFalse(boolean condition) {
}
}위 함수들은 개념적인 친화도가 매우 높다. 명명법이 똑같고 기본 기능이 유사하고 간단합니다. 종속적인 관계가 없더라도 가까이 배치할 함수들이다.
세로 순서
일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현하고 세세한 사항은 가장 마지막에 표현한다.
가로 형식 맞추기
예전에는 오른쪽으로 스크롤할 필요가 절대로 없게 코드를 짰다. 하지만 요즘은 모니터가 아주 크다. 게다가 젊은 프로그래머들은 글꼴 크기를 와창 줄여, 200자까지도 한 화면에 들어간다. 가급적이면 그렇게 하지 말기를 권한다.
가로 공백과 밀집도
가로로는 공백을 사용하여 밀접한 개념과 느슨한 개념을 표현한다.
private void measureLine(String line) {
lineCount++;
int lineSize = line.length();
totalChars += lineSize;
lineWithHistogram.addLine(lineSize, lineCount);
recordWidestLine(lineSize);
}- 할당 연산자를 강조하려고 앞뒤에 공백을 줬다. (왼쪽과 오른쪽을 분명히 나누기 때문이다.)
- 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다. (함수와 인수는 밀접하기 때문이다.)
- 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다. (쉼표를 강조해 인수가 별개라는 사실을 보여주기 때문이다.)
public static double root(double a, double b, double c) {
double determinant = determinant(a, b, c);
return (-b + Math.sqrt(determinant)) / (2*a);
}- 승수 사이에는 공백이 없다. (우선순위가 가장 높기 때문이다.)
- 항 사이에는 공백이 들어간다. (덧셈과 뺄셈은 우선순위가 곱셈보다 낮기 때문이다.)
가로 정렬
public class FitNesseExpediter {
private Socket socket;
private InputStream input;
private OutputStream output;
private long requestParsingTimeLimit;
...
public FitNesseExpediter(Socket s,
FitNesseContext context) throws Exception {
socket = s;
this.context = context;
}
}특정 부분을 강조하기 위해 탭 위치를 맞추어 코드를 작성했지만 효과를 보지 못했다.
- 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.
- 변수 유형은 무시하고 변수 이름부터 읽게 된다.
- 연산자는 보이지 않고 오른쪽 피연산자부터 보게된다.
코드를 굳이 정렬하지 않는다. 코드 정렬이 필요할 정도록 목록이 길다면 클래스를 쪼개야 한다는 의미다.
들여쓰기
소스 파일은 윤곽도와 계층이 비슷하다. 파일 전체에 적용되는 정보가 있고, 파일 내부에 클래스에 적용되는 정보가 있고, 클래스 내부에 메소드에 적용되는 정보가 있고, 메소드 내부에 블록으로 적용되는 정보가 있으며, 블록 내부에 블록으로 적용되는 정보가 있다. 이렇듯 범위로 이뤄진 계층을 표현하기 위해 들여쓰기를 사용하고, 들여쓰기한 파일은 구조가 한눈에 들어온다.
public class FitNesseExpediter {
private Socket socket;private InputStream input;private OutputStream output;private long requestParsingTimeLimit;
public FitNesseExpediter(Socket s, FitNesseContext context) throws Exception {socket = s;this.context = context;}
}public class FitNesseExpediter {
private Socket socket;
private InputStream input;
private OutputStream output;
private long requestParsingTimeLimit;
public FitNesseExpediter(Socket s, FitNesseContext context) throws Exception {
socket = s;
this.context = context;
}
}
들여쓰기 무시하기
때로는 간단한 if, while, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생긴다. 이런 유혹에 빠질 때마다 나는 항상 원점으로 돌아가 들여쓰기를 넣는다.
public class CommentWidget extends TextWidget {
public CommentWidget(ParentWidget parent, String text) { super(parent, text); }
public String render() throws Exception { return""; }
}
public class CommentWidget extends TextWidget {
public CommentWidget(ParentWidget parent, String text) {
super(parent, text);
}
public String render() throws Exception {
return "";
}
}
가짜 범위
때로는 빈 while 문이나 for 문을 접한다. 이런 구조는 가능한 피하려 애쓴다. 피하지 못한 때는 새 행에다 새미콜론으로 제대로 들여써서 넣어준다. 그렇게 하지 않으면 눈에 띄지 않는다.
while (dis.read(buf, 0, readBufferSize) != -1)
;
팀 규칙
팀 규칙이라는 제목은 말 장난이다. 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다. 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.
구현 스타일 논의하기
- 어디에 괄호를 넣을지
- 들여쓰기는 몇 자로 할지
- 클래스와 변수와 메서드 이름은 어떻게 지을지
느낀점
- 수직거리에서 protected 변수 사용을 피하라고 했는데 대안이 있을까?
- 가짜 범위, 새 행에다 새미클론을 넣는 방법보다. 차라리 함수로 만들어서 들여쓰기를 넣는 것이 더 좋다고 생각합니다.
- 팀 규칙, 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다. 너무 공감됐습니다.
사람마다 코드 스타일이 다르기 때문에 어느 한 규칙에 맞추면 불편할 것 같습니다. 그렇다고 규칙을 정하지 않으면 프로젝트는 엉망이 될 것입니다. IDE 기능을 적극 이용하여 코드는 자기 스타일로 작성하고 커밋 전에 팀 규칙으로 코드정렬 기능을 사용하면 좋을 것 같습니다.