[Clean Code] 3장. 함수

본 글은 Robert C. Martin의 Clean Code를 읽고 작성자 마음대로 정리한 글입니다.
책 내에 등장하는 코드는 코틀린으로 변환하였으며, 모든 질문 및 태클 환영합니다!

---

어떤 프로그램이든 가장 기본적인 단위가 함수다.

이 장은 함수를 잘 만드는 법을 소개한다.

 

다음 코드를 살펴보자. (Fitnesse)

길이가 길 뿐만 아니라 중복된 코드에, 괴상한 문자열에, 낯설고 모호한 자료 유형과 API가 많다.

 

(원문 코드의 복잡성을 더 잘 나타내기 위해 코틀린으로 변환하지 않았다.)

 

추상화 수준도 너무 다양하고, 코드도 너무 길다.

두 겹으로 중첩된 if 문은 이상한 플래그를 확인하고, 이상한 문자열을 사용하며, 이상한 함수를 호출한다.

 

하지만 메서드 몇 개를 추출하고, 이름 몇 개를 변경하고, 구조를 조금 변경하면 아래와 같은 코드가 나온다.

다음 코드는 함수 의도를 코드 9줄로 표현한다.

 

 

FitNesse에 익숙하지 않은 이상 코드를 100% 이해하기는 어렵다.

그래도 함수가 설정^setup 페이지와 해제^teardown 페이지를 테스트 페이지에 넣은 후 해당 테스트 페이지를 HTML로 렌더링한다는 사실은 짐작할 수 있다.

처음 코드에서 파악하기 어려웠던 정보가 아래 코드에서는 쉽게 드러난다.

 

그렇다면 아래의 코드가 읽기 쉽고 이해하기 쉬운 이유는 무엇일까?

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

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

---

작게 만들어라!

함수를 만드는 첫째 규칙은 '작게!'다.

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

 

각 함수는 명백하고, 하나의 이야기만을 표현하며, 다음 상황을 준비해야 한다.

 

그렇다면 함수는 얼마나 짧아야 하는가?

 

다음은 위의 코드를 다시 한번 줄인 코드이다.

 

 

블록과 들여쓰기

if 문 / else 문 / while 문 등에 들어가는 블록은 한 줄이여야 한다는 의미다.

대게 거기서 함수를 호출한다.

그러면 바깥을 감싸는 함수^{enclosing function}가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면 코드를 이해하기도 쉬워진다.

 

다시 말해, 중첩 구조가 생길만큼 함수가 커져서는 안된다는 뜻이다.

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

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

 

---

한 가지만 해라!

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

'한 가지'가 무엇인지 알기 어렵다.

 

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

함수를 만드는 이유는 큰 개념을 (다시 말해, 함수 이름을) 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서이다.

 

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

 

---

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

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

 

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

특정 표현이 근본 개념인지 아니면 세부 사항인지 구분하기 어려운 것에 그치지 않고.

깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.

 

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

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

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

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

이것이 내려가기 규칙이다.

 

---

Switch 문

switch 문은 작게 만들기 어렵다.

또한 '한 가지' 작업만 하는 switch 문도 만들기 어렵다.

본질적으로 switch 문은 N가지를 처리한다.

다형성^polymorphism을 이용하여 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다.

 

 

위 함수에는 몇 가지 문제가 있다.

1. 함수가 길다. 새 직원 유형을 추가하면 더 길어진다.
2. '한 가지' 작업만 수행하지 않는다.
3. SRP^{Single Responsibility Principle}을 위반한다. 코드를 변경할 이유가 여럿이기 때문이다.
4. OCP^{Open Closed Principle}을 위반한다. 새 직원 유형을 추가할 때마다 코드를 변경하기 때문이다.

그러나  가장 큰 문제는 위 함수와 구조가 동일한 함수가 무한정 존재한다는 사실이다.

예를 들어, 다음과 같은 함수가 가능하다.

 

혹은

 

 

가능성은 무한하다. 그리고 모두가 똑같이 유해한 구조다.

 

다음 코드는 이 문제를 해결한다. 

switch 문을 추상 팩토리^{ABSTRACT FACTORY}에  숨긴다.

팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다.

calculatePay, isPayday, deliverPay 등과 같은 함수는 Employee 인터페이스를 거쳐 호출된다.

그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.

 

 

다형적 객체를 생성하는 코드 안에서 switch 문을 한 번만 사용하는 것이 좋겠다.

상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다.

물론 불가피한 상황도 생긴다.

(코틀린에서 when과 sealed class의 조합은 환상적이다.)

 

---

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

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

 

이름이 길어도 괜찮다.

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

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

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

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

 

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

이런저런 이름을 넣어 코드를 읽어 보면 더 좋다.

 

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

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

 

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

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

 

---

함수 인수

함수에서 이상적인 인수 개수는 0개(무항)다.

다음은 1개(단항)고, 다음은 2개(이항)다.

3개(삼항)는 가능한 피하는 편이 좋다.

4개 이상(다항)은 특별한 이유가 필요하다.

특별한 이유가 있어도 사용하면 안 된다.

 

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

 

많이 쓰는 단항 형식

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

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

함수 이름을 지을 때는 두 경우를 분명히 구분한다.

또한 언제나 일관적인 방식으로 두 형식을 사용한다.

 

이벤트로써 함수를 사용하는 경우 이벤트라는 사실이 코드에 명확히 드러나야 한다.

 

지금까지의 경우가 아니라면 단항 함수는 가급적 피한다.

변환 함수에서 출력 인수를 사용하면 혼란을 일으킨다.

입력 인수를 변환하는 함수라면 변환 결과는 반환값으로 돌려준다.

transform(in: StringBuffer): StringBuffer이 transform(out: StringBuffer)보다 좋다.

 

 

플래그 인수

플래스 인수는 추하다.

함수가 한꺼번에 여러 가지를 처리한다는 뜻이 된다.

 

 

이항 함수

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

 

Point(0, 0)과 같이 인수 2개가 한 값을 표현하거나 자연적인 순서가 있지 않는 이상,

2개의 인수에는 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다.

 

 

삼항 함수

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

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

그래서 삼항 함수를 만들 때는 신중히 고려하라 권고한다.

 

 

인수 객체

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

예를 들어, 다음 두 함수를 살펴보자

 

 

객체를 생성해 인수를 줄이는 방법이 눈속임이라 여겨질지 모르지만 그렇지 않다.

위 예제에서 x와 y를 묶었듯이 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.

 

인수 목록

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

 

 

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

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

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

 

 

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

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

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

 

 

 

동사와 키워드

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

 

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

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

'이름^name'이 무엇이든 '쓴다^write'는 뜻이다.

좀 더 나은 이름은 writeField(name)이다.

그러면 '이름^name'이 '필드^field'라는 사실이 분명히 드러난다.

 

마지막 예제는 함수 이름에 키워드를 추가하는 형식이다.

즉, 함수 이름에 인수 이름을 넣는다.

ex) assertEquals -> assertExpectedEqualsActual(expected, actual)

 

---

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

부수 효과는 거짓말이다.

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

 

시간적인 결합^{temporal coupling}이나 순서 종속성^{order dependency}을 초래한다.

 

다음 예제를 살펴보자.

함수는 표준 알고리즘을 사용해 userName과 password를 확인한다.

두 인수가 올바르면 true를 반환하고 아니면 false를 반환한다.

하지만 함수는 부수 효과를 일으킨다.

 

 

여기서 함수가 일으키는 부수 효과는 Session.initialize() 호출이다.

checkPassword 함수는 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다.

그래서 함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다.

 

이런 부수 효과가 시간적인 결합을 초래한다.

즉 checkPassword 함수는 특정 상황에서만 호출이 가능하다.

 

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

checkPasswordAndInitializeSession이라는 이름이 훨씬 좋다.

물론 '한 가지'만 한다는 규칙을 위반한다.

 

 

출력 인수

일반적으로 우리는 함수를 함수 입력으로 해석한다.

 

 

함수 선언부를 보기 전까지는 s가 출력 인수임을 알 수 없다.

함수 선언부를 찾아보는 행위는 인지적으로 거슬리므로 피해야 한다.

 

객체 지향 언어에서는 this가 존재하기 때문에 출력 인수를 사용할 필요가 거의 없다.

다시 말해, appendFooter는 다음과 같이 호출하는 방식이 좋다.

 

 

일반적으로 출력 인수는 피해야 한다.

함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

 

---

명령과 조회를 분리하라!

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

객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.

다음 함수를 살펴보자.

 

 

이 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true를 반환하고 실패하면 false를 반환한다.

그래서 다음과 같이 괴상한 코드가 나온다.

 

 

독자 입장에서 코드를 읽어보자.

"username"이 "unclebob"으로 설정되어 있는지 확인하는 코드인가?

아니면 "username"을 "unclebob"으로 설정하는 코드인가?

함수를 호출하는 코드만 봐서는 의미가 모호하다.

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

 

함수를 구현한 개발자는 "set"을 동사로 의도했다.

하지만 if 문에 넣고 보면 형용사로 느껴진다.

 

이러한 혼란을 방지하기 위해 명령과 조회를 분리해야 한다.

 

 

---

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

이 파트에 앞서, 코틀린에서는 Checked Exception이 존재하지 않는다는 것을 알고 가시면 좋겠습니다.

(https://kotlinlang.org/docs/exceptions.html#checked-exceptions)

 

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

 

 

위 코드는 동사/형용사 혼란을 일으키지 않는 대신 여러 단계로 중첩되는 코드를 야기한다.

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

 

 

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

 

 

Try/Catch 블록 뽑아내기

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

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

 

 

위에서 delete 함수는 모든 오류를 처리하므로 이해하기 쉽다.

실제로 페이지를 제거하는 함수는 deletePageAndAllReferences이며 이 함수는 예외를 처리하지 않는다.

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

 

 

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

함수는 '한 가지' 작업만 해야 한다. 오류 처리도 '한 가지' 작업에 속한다.

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

 

 

Error.kt 의존성 자석

오류 코드를 반환 한다는 것은, 클래스든 열거형 변수든 어디선가 오류 코드를 정의해야 한다는 것을 의미한다.

 

 

위와 같은 클래스는 의존성 자석^magnet이다. 

다른 클래스에서 Error enum을 import해 사용해야 하므로, 

Error enum이 변한다면 Error enum을 사용하는 클래스 전부를 다시 컴파일하고 다시 배치해야한다.

 

오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다.

따라서 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다. (OCP^{Open Closed Principle})

 

---

반복하지 마라!

중복된 코드가 많을수록 코드 길이가 늘어날 뿐만 아니라 알고리즘이 변하면 손봐야 하는 곳이 많아진다.

또한 중복을 없앨수록 모듈 가독성이 크게 높아진다.

 

---

구조적 프로그래밍

에츠허르 테이크스트라^{Edsger Dijkstra}의 구조적 프로그래밍 원칙

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

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

 

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

 

함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다.

오히려 때로는 단일 입/출구 규칙^{single entry-exit rule}보다 의도를 표현하기 쉬워진다.

 

---

함수를 어떻게 짜죠?

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

초안은 서투르고 어수선하므로 원하는대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.

 

함수를 짤 때도 마찬가지이다.

처음에는 길고 복잡하지만 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거하는 과정을 통해 더 나은 코드를 얻을 수 있다.

 

---

결론

모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한 도메인 특화 언어^{Domain Specific Language, DSL}로 만들어진다. 함수는 그 언어에서 동사이며, 클래스는 명사다. 요구사항 문서에 나오는 명사와 동사를 클래스와 함수 후보로 고려하자는 옛 규칙을 언급하는 것이 아니다. 프로그래밍의 기술은 언제나 언어 설계의 기술이다.

 

시스템을 구현해야 하는  프로그램이 아니라 풀어갈 이야기로 여겨라.

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