[Clean Code #5] 3. 함수

서론

• Setup과 Teardown

  Setup : 설정하다
  Teardown : 분해하다  

• 의도를 분명히 표현하는 함수를 어떻게 구현할 수 있는가?

• 함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있는가?

작게 만들어라!

함수를 만드는 첫째 규칙은 ‘작게!’ 다. 함수를 만드는 둘째 규칙은 ‘더 작게!’ 다.

함수가 한 화면을 넘어가면 안된다.

가로 150자를 넘어서는 안 된다. 함수는 100줄을 넘어서는 안 된다. 아니 20줄도 길다.

그렇다면 얼마나 짧아야 좋을까? 아래 코드 정도는 되어야 한다.

# 목록 3-3
public static String renderPageWithSetupsAndTeardowns( 
  PageData pageData, boolean isSuite) throws Exception { 
    if (isTestPage(pageData))
      includeSetupAndTeardownPages(pageData, isSuite); 
    return pageData.getHtml();
}

• 각 함수가 너무도 명백했다.

• 각 함수가 이야기 하나를 표현했다.

• 각 함수가 너무도 멋지게 다음 무대를 준비했다.

블록과 들여쓰기

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

한 가지만 해라

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

• 목록 3-3은 한 가지만 하는가? 아니면 세 가지를 하는가?

  위 함수는 간단한 TO 문단으로 기술할 수 있다.

  TO RenderPageWithSetupsAndTeardowns

  페이지가 테스트 페이지인지 확인 한 후 테스트 페이지라면 설정 페이지와 해제 페이지를 넣는다. 테스트 페이지든 아니든 페이지를 HTML로 렌더링한다.

• 함수가 ‘한 가지’만 하는지 판단하는 방법

  1. 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다.

  2. 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

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

함수가 확실히 ‘한 가지’ 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.

• 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.
• 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어렵기 때문이다.

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

한 함수 다음에는 추상화 수준 이 한 단계 낮은 함수가 온다.

위에서 아래로 TO 문단을 읽어내려 가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기가 쉬워진다.

핵심은 짧으면서도 ‘한 가지’만 하는 함수다.

추상화 수준이 하나인 함수를 구현하기란 쉽지 않다. 그렇지만 매우 중요한 규칙이다.

Switch문

(if/else가 여러개 이어지는 구문도 포함)

작게 만들기 어렵다. switch문을 완전히 피할 방법은 없다.

다형성

각 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는다.

SRP (Single Responsibility Principle)

• 한 단어에 한 개념만 써라

단일 책임 원칙(single responsibility principle)이란 모든 클래스는 하나의 책임만 가지며, 클래스는 그 책임을 완전히 캡슐화해야함을 일컫는다.

OCP(Open Closed Principle)

• 확장에 대해 열려 있다.
• 수정에 대해 닫혀 있다.

개방-폐쇄 원칙은 시스템의 구조를 올바르게 재조직(리팩토링)하여 나중에 이와 같은 유형의 변경이 더 이상의 수정을 유발하지 않도록 하는 것이다. 개방-폐쇄 원칙이 잘 적용되면, 기능을 추가하거나 변경해야 할 때 이미 제대로 동작하고 있던 원래 코드를 변경하지 않아도, 기존의 코드에 새로운 코드를 추가함으로써 기능의 추가나 변경이 가능하다.

다형적 객체를 생성하는 코드 안에서다. 상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다.

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

testableHtml → SetupTeardownIncluder. render 변경

• 함수가 하는 일을 좀 더 잘 표현하므로 훨씬 좋은 이름이다.
• 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
• 이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.

코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.

함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.

함수 인수

최선은 입력 인수가 없는 경우이며, 차선은 입력 인수가 1개뿐인 경우다.

출력 인수는 입력 인수보다 이해하기 어렵다.

• 흔히 우리는 함수에다 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙하다.

  num = sum(a, b) # 반환값
  sum(a, b, num) # 출력 인수 사용 -> 지양할 것 !

  Output Parameter에 대한 고찰
  

  출력 인수 지양하는 이유

  1. 개발자가 놓치게 되는 Side effect가 발생할 확률이 높다.
  2. Code 가독성이 떨어진다.

코드를 읽는 사람에게는 includeSetupPageInto(new PageContent)보다 includeSetupPage()가 이해하기 더 쉽다.
includeSetup PageInto(newPageContent)는 함수 이름과 인수 사이에 추상화 수준이 다르다.

많이 쓰는 단항 형식

함수에 인수 1개를 넘기는 이유

• 인수에 질문을 던지는 경우
• 인수를 뭔가로 변환해 결과를 반환하는 경우

→ 또한 언제나 일관적인 방식으로 두 형식을 사용한다. (56 “명령과 조회를 분리하라!” 참조)

이벤트 함수

• 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다.

• 이벤트 함수는 조심해서 사용한다. 이벤트라는 사실이 코드에 명확히 드러나야 한다. 그러므로 이름과 문맥을 주의해서 선택한다.

  
  

변환 함수

• [C++] Conversion Function | 변환 함수
• 입력 인수를 그대로 돌려주는 함수라 할지라도 변환 함수 형식을 따르는 편이 좋다. 적어도 변환 형태는 유지하기 때문이다.

플래그 인수

함수로 부울값을 넘기는 관례는 정말로 끔찍하다.
함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까!

→ 함수는 하나의 일만 해야하니까

이항 함수

인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.

어떤 코드든 절대로 무시하면 안된다.

무시한 코드에 오류가 숨어든다.

이항 함수가 적절한 경우

• 직교 좌표계 Point p = new Point(0,0)
  - 인수 2개는 한 값을 표현하는 두 요소인 경우
  - 두 요소에는 자연적인 순서가 있는 경우

이항 함수가 무조건 나쁘다는 소리는 아니다. 프로그램을 짜다보면 불가피한 경우도 생긴다. 하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항함수로 바꾸자.

삼항 함수

인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 순서, 주춤, 무시로 야기되는 문제가 두 배 이상 늘어난다. 그래서 삼항 함수를 만들 때는 신중히 고려하라 권고한다.

assertEquals(message, expected, actual)이라는 함수를 살펴보자.
첫 인수가 expected라고 예상하지 않았는가? 매번 함수를 볼 때마다 주춤했다가 message를 무시해야 한다는 사실을 상기했다.

인수 객체

인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언하자.

Circle makeCircle(double x, double y, double radius); //Bad
Circle makeCircle(Point center, double radius); //Good

변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.

인수 목록

인수 개수가 가변적인 함수

String.format("%s worked %.2f" hours.", name, hours)

public String format(String format, Object... args)
- format : "%s worked %.2f" hours."
- args : name, hours

가변 인수 전부를 동등하게 취급하면 List형 인수 하나로 취급할 수 있다.

동사와 키워드

단항 함수 : 함수와 인수가 동사/명사쌍을 이뤄야 한다.

• write(name)은 누구나 곧바로 이해한다. ‘이름 name’이 무엇이든 ‘쓴다 write’는 뜻이다.

함수 이름에 키워드 추가

• assertEquals보다 assertExpectedEqualsActual (expected, actual)이 더 좋다. 그러면 인수 순서를 기억할 필요가 없어진다.

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

부수효과

• 예상치 못하게 클래스 변수를 수정한다.
• 함수로 넘어온 인수나 시스템 전역 변수를 수정한다.

→ 시간적인 결합(temporal coupling)이나 순서 종속성(order dependency)을 초래한다.

만약 시간적인 결합이 필요하다면 함수 이름에 분명히 명시해야한다.

출력 인수

일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

appendFooter(s);  → report.appendFooter()

• 함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다.
• 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다. 출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다.

명령과 조회를 분리하라!

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

if (set("username", "unclebob"))...

무슨 뜻일까? 함수를 호출하는 코드만 봐서는 의미가 모호하다.

“set”이라는 단어가 동사인지 형용사인지 분간하기 어려운 탓이다.

set이라는 함수 이름을 setAndCheckIfExists라고 바꾸는 방법도 있지만 if문에 넣고 보면 여전히 어색하다.

진짜 해결책은 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법이다.

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

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

명령 함수에서 오류 코드를 반환하는 방식은 여러 단계로 중첩되는 코드를 야기한다.
오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.
오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

Try/Catch 블록 뽑아내기

try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.

public void delete(Page page) { try {
deletePageAndAllReferences(page); }
catch (Exception e) { logError(e);
} }

private void deletePageAndAllReferences(Page page) throws Exception { deletePage(page);
registry.deleteReference(page.name); configKeys.deleteKey(page.name.makeKey());
}

private void logError(Exception e) { logger.log(e.getMessage());
}

정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.

오류 처리도 한 가지 작업이다.

함수는 ‘한 가지’ 작업만 해야 한다. 오류 처리도 ‘한 가지’ 작업에 속한다. (ex) delete 함수

그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다.

Error.java 의존성 자석

오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.

의존성 자석

public enum Error { 
    OK,
    INVALID,
    NO_SUCH,
    LOCKED, 
    OUT_OF_RESOURCES, 
    WAITING_FOR_EVENT;
}

오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다. 따라서 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다. → OCP(Open Closed Principle)의 예시

의존성 자석이 뭔가요?

반복하지 마라! : DRY(Don’t Repeat Yourself) 원칙

​중복은 문제다. 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 중복된 곳을 모두 손봐야 하니까.
게다가 어느 한곳이라도 빠뜨리는 바람에 오류가 발생할 확률도 중복된 수만큼 높다.

중복을 없애면 모듈 가독성이 크게 높아진다.

중복은 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.

DRY 원칙

구조적 프로그래밍

모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야한다.

• 함수는 return 문이 하나여야 한다.
• 루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로, 절대로 안 된다.

비구조적 프로그래밍과 구조적 프로그래밍

구조적 프로그래밍은 함수가 아주 클 때만 상당한 이익을 제공한다.
함수를 작게 만든다면 단일 입출구 규칙(Single Entry-Exit Rule)보다 의도를 표현하기 쉬워진다.

함수를 어떻게 짜죠?

소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다.

서투르더라도 최초의 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.

그런 다음 나는 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다. 이 와중에도 코드는 항상 단위 테스트를 통과한다.

최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다. 처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.

결론

프로그래밍의 기술은 언제나 언어 설계의 기술이다.

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

프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.

함수를 잘 만드는 기교를 소개했다. 여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라.

진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하기 바란다.

여러분이 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다는 사실을 기억하기 바란다.