[클린코드(CleanCode)] 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. 페이지를 HTML로 렌더링한다

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

이때는 TO 문단으로 설명이 가능하다:

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

함수의 의미를 유지하면서 더 이상 줄이기는 불가능하다.

if 문을 includeSetupsAndTeardownsIfTestPage라는 함수로 만든다면 똑같은 내용을 다르게 표현할 뿐 추상화 수준은 바뀌지 않는다.

 

'한 가지'를 판단하는 다른 방법이 있다.

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

함수 내 섹션

또한 함수가 여러 섹션으로 나뉜다면, 이는 그 함수가 여러 작업을 한다는 증거다. 한 가지 작업만 하는 함수는 자연스럽게 여러 섹션으로 나누기 어렵다.

---

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

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

 

한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.

특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어렵기 때문이다.

게다가 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.

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

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

 

다르게 표현하면, 일련의 TO 문단을 읽듯이 프로그램이 읽혀야 한다는 의미다. 예를 들면:

• TO 설정 페이지와 해제 페이지를 포함하려면, 설정 페이지를 포함하고, 테스트 페이지 내용을 포함하고, 해제 페이지를 포함한다.
• TO 설정 페이지를 포함하려면, 슈트이면 슈트 설정 페이지를 포함한 후 일반 설정 페이지를 포함한다.
• TO 슈트 설정 페이지를 포함하려면, 부모 계층에서 "SuiteSetUp" 페이지를 찾아 include 문과 페이지 경로를 추가한다.
• TO 부모 계층을 검색하려면, ...

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

 

추상화 수준이 하나인 함수를 구현하기란 쉽지 않다.

많은 프로그래머가 곤란을 겪는다.

그렇지만 매우 중요한 규칙이다.

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

---

switch 문

Switch 문의 사용을 자제하거나, 사용하더라도 숨긴다.

Switch 문은 그 특성상 작게 만드는 것이 아주 어렵다. 

또한 한 가지 일만 하는 Switch 문을 만드는 것도 어렵다. 

그래서 함수를 작성할 때는 Switch 문을 가급적이면 사용하지 않는 게 좋고 사용하더라도 저차원 클래스에 숨기는 것이 좋다.

---

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

💡 함수가 하는 일을 잘 표현하는 이름을 사용하라.

 

좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않다.

워드가 말했던 원칙을 기억하는가?

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

한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 달성함에 있어 이미 절반은 성공했다.

 

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

길고 서술적인 이름이 짧고 어려운 이름보다 좋다.

길고 서술적인 이름이 길고 서술적인 주석보다 좋다.

 

함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.

그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

 

이름을 정하느라 시간을 들여도 괜찮다.

이클립스나 인텔리제이 같은 최신 IDE에서 이름 바꾸기는 식은 죽 먹기다.

IDE를 사용해 이런저런 이름을 시도한 후 최대한 서술적인 이름을 골라도 좋겠다.

 

서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.

좋은 이름을 고른 후 코드를 더 좋게 재구성하는 사례도 없지 않다.

 

이름을 붙일 때는 일관성이 있어야 한다.

모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.

includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage, includeSetupPage 등이 좋은 예다.

문체가 비슷하면 이야기를 순차적으로 풀어가기도 쉬워진다.

---

함수 인수

💡 함수에서 이상적인 인수 개수는 0개(무항)이며, 그 다음은 1개(단항), 2개(이항) 순이다.

3개(삼항)는 가능한 피하고, 4개 이상(다항)은 특별한 이유가 있어도 사용하면 안 된다.

많이 쓰는 단항 형식

함수에 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지다:

1. 인수에 질문을 던지는 경우 (boolean fileExists("MyFile"))
2. 인수를 무언가로 변환해 결과를 반환하는 경우 (InputStream fileOpen("MyFile"))

또한 이벤트 함수도 유용한 단항 함수 형식이다. 이벤트 함수는 입력 인수만 있고 출력 인수는 없다. passwordAttemptFailedNtimes(int attempts)가 좋은 예다.

플래그 인수

함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까 플래그 인수도 추천하지 않는다

이항 함수

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

writeField(name)은 writeField(outputStream, name)보다 이해하기 쉽다.

하지만 이항 함수가 적절한 경우도 있다.

Point p = new Point(0, 0)가 좋은 예다.

여기서 인수 2개는 한 값을 표현하는 두 요소다.

삼항 함수

인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다.

순서, 주춤, 무시로 야기되는 문제가 두 배 이상 늘어난다.

인수 객체

인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다. 예를 들어:

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

이 두 함수의 인자를 비교하면 눈속임이라 생각할 수 있지만 아래 코드가 이름을 변경하여 개념을 포함하게 되어 괜찮아진다.

인수 목록

때로는 인수 개수가 가변적인 함수도 필요하다. String.format 메서드가 좋은 예다

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

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

이런 논리로 따져보면 String.format은 사실상 이항 함수다.

실제로 String.format 선언부를 살펴보면 이항 함수라는 사실이 분명히 드러난다.

public String format(String format, Object... args)

가변 인수를 취하는 모든 함수에 같은 원리가 적용된다.

가변 인수를 취하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있다.

하지만 이를 넘어서는 인수를 사용할 경우에는 문제가 있다.

void monad(Integer... args);
void dyad(String name, Integer... args);
void triad(String name, int count, Integer... args);

동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.

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

예를 들어, write(name)은 누구나 곧바로 이해한다.

 

함수 이름에 키워드를 추가하는 형식도 좋다.

assertEquals보다 assertExpectedEqualsActual(expected, actual)이 더 좋다.

그러면 인수 순서를 기억할 필요가 없어진다.

---

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

💡 부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까.

 

때로는 예상치 못하게 클래스 변수를 수정한다.

때로는 함수로 넘어온 인수나 시스템 전역 변수를 수정한다.

그러나 시간적인 결합(temporal coupling)이나 순서 종속성(order dependency)을 초래하는 경우가 많다.

출력인수

• 객체지향 프로그램이 이 나오기 전에는 출력 인수가 불가피한 경우도 있었다.
• 하지만 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다. 출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다.
• 일반적으로 출력 인수는 피해야 한다.
• 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

---

명령과 조회를 분리하라!

함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘 다 하면 안 된다.

객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다. 둘 다 하면 혼란을 초래한다.
해결책은 명령과 조회를 분리하는 방법이 있다.

---

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.
오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.
반면, 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

Try/Catch 블록 뽑아내기

try/catch 블록은 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다.
그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.
정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.

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

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

---

반복하지 마라!

중복된 구조는 코드 길이를 늘어나게 하고, 특정 부분을 수정할 때 똑같이 네 군데를 고쳐야 하는 문제를 발생시킨다. 

따라서 중복은 나오지 않도록 하는 것이 좋다.

많은 프로그래밍 원칙들이 중복을 없애고 제어하기 위해서 등장했다. 

• E. F. 커드는 자료에서 중복을 제거할 목적으로 관계형 데이터베이스에 정규 형식을 만들었다.
• 객체지향에서는 코드를 부모 클래스에 넣어 중복을 방지한다. 
• 구조적 프로그래밍, AOP, COP 같은 기법들도 어떻게 보면 중복 제거 전략이라고 할 수 있다. 

하위 루틴을 발명한 이래로 소프트웨어 개발에서 지금까지 일어난 혁신은 소스 코드에서 중복을 제거하려는 지속적인 노력으로 보인다.

---

구조적 프로그래밍

에츠허르 데잌스트라의 구조적 프로그래밍은 다음과 같다.

• 모든 함수와 함수 내 모든 블록의 입구와 출구는 하나여야 한다.(= 함수는 return이 하나여야 한다.)
• 루프 내에서 break나 continue는 사용하지 말고 goto는 절대로 사용하지 말라.

그러나 함수가 작다면 위 규칙은 별 이익을 제공하지 못한다

그러므로 함수가 아주 작다면 return, break, continue를 여러 차례 사용해도 괜찮다.

하지만 goto 문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야만 한다.

---

함수를 어떻게 짜죠?

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

• 논문이나 기사를 작성할 때는 먼저 생각을 기록한 후 읽기 좋게 다듬는다.
• 초안은 대개 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.

내가 함수를 짤 때도 마찬가지다:

• 처음에는 길고 복잡하다
• 들여쓰기 단계도 많고 중복된 루프도 많다
• 인수 목록도 아주 길다
• 이름은 즉흥적이고 코드는 중복된다

하지만 나는 그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.

그런 다음 나는:

• 코드를 다듬고
• 함수를 만들고
• 이름을 바꾸고
• 중복을 제거한다
• 메서드를 줄이고 순서를 바꾼다
• 때로는 전체 클래스를 쪼개기도 한다

이 와중에도 코드는 항상 단위 테스트를 통과한다.

최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다.

처음부터 탁 짜내지 않는다.

그게 가능한 사람은 없으리라.

---

결론

모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한 도메인 특화 언어(Domain Specific Language, DSL)로 만들어진다.

함수는 그 언어에서 동사며, 클래스는 명사다.

 

프로그래밍의 기술은 언제나 언어 설계의 기술이다. 예전에도 그랬고 지금도 마찬가지다.

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

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

시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 바로 그 언어에 속한다.

 

이 장은 함수를 잘 만드는 기교를 소개했다.

여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라.

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

 

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

---

글쓴이의 생각

이번 장의 핵심은 함수를 다른 사람들이 이해하기 쉽게 만드는 방법이다.

함수의 이름을 명확하게 하고 그 함수의 기능 자체도 단순하게 가져갔다.

심지어 인수부터 출력까지 세세히 다루니 유용한 내용들이 많았다.

그러나 switch 문을 사용하지 말라는 말은 동의하기 어려웠다.

물론 이 책의 서론에서 이것이 진리라는 것은 아니다.

본인과 그 환경에 맞게 맞추어 나가는 것이 중요하다. 다른 곳에서는 이게 더 명확하고 이해하기 쉬울 수 있으니까.