Clean Code 3~4장

3장 - 함수

프로그래밍 초창기에는 시스템을 루틴과 하위 루틴으로 나눴는다, 포트란과 PL/1 시절에는 시스템을 프로그램, 하위 프로그램, 함수로 나눴다. 지금은 함수만 살아남았고 어떤 프로그램이든 가장 기본적인 단위가 함수라고 할 수 있다. 3장에서는 함수를 잘 만드는 법을 소개해주고 있다. 

 

의도를 분명히 표현하는 함수를 어떻게 구현할 수 있을까, 함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까. 이에 대해 지금부터 하나하나 소개하도록 하겠다.

 

1. 작게 만들어라!

• 함수를 만드는 첫째 규칙은 작게!다
• 함수를 만드는 두번째 규칙도 더 작게!다
• 함수는 100줄을 넘어서는 안 된다. 아니, 20줄도 길다

 

2. 블록과 들여쓰기

• if 문 / else 문 / while 문 등에 들어가는 블록은 한 줄이어야 한다.
• 주로 그 한줄이 함수를 호출하는 것이다.
• 그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.
• 중첩 구조가 생길만큼 함수가 커져서는 안 된다.

함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.

 

3. 한 가지만 해라!

public static String renderPageWithSetupsAndTeardowns(
        PageData pageData, boolean isSuite
) throws Exception {
    if (isTestPage(pageData)) {
        includesetupAndTeardownPages(pageData, isSuite);
    }
    return pageData.getHtml();
}

• 위 함수는 설정 페이지와 해제 페이지를 테스트 페이지에 넣는다.
• 즉, 한 가지의 처리만 진행한다는 의미이다.
• 문제는 한 가지가 무엇인지 알기가 어렵다. 누군가는 이렇게 주장할 수 있다.
  1. 페이지가 테스트 페이지인지 판단한다.
  2. 그렇다면 설정 페이지와 해제 페이지를 넣는다.
  3. 페이지를 HTML로 렌더링한다.
• 여기서 언급하는 세 단계는 지정된 함수 이름 아래에서 추상화 수준이 하나다. 즉, 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.
• 함수가 한 가지 작업만 하는지 판단하는 또 다른 방법으로는 단순히 다른 표현이 아니라 의미 있는 이름으로 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

 

함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.

 

4. 함수 당 추상화 수준은 하나로!

• 함수가 확실히 한 가지 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
• getHtml()은 추상화 수준이 아주 높다.
• String pagePathName = PathParser.render(pagePath); 는 추상화 수준이 중간이다.
• .append("\n")와 같은 코드는 추상화 수준이 아주 낮다.
• 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.

 

5. 위에서 아래로 코드 읽기 : 내려가기 규칙

• 코드는 위에서 아래로 이야기 처럼 읽혀야 좋다.
• 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. 이것을 내려가기 규칙이라 부른다.

 

6. Switch 문

• switch 문은 작게 만들기 어렵다. 본질적으로 switch 문은 N가지를 처리한다.
• 다형성을 이용하여 각 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법이 있다.

public Money calculatePay(Employee e) throws InvalidEmployeeType {
	switch (e.type) {
    	case COMMISSIONED:
        	return calculateCommissionedPay(e);
        case HOURLY:
        	return calculateHourlyPay(e);
        case SALARIED:
        	return calculateSalariedPay(e);
        default:
        	throw new InvalidEmployeeType(e.type);
    }
}

• 위 함수에는 몇 가지 문제가 있다.
  1. 함수가 길다. 새 직원 유형을 추가하면 더 길어진다.
  2. 한 가지 작업만 수행하지 않는다.
  3. SRP(Single Responsibility Principle)을 위반한다 -> 코드를 변경할 이유가 여럿이기 때문이다.
  4. OCP(Open Closed Principle)를 위반한다 -> 새 직원 유형을 추가할 때마다 코드를 변경하기 때문이다.
• 아래 코드처럼 switch 문을 추상 팩토리에 숨겨서 적절한 Employee 파생 클래스의 인스턴스를 생성하는 메서드로 변경하고 각 인스턴스가 로직을 실행하도록 변경할 수 있다.

public abstract class Employee {
    public abstract boolean isPayday();
    public abstract Money calculatePay();
    public abstract void deliveryPay(Money pay);
}

public interface EmployeeFactory {
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}

public class EmployeeFactoryImpl implements EmployeeFactory {
    @Override
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
        switch (r.type) {
            case COMMISSIONED:
                return new CommissionedEmployee(r);
            case HOURLY:
                return new HourlyEmployee(r);
            case SALARIED:
                return new SalariedEmployee(r);
            default:
                throw new InvalidEmployeeType(r.type);
        }
    }
}

 

7. 서술적인 이름을 사용하라!

• isTestable, includesetupAndTeardownPages 등과 같이 서술적인 이름을 짓는다.
• 코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.
• 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.
• 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.

8. 함수 인수

• 함수에서 이상적인 인수 개수는 0개다.
• 다음은 1개, 다음은 2개, 3개 이상은 피하는 편이 좋다.
• 인수는 개념을 이해하기 어렵게 만든다.

 

많이 쓰는 단항 형식

• 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지다.
• 하나는 인수에 질문을 던지는 경우이고 boolean fileExists("MyFile")
• 다른 하나는 인수를 뭔가로 변환해 결과를 반환하는 경우다.
• 추가로 이벤트 형식도 단항 형식을 사용할 수 있다.
  - 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다.
  - passwordAttemptFailedNtimes(int attempts)
  - 이벤트라는 사실이 코드에 명확히 드러나도록 조심해서 사용해야 한다.

 

플래그 인수

• 함수로 부울 값을 넘기는 플래그 인수는 끔찍하다.
• 대놓고 함수가 한꺼번에 여러 가지를 처리한다고 얘기하는 것이기 때문

 

이항 함수

• 인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
• 가능하면 단항 함수로 바꿔야 한다.

 

삼항 함수

• 인수가 3개인 함수는 이항 함수보다 훨씬 이해하기 어렵다.
• 삼항 함수를 만들 때는 신중히 고려하라

 

인수 객체

• 인수가 2~3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어보자.
• Circle makeCircle(double x, double y, double radius); 보다는
• Circle makeCircle(Point center, double radius); 가 보기 좋다.

 

인수 목록

• 때로는 인수 개수가 가변젹인 함수도 필요하다.
• 가변 인수 전부를 동등하게 취급하면 하나의 List 형 인수로 취급할 수 있다.
• 즉, 가변 인수는 단항, 이항, 삼항 함수로 취급할 수 있다. 하지만 이를 넘어서는 인수를 사용할 경우 문제가 생길 수 있다.

 

동사와 키워드

• 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
• 예를 들면 write(name) 혹은 writeField(name) -> 두 번째 이름이 좀 더 나은 이름이다.
• 함수 이름에 키워드를 추가하는 형식
• 예를 들면, assertEquals 보다 assertExpectedEqualsActual(expected, actual)이 더 좋다. 그러면 인수 순서를 기억할 필요가 없어진다.

 

9. 부수 효과를 일으키지 마라!

• 부수 효과는 거짓말이다.
• 때로는 예상치 못하게 클래스 변수를 수정하거나, 시스템 전역 변수를 수정할 수도 있다.

 

10. 명령과 조회를 분리하라!

• 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다.
• 객체 상태를 변경하거나
• 아니면 객체 정보를 반환하거나 둘 중 하나다.

if (attributeExists("username")) {
	setAttribute("username", "unclebob");
}

• 위 코드에서 if 문 조건에는 조회가 사용되었고 if 문 내부에는 명령문이 사용되었다.

 

11. 오류 코드보다 예외를 사용하라!

• 명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.
• if (deletePage(page) == E_OK)
• Try/Catch 블록 뽑아내기
  • try/ catch 는 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다.
  • 그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.

 

• 오류 처리도 한 가지 작업이다.
  • 함수는 한 가지 작업만 해야한다.
  • 오류 처리도 한 가지 작업에 속한다.
  • 그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다.

 

12. 반복하지 마라!

• 중복은 소프트웨어에서 모든 악의 근원이다.

 

13. 구조적 프로그래밍

• 함수는 return 문이 하나여야 한다.
• 루프 안에서 break나 continue를 사용해서는 안 되면 goto는 절대로 안된다.
• 하지만 위 규칙은 별 이익을 제공하지 못한다.
  • 함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다.
  • 반면 goto문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야만 한다.

 

14. 함수를 어떻게 짜죠?

• 초안은 대개 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.
• 그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다
• 그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다.
• 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다.
• 이 와중에도 코드는 항상 단위 테스트를 통과한다.

처음부터 이상적인 코드를 짜는게 가능한 사람은 없다.

대가 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이야기로 여긴다.

코드를 작성하는 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하자.
각자가 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다는 사실을 기억하자.

 

---

4장 - 주석

 

나쁜 코드에 주석을 달지 마라. 새로 짜라.

 

잘 달린 주석은 그 어떤 정보보다 유용하다. 하지만 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.

사실상 주석은 기껏해야 필요악이다. 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.

즉, 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

주석에 힘을 쓰지 말고 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟자.

 

1. 주석은 나쁜 코드를 보완하지 못한다.

• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

 

2. 코드로 의도를 표현하라!

if (employee.flags & HOURLY_FLAG) && (employee.age > 65))

if (employee.isEligibleForFullBenefits())

• 위 코드에서 첫 줄의 코드보다 다음 줄의 코드가 훨씬 의도를 파악하기 좋다.
• 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
• 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

 

3. 좋은 주석

• 법적인 주석
  • 모든 조항과 조건을 열거하는 대신에,
  • 가능하다면, 표준 라이선스나 외부 문서를 참조해도 된다.
• 정보를 제공하는 주석
  • 정보를 제공하는 주석도 좋지만
  • 가능하다면, 함수 이름에 정보를 담는 편이 더 좋다.
• 의도를 설명하는 주석
  • 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
• 의미를 명료하게 밝히는 주석
  • 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
  • 일반적으로 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.

assertTrue(a.compareTo(a) == 0);   // a == a
assertTrue(a.compareTo(b) != 0);   // a != b

• 결과를 경고하는 주석
  • 특정 테스트 케이스를 꺼야 하는 이유를 설명하는 주석이 한 예시이다.
• TODO 주석
  • 앞으로 할 일을 남기는 주석이다.
• 중요성을 강조하는 주석
  • 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.
• 공개 API에서 Javadocs
  • 설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다.
  • 하지만 여느 주석과 마찬가지로 그릇된 정보를 전달할 가능성이 존재한다.

 

4. 나쁜 주석

 

- 대다수 주석이 이 범주에 속한다.

- 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.

 

• 주절거리는 주석
• 같은 이야기를 중복하는 주석
• 오해할 여지가 있는 주석
• 의무적으로 다는 주석
  • 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석은 규칙이다.
  • 오히려 코드를 복잡하게 만들 뿐이다.

 

• 있으나 마나 한 주석
• 무서운 잡음
• 함수나 변수로 표현할 수 있다면 주석을 달지 마라
• 위치를 표시하는 주석
  • // Actions /////// 와 같은 배너 주석 아래 특정 기능을 모아놓으면 유용한 경우도 있다.
  • 너무 자주 사용하지 말고 필요할 때만, 아주 드물게 사용하는 편이 좋다.
  • 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.

 

• 닫는 괄호에 다는 주석
  • 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만,
  • 기본적으로 함수를 줄이려 시도하자

 

• 공로를 돌리거나 저자를 표시하는 주석
  • 소스 코드 관리 시스템에 저장하는 편이 좋다.

 

• HTML 주석
• 전역 정보
  • 주석을 달아야 한다면 근처에 있는 코드만 기술해라
  • 아래 함수는 기본 포트값을 전혀 통제하지 못한다. 그러므로 아래 주석은 바로 아래 함수가 아니라 시스템 어딘가에 있는 다른 함수를 설명하는 말이다.
  • 즉, 포트 기본값을 설정하는 코드가 변해도 아래 주석이 변하리라는 보장은 전혀 없다.

/**
 * 적합성 테스트가 동작하는 포트 : 기본값은 8082
 *
 * @Param fitnessePort
 */
public void setFitnessePort(int fitnessePort) {
	this.fitnessePort = fitnessePort;
}

• 너무 많은 정보
  • 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.

 

• 모호한 관계
  • 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.

 

• 함수 헤더
• 비공개 코드에서 Javadocs
  • 공개 API는 유용하지만 공개하지 않을 코드라면 쓸모 없다.