[Clean Code] 클린코드 - 03장. 함수

6 분 소요

클린 코드 개발도서 관련 : 3장 함수는 어떻게 작성해야 하는지 살펴보자.

들어가며

함수를 읽기 쉽고 이해하기 쉽게 만드는 방법은 무엇일까?

어떻게하면 의도를 분명히 표현하는 함수를 구현할 수 있을까?

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

이러한 질문들을 해결하는 방법에 대해 알아보자.

작게 만들어라!

함수를 만드는 첫째 규칙은 작게 만드는 것이다.

이는 근거를 대기 어려운 주장이지만 저자는 오랜 시행착오를 바탕으로 작은 함수가 좋다는 확신을 갖게 되었다고 한다.

블록과 들여쓰기

중첩 구조가 생길만큼 함수가 커져서는 안된다.

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

그래야 함수는 읽고 이해하기 쉬워진다.

한 가지만 해라

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

그러나 문제는 그 한 가지가 무엇인지 알기가 어렵다는 것이다.

저자는 다음과 같이 ‘한 가지’에 대해 설명하고 있다.

지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.

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

한 가지 작업만 하는 함수는 자연스럽게 섹션으로 나누기 어렵다.

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

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

함수 내 추상화 수준을 섞으면 읽는 사람도 헷갈려진다.

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

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

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

코드는 위에서 아래로 이야기 처럼 읽혀야 좋다.

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

즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다.

이것을 저자는 ‘내려가기 규칙‘이라고 부른다고 한다.

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

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

Switch 문

switch 문은 본질적으로 N가지 작업을 처리한다.(본질부터가 ‘한 가지’ 작업 실패)

불행히 switch 문을 완전히 피할 방법은 없다. 하지만 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다.

다형성을 이용한다.

저자는 일반적으로 다형성 객체를 생성하는 코드 안에서만 switch 문을 허용해준다고 한다.

서술적인 이름을 사용하라

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

워드가 말했던 원칙을 다시 빌리자면,

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

한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 쉽게 달성할 수 있다.

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

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

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

함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

최대한 서술적인 이름을 고르는 것도 괜찮다. 서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드 개선이 쉬워진다.

함수 인수

함수 인수 갯수

0개 : 무항, 이상적인 인수 개수
1개 : 단항
2개 : 이항
3개 : 삼항, 가능한 피하는 편이 좋음
4개 이상 : 다항, 특별한 이유가 필요. 이유가 있다한들 사용하면 안 됨

인수는 어렵다. 인수는 개념을 이해하기 어렵게 만든다.

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

많이 쓰는 단항 형식

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

인수에 질문을 던지는 경우 : boolean isExist("some")
인수를 뭔가로 변환해 결과를 반환하는 경우 : InputStream fileOpen("MyFile")

단항 함수도 가급적 피하는게 좋다.

플래그 인수

플래그 인수는 추하다.

함수로 부울 값을 넘기는 관례는 정말 끔찍하다.

왜냐하면, 함수가 여러 가지를 처리한다고 대놓고 공표하는 셈이기 때문이다.

플래그가 참이면 이걸 하고 거짓이면 저걸 한다는 말이기 때문이다.

doSomething(boolean isTrue) -> doSomethingTrue(), doSomethingFalse()

위 처럼 함수를 나누는 것이 마땅하다.

이항 함수

이항 함수는 무조건 나쁜것은 아니다. 불가피한 경우가 있다.

그러나 위험이 따른다는 사실을 이해하고 가능하면 단항함수로 바꾸도록 애써야 한다.

삼항 함수

순서, 주춤, 무시로 야기되는 문제가 발생한다.

삼항 함수를 만들 때는 신중히 고려하자.

인수 객체

인수가 2~3개 필요하다면 일부 독자적인 클래스 변수로 선언할 가능성을 가져라.

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

객체를 생성해 인수를 줄이는 방법이 눈속임이라 생각할진 몰라도 그렇지 않다.

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

동사와 키워드

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

예를 들면,

boolean assertEquals(expected, actual); // bad
boolean assertExpectedEqualsActual(expected, actual); // good

위 예제와 같이 함수 이름에 인수를 넣어 인수의 순서를 기억할 필요가 없도록 만들 수 있다.

부수 효괄르 일으키지 마라

부수 효관느 거짓말이다.

함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하기 때문이다.

checkPassword라는 함수가 있다고 하자. 그런데 해당 함수는 안에서 password 유효성 검증이 통과 되면 Session.initialize()를 수행한다. 과연 이 함수를 사용하는 개발자는 이런 발칙한 행동을 한다는걸 알고 있을까??

즉, 세션을 초기화해도 괜찮은 상황에만 호출이 가능한 함수이다. 잘못 호출할 경우 의도와 다르게 세션 정보가 날아갈 수 있다. 이런 걸 시간적 결합(Temporal Coupling)이라고 부른다.

만약, 이렇게 시간적 결합이 필요하다면 함수 이름에 분명히 명시하는 것이 좋다. 마치 checkPasswordAndInitializeSession과 같이 말이다. (물론 이 경우도 ‘한 가지’만 한다는 규칙을 위반했다.)

명령과 조회를 분리하라

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

둘 다 하면 혼란을 초래한다.

public boolean set(String attribute, String value);

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

만약, set 함수가 위와 같이 사용된다면 어떨 것 같은가. 함수의 의미가 모호하다. set이 동사인지 형용사인지 분간이 어렵기 때문이다.

set만 보면 동사지만 if문 안에 사용된 것을 보면 형용사처럼 느껴진다.

해결책은 명령과 조회를 분리하여 혼란을 없애는 것이다.

```java
if (attributeExists("userName") {
    setAttribute("userName", "unclebob");
}

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

명령 함수에서 오류 코드를 반환하는 방식은 ‘명령/조회 분리 규칙’을 미묘하게 위반한다.

if (deletePage(page) == E_OK) ...

오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.

반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

try {
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}
catch (Exception e) {
    logger.log(e.getMessage());
}

Try/Catch 블록 뽑아내기

try/catch 블록은 원래 추하다.

코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다.

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

try {
    deletePageAndReferences(page);
}
catch (Exception e) {
    logError(e);
}

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

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

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

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

함수는 ‘한 가지’ 작업만 해야 한다.

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

반복하지 마라

DRY(Don’t Repeat Yourself) 원칙

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

많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.

구조적 프로그래밍

데이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말한다.

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

구조적 프로그래밍의 목표와 규율은 공감하지만 함수가 작다면 위 규칙은 별 이익을 제공하지 못한다. 함수가 아주 클 때만 상당한 이익을 제공한다.

그러므로 함수를 작게 만든다면 간혹 return, break, continue 를 여러 차례 사용해도 괜찮다. 오히려 입/출구 규칙을 지킬 때 보다 의도를 표현하기 쉬워질 때가 있다.

반면, goto 문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 사용하지 말자.

함수를 어떻게 짜죠?

처음에는 함수를 서투른 상태로 작성을 한다.

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

그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다.

메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다.

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

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

처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.

고찰

평소 함수를 작성할 때 최대한 한 함수에 하나의 작업만 수행하도록 아주 작은 단위로 만들려고 노력한다.
그리고 함수의 가독성을 높이기 위해 한 함수의 줄 수가 10줄이 넘지 않고 indent depth가 2를 넘지 않게 하기 위해 노력한다.

이러한 것들이 객체지향 생활체조 원칙에 명시되어 있고 본인도 해당 원칙이 와닿았기 때문에 최대한 따르려고 노력하고 있다.

그러나 혹자는 왜 이렇게 함수와 클래스를 많이 만들며 굳이 그러한 원칙을 지키는지에 대해 의문을 가질 수 있다.
물론 스타일의 차이라고는 생각하지만 본인은 그것이 원칙이기 때문에 지킨다기 보다는 그렇게 했을 때 정말 효과를 보았기 때문이다.
일단 함수가 길어지면 읽기 싫어지고, 읽는다 해도 중간 쯤 집중력이 흐려지고 글의 흐름을 잃게 된다.

물론 해당 원칙이 좋은 점만 있는 것도 아니다.
정말로 함수가 많아지고 클래스가 많아지게 되면 이를 재사용 하기 위해 수 많은 소스 파일들을 뒤져야 한다.
이는 분리된 함수와 클래스를 어떻게 관리해야 효율적인지 파악하지 못했기 때문이다.

이러한 원칙을 강조하기 보다는 스스로 경험을 쌓아 많은 사람들이 공감할 수 있는 결과를 보여준다면 진가를 알아보고 함께 해주지 않을까 싶다.

⬅️ 클린코드 목차보기

Twitter Facebook LinkedIn

Tony Jun