Clean Code 5~6 장

5장 - 형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 작성해야 한다.

 

형식을 맞추는 목적

코드 형식은 너무나도 중요하다!!!

- 하지만 융통성 없이 맹목적으로 따르면 안 된다. 코드 형식은 의사소통의 일환이다.

- 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

- 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확정성에 계속 영향을 미친다.

- 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

 

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

 

적절한 행 길이를 유지하라

500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.

당연히 큰 파일보다는 작은 파일이 이해하기 쉽다.

 

1. 신문 기사처럼 작성하라

• 좋은 신문 기사를 보면 최상단에 요약하는 표제, 첫 문단은 기사 내용 요약, 밑으로 내려가며 세세한 사실이 나온다.
• 소스 파일도 신문 기사와 비슷하게 작성한다. 이름은 간단하면서도 설명이 가능하게 짓는다.
• 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
• 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
• 아래로 내려갈수록 의도를 세세하게 묘사한다.
• 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

 

2. 개념은 빈 행으로 분리하라

• 빈 행은 새로운 개념을 시작한다는 시각적 단서다.
• 코드를 보면 패키지, import 클래스 사이마다 빈 행이 있는 것을 알 수 있다.
• 이처럼 빈 행 바로 다음 줄에 눈길이 멈추기 때문에 훨씬 코드를 읽기 수월해진다.

 

3. 새로 밀집도

• 위에서 작성한 줄 바굼이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
• 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
• 변수는 변수끼리 메서드는 메서드끼리 밀집시켜 놓아야 훨씬 더 읽기 쉽다.

 

4. 수직 거리

• 서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다.
• 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이것이 바로 protected 변수를 피해야 하는 이유 중 하나다.
• 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
• 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.
  • 변수 선언
    - 변수는 사용하는 위치에 최대한 가까이 선언한다.
    - 여기서는 지역 변수를 의미하는 것이고 지역 변수는 각 함수 맨 처음에 선언한다.
    - 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.
    - 다소 긴 함수에서 블록 상단이나 루프 직전에 변수를 선언하는 사례도 있다.
  • 인스턴스 변수
    - 반면 인스턴스 변수는 클래스 맨 처음에 선언한다.
    - 변수 간에 세로로 거리를 두지 않는다.
    - 잘 설계한 클래스는 클래스의 많은 메서드가 인스턴스 변수를 사용하기 때문이다.
    - 자바에서는 보통 클래스 맨 처음에 인스턴스 변수를 선언한다.
  • 종속함수
    - 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
    - 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
    - 위에서 아래로 자연스럽게 읽으면서 호출되는 함수를 찾기가 쉬워지며, 그만큼 모듈 전체의 가독성도 높아진다.
    - 아래 코드에서 "FrontPage" 변수를 getPageNameOrDefault 함수 내부에서 정의해서 사용하는 방법도 있지만, 만약 FrontPage 상수가 잘 알려진 상수라면 적절하지 않은 저차원 함수에 묻히게 된다.
    - 따라서 상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 더 좋다.
  • 개념적 유사성
    - 어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다.
    - 친화도가 높을수록 코드를 가까이 배치한다.
    - 친화도가 높은 요인은 여러가지가 있다.
    
    1. 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
    2. 변수와 그 변수를 사용하는 함수
    3. 비슷한 동작을 수행하는 일군의 함수

// 종속 함수 예시
public Response makeResponse(FitNesseContext context, Request request) throws Exception {
	String pageName = getPageNameOrDefault(request, "FrontPage");
    loadPage(pageName, context);
    if (page == null)
    	return notFoundResponse(context, request);
    else
    	return makePageResponse(context);
}

// 개념적 유사성 예시
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);
    }
    ...
}

 

5. 세로 순서

• 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.
• 다시말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다.
• 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
• 신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현하고, 세세한 사항은 가장 마지막에 표현한다.

 

가로 형식 맞추기

프로그래머는 명백하게 짧은 행을 선호한다.저자는 120자 정도로 행 길이를 제한한다.

 

1. 가로 공백과 밀집도

• 할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다. 공백을 넣으면 두 가지 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.
• 반면 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. 서로 밀접하기 때문이다. 이때, 함수를 호출하는 코드에서 괄호 안 인수는 별개라는 사실을 보여주기 위해 쉼표 사이에 공백으로 분리했다.
• 연산자 우선순위를 강조하기 위해서도 공백을 사용하기는 하지만 IDE에서 이를 고려하지 않기 때문에 도구에서 없애는 경우가 흔하다.

private void measureLine(String line) {
    lineCount++;    
    int lineSize = line.length();
    totalChars += lineSize;
    lineWidthHistogram.addLine(lineSize, lineCount);
    recordWidestLine(lineSize);
}

 

2. 가로 정렬

• 이전에는 가로방향으로도 정렬을 하였다.
• 하지만 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.
• 선언부가 길다면 클래스를 쪼개야 한다는 의미이다.

 

3. 들여쓰기

• 소스 파일은 윤곽도와 계층이 비슷하다.
• 범위로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
• 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
• 가끔은 간단한 if문, 짧은 while문 등에서 들여쓰기를 무시하고픈 유혹이 생기는데, 이런 유혹이 생길 대마다 항상 원점으로 돌아가 들여쓰기를 넣는다.

 

4. 가짜 범위

• 때로는 빈 while 문이나 for 문을 접한다.
• 가급적 피하려고 노력하지만, 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다.

 

팀 규칙

• 팀 규칙이라는 제목은 말 장난이다.
• 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다. 즉, 팀은 한 가지 규칙에 합의해야 한다.
• 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다. 스타일은 일관적이고 매끄러워야 한다.

 

---

 

6장 - 객체와 자료 구조

변수를 비공개로 정의하는 이유가 있다. 남들이 변수에 의존하지 않게 만들고 싶어서다. 그렇다면 어째서 수많은 프로그래머가 조회 함수(get)와 설정 함수(set)를 당연하게 공개해 비공개 변수를 외부에 노출할까

 

자료/객체 비대칭

객체 : 객체는 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 공개한다.

자료 구조 : 자료를 그대로 공개하며 별다른 함수는 제공하지 않는다.

위에 두 정의는 본질적으로 상반된다. 두 개념은 사실상 정반대다.

 

아래는 절차적인 도형 코드이다.

- 만약 Gemoetry 클래스에 둘레 길이를 구하는 perimeter() 함수를 추가하고 싶다면?? -> 도형 클래스는 아무 영향도 받지 않는다.

- 도형 클래스에 의존하는 다른 클래스도 마찬가지다.

- 반대로 새 도형을 추가하고 싶다면?? -> Geometry 클래스에 속한 함수를 모두 고쳐야 한다.

public class Square {
    public Point topLeft;
    public double side;
}

public class Rectangle {
    public Point topLeft;
    public double height;
    public double width;
}

public class Circle {
    public Point center;
    public double radius;
}

public class Geometry {
    public final double PI = 3.141592653589793;

    public double area(Objects shape) throws NoSuchShapeException {
        if (shape instanceof Square) {
            Square s = (Square) shape;
            return s.side * s.side;
        } else if (shape instanceof Rectangle) {
            Rectangle r = (Rectangle) shape;
            return r.height * r.width;
        } else if (shape instanceof Circle) {
            Circle c = (Circle) shape;
            return PI * c.radius * c.radius;
        }
        throw new NoSuchShapeException();
    }
}

 

아래는 객체 지향적인 도형 클래스이다.

- 여기서 area()는 다형메서드다. Geometry 클래스는 필요 없다.

- 그러므로 새 도형을 추가해도 기존 함수에 아무런 영향을 미치지 않는다.

- 반면 새 함수를 추가하고 싶다면 도형 클래스 전부를 고쳐야 한다.

public class Square implements Shape {
    private Point topLeft;
    private double side;

    public double area() {
        return side * side;
    }
}

public class Rectangle implements Shape {
    private Point topLeft;
    private double height;
    private double width;

    public double area() {
        return height * width;
    }
}

public class Rectangle implements Shape {
    private Point center;
    private double radius;
    public final double PI = 3.1415926533589793;

    public double area() {
        return PI * radius * radius;
    }
}

자료 구조를 사용하는 절차적인 코드는 기존 자료 구조를 변경하지 않으면서 새 함수를 추가하기 쉽다. 반면 객체 지향 코드는 기존 함수를 변경하지 않으면서 새 클래스를 추가하기 쉽다.

반대로 절차적인 코드는 새로운 자료 구조를 추가하기 어렵다. 그러려면 모든 함수를 고쳐야 한다. 객체 지향 코드는 새로운 함수를 추가하기 어렵다. 그러려면 모든 클래스를 고쳐야 한다.

다시 말해, 객체 지향 코드에서 어려운 변경은 절차적인 코드에서 쉬우며, 절차 적인 코드에서 어려운 변경은 객체 지향 코드에서 쉽다!!!

 

복잡한 시스템을 짜다 보면 새로운 함수가 아니라 새로운 자료 타입이 필요한 경우가 생긴다. 이때는 객체 지향 기법이 가장 적합하다.

반면, 새로운 자료 타입이 아니라 새로운 함수가 필요한 경우도 생긴다. 이때는 절차적인 코드와 자료 구조가 좀 더 적합하다.

 

분별 있는 프로그래머는 때때로 단순한 자료 구조와 절차적인 코드가 가장 적합한 상황도 있다는 것을 인지하는 것이다.

 

디미터 법칙

미터 법칙이란 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙이다. 객체는 자료를 숨기고 함수를 공개한다. 즉, 객체는 조회 함수(get)로 내부 구조를 공개하면 안 된다는 의미이다.

 

아래 코드를 보자

final String outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath();

 

흔히 위와 같은 코드를 기차 충돌 이라 부른다. 여러 객차가 한 줄로 이어진 기차처럼 보이기 때문이다.

알반적으로 조잡하다 여겨지는 방식이므로 피하는 편이 좋다.

 

위 코드는 다음과 같이 나누는 편이 좋다.

Options opts = ctxt.getOptions();
File scratchDir = opts.getScratchDir();
final String outputDir = scratchDir.getAbsolutePath();

위 코드에서는 확실히 ctxt 객체가 Options을 포함하며, Options가 ScratchDir을 포함하며, ScratchDir이 AbsolutePath를 포함한다는 사실을 안다. 함수 하나가 아는 지식이 굉장히 많다. 즉, 위 코드를 사용하는 함수는 많은 객체를 탐색할 줄 안다는 말이다.

 

위 예제가 디미터 법칙을 위반하는지 여부는 ctxt, Options, ScratchDir이 객체인지 아니면 자료 구조인지에 달렸다.

객체라면 내부 구조를 숨겨야 하므로 확실히 디미터 법칙을 위반한다. 반면 자료 구조라면 당연히 내부 구조를 노출하므로 디미터 법칙이 적용되지 않는다.

 

final String outputDir = ctxt.options.scratchDir.absolutePath;

코드를 위 처럼 구현했다면 자료 구조 형태이기 때문에 디미터 법칙을 거론할 필요가 없어진다.

자료 구조는 무조건 함수 없이 공개 변수만 포함하고
객체는 비공개 변수와 공개 함수를 포함한다면, 문제는 훨씬 간단하다.

 

잡종 구조

때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다.

런 잡종 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렵다. 양쪽 세상에서 단점만 모아놓은 구조다. 그러므로 잡종 구조는 되도록 피하는 편이 좋다.

 

구조체 감추기

만약 ctxt, options, scratchDir 이 진짜 객체라면 어떻게 코드를 수정해야 좋을까?? 위 코드의 결과가 임시 디렉터리의 절대 경로를 얻는 과정이라고 생각하고 아래 코드를 살펴보자

// 1번 방법
ctxt.getAbsolutePathOfScratchDirectoryOption();

// 2번 방법
ctxt.getScratchDirectoryOption().getAbsolutePath();

// 3번 방법
BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

1번 방법은 ctxt 객체에 공개해야 하는 메서드가 너무 많아진다.

2번 방법은 getScratchDirectoryOption()이 객체가 아니라 자료 구조를 반환한다고 가정한다. 즉, 어느 방법도 석 내키지 않는다.

 

결국 ctxt가 객체라면 뭔가를 하라고 말해야지, 속을 드러내라고 말하면 안 된다. -> 임시 디렉터리의 절대 경로가 왜 필요한가, 절대 경로를 얻어 어디에 쓰려고 필요한가, 해당 모듈에서 한참 아래로 내려가 가져온 코드는 결국 임시 디렉터리의 절대 경로를 얻으려는 이유가 임시 파일을 생성하기 위한 목적이라는 것을 알게 되었다.

 

3번 방법은 ctxt 객체에 임시 파일을 생성하라고 시킨 코드인 것을 알 수 있다. 이는 객체에게 맡기기 적당한 임무로 보인다.

ctxt는 내부 구조를 드러내지 않으며, 모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다. 따라서 디미터 법칙을 위반하지 않는다.

 

자료 전달 객체

자료 구조체의 전형적인 형태는 공개 변수만 있고 함수가 없는 클래스다. 이런 자료 구조체를 때로는 자료 전달 객체(Data Transfer Object, DTO)라 한다. 

특히 데이터베이스와 통신하거나 소켓에서 받은 메시지의 구문을 분석할 때 유용하다. 흔히 DTO는 데이터베이스에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체이다.

DTO에서 private 비공개 변수를 설정하고 조회/설정 함수로 조작하는 것은 별 이익을 제공하지 않는다.

 

활성 레코드

활성 레코드는 DTO의 특수한 형태다. 공개 변수가 있거나 비공개 변수에 조회/설정 함수가 있는 자료 구조지만, 대개 save나 find와 같은 탐색 함수도 제공한다.

불행히도 활성 레코드에 비즈니스 규칙 메서드를 추가해 이런 자료 구조를 객체로 취급하는 개발자가 흔하다. 하지만 이는 바람직하지 않다. 그러면 자료 구조도 아니고 객체도 아닌 잡종 구조가 나오기 때문이다.

해결책은 당연히 활성 레코드는 자료 구조로 취급하는 것이다. 즉, 비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성한다.

 

결론

객체는 동작을 공개하고 자료를 숨긴다. 그래서 기존 동작을 변경하지 않으면서 새 객체 타입을 추가하기는 쉬운반면 기존 객체에 새 동작을 추가하기는 어렵다.

자료 구조는 별다른 동작 없이 자료를 노출한다. 그래서 기존 자료 구조에서 새 동작을 추가하기는 쉬우나, 기존 함수에 새 자료 구조를 추가하기는 어렵다.

결국 공개된 부분을 수정하는 것이 어렵다.
객체는 메서드가 공개되었기 대문에 새로운 메서드를 추가하는 것이 어렵고 -> 각 클래스마다 전부 만들어야 하기 때문
자료 구조는 자료가 노출되어 있기 때문에 새 자료 구조를 기존 메서드에 추가하는 것이 어렵다 -> 메서드 자체를 수정해야 하기 때문

 

어떤 시스템을 구현할 때, 새로운 자료 타입을 추가하는 유연성이 필요하면 객체가 더 적합하다. 다른 경우로 새로운 동작을 추가하는 유연성이 필요하면 자료 구조와 절차적인 코드가 더 적합하다.

 

우수한 소프트웨어 개발자는 편견 없이 이 사실을 이해해 직면한 문제에 최적인 해결책을 선택한다.