[클린 코드] #3 함수

클린 코드 #3 함수

#클린코드

40줄이 넘는 FitNesse 함수 코드를 9줄로 리팩터링 했더니 이해하기 매우 쉬워졌다.
이해가 쉬운 이유가 무엇일까?
의도를 분명히 표현하는 함수를 어떻게 구현할 수 있을까?
어떤 속성을 부여애햐 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까?

작게 만들어라

함수 코드 라인 20줄도 길다. 함수의 의도가 명백하게 드러나도록 최대한 작게 만들어라.

블록과 들여쓰기

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

한 가지만 해라

함수는 한가지를 해야 하고, 그 한 가지를 잘 해야 한다. 한 가지만 해야 한다.

한 가지 일이 뭔가요?
: 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.
: 어쨌거나 우리가 함수를 만드는 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서이다.

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

함수 내 섹션

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

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

함수가 한 가지 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
안 그러면 읽는 사람이 헷갈린다. 한 번 다른 추상화 수준끼리 섞이면 더 지저분해 진다.

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

코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.

핵심은 짧으면서 한 가지만 하는 함수이다. 이렇게 구현하면 추상화 수준을 일관되게 유지하기 쉬워진다.

Switch문

switch문을 어떻게 작게 만들 수 있을까?
switch문을 완전히 피할 수 있는 방법은 없다. 하지만 각 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법을 사용할 수 있다. 다형성을 사용하면 된다.

switch 문을 추상 팩토리에 꽁꽁 숨긴다. 팩토리에서는 switch문을 사용해 파생 클래스(알바, 계약직)의 인스턴스를 생성해준다. 결국에는 이 팩토리를 통해 인스턴스를 받아서 실제 파생 클래스의 함수가 실행된다.

저자는 switch문은 딱 한 번 다형적 객체를 생성하는 코드 안에서만 허용한다고 한다. 상속 관계로 숨긴 후에는 절대 사용하지 않는다고 한다. 물론 지키지 못하는 불가피한 상황도 생긴다고 한다.

서술적인 이름을 사용하라

1장에서 봤듯이 좋은 이름이 주는 가치는 대단하다. 함수가 작고 단순할 수록 서술적인 이름을 고르기 쉬워진다.
함수 이름을 보고 짐작한 내용이 코드에 녹아있어야 한다.

이름이 길어도 괜찮다. 짧고 어려운 이름보단 훨씬 좋다. 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용하자. 그 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택해야 한다.

이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.

• 예시
  • includeSetupAndTeardownPages
  • includeSetupPage
  • includeSuiteSetupPage

함수 인수

이상적인 인수 개수는 0개이다. 4개 이상은 Never 사용하지 말자.

왜 인수를 줄여야 할까?
인수는 개념을 이해하기 어렵게 만든다.
인수의 이름을 읽을 때마다 인수의 의미를 해석해야 한다.(파라미터로 넘어온 거니까…)
그리고 함수 이름과 인수 사이에 추상화 수준이 달라질 수 있다.

테스트 케이스 작성할 때도 인수는 테스트를 어렵게 만든다.

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

많이 쓰는 단항 형식

인수 1개를 넘기는 이유

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

이 두 케이스에 대해서는 독자가 쉽게 받아들일 수 있다. 함수 이름을 지을 때는 두 경우를 분명이 구분짓자.

아주 유용한 단항 함수 형식이 이벤트이다. 이벤트 함수는 입력 인수만 있고 출력 인수는 없다. 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다. 이벤트 함수는 조심해서 사용하고, 이벤트라는 사실이 코드에 드러나야 한다.

위 케이스가 아니라면 단항 함수는 피해야 한다.
변환 함수에서는 출력 인수를 사용하면 혼란을 준다. 리턴 값으로 돌려줘야지, 출력 인수를 사용하면 매우 혼란스러워진다.

플래그 인수

쓰지 말자. 함수가 여러가지 책임이 있다고 말하는 꼴이다.

이항 함수

이항 함수는 무항 함수, 단항 함수보다 이해하기 어렵다. 물론 이항 함수를 써야 할 때도 있다.
좌표를 생성하는 경우를 생각해보자. 좌표에는 자연적인 순서도 있기 때문에 그래도 나은 편이다.

assertEquals(expected, actual)인데, 실수로 expected에 actual 값을 넣는 실수가 정말 많다. 두 인수에 자연적인 순서가 없어서이다. expected 다음 actual이라는 사실을 기억해야 한다.

이항 함수가 무조건 나쁜 건아니다. 어쩔 수 없이 써야할 수도 있다. 하지만 최대한 단항 함수로 바꾸도록 노력해야 한다.

삼항 함수

이항 함수보다 훨씬 이해하기 어렵다. assertEquals(mesage, expected, actual)이라는 함수를 살펴보자. 매 번 함수를 볼 때 마다 message를 무시해야 한다는 사실을 상기해야 한다.

참고) 최근 스펙에서는 message 인수가 제일 뒤에 온다. 책 내용이 오래되서 현재와는 조금 차이가 있다.

인수 객체

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

인수 목록

때로는 인수 개수가 가변적인 함수도 필요하다. String.format을 생각해봐라.
가변 인수 자체가 하나의 인수이다. 그런데 가변 인수가 포함되어 있고, 이항, 삼항을 넘어서 사용하면 문제가 있다.

동사와 키워드

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

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

또한 함수 이름에 키워드를 추가할 수도 있다.
assertEquals보다 assertExpectedEqualsActual(expected, actual)이 더 좋다.

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

함수에서 한 가지 일만 하겠다고 해놓고 다른 일을 하지 말라는 말이다.

출력 인수

appendFooter(s)가 있다. s가 입력 인수 인지 출력 인수인지 바로 확인할 수 있을까? X

함수의 선언부를 확인해야 한다. public void appendFooter(StringBuilder report)
함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다. 피해야 한다.

객체 지향 언어가 나오고 나서 부터 출력 인수는 거의 필요한 경우가 없다. this를 사용하면 되기 때문이다.
appendFooter(s) 대신 report.appendFooter()를 사용하면 되는 것이다.

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

명령과 조회를 분리하라.

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

member라는 객체의 상태를 변경했다면, 변경만 해야 한다. 변경하고 반환까지 하면 안 된다.

명령과 조회는 반드시 분리하자.

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.
자칫하면 if문 안에서 명령을 표현식으로 사용하기 쉬운 탓이다.

if (deletePage(page) == E_OK)

위 코드는 여러 단계로 중첩되는 코드를 야기한다. 오류 코드를 반환하면 호출자는 오류 코드를 바로 처리해야 한다는 문제에 부딪힌다.

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

Try/Catch 블록 뽑아내기

try/catch 블록은 사실 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다.
따라서 try블록과 catch 블록을 별도 함수로 뽑아내는 것이 좋다.

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

함수는 한 가지 일만 해야 하는데, 오류 처리도 한 가지 작업에 속한다. 따라서 오류를 처리하는 함수는 오류만 처리해야 마땅하다. 함수에 키워드 try가 있으면 이 함수는 try로 시작해 catch/finally 문으로 끝나야 한다.

Error.java 의존성 자석

오류 코드를 반환한다는 이야기는 어디선가 오류 코드를 정의한다는 뜻이다. 결국 오류 코드를 정의한 곳에서 수정하면 사용하는 곳에서 수정하고 다시 컴파일하고 다시 배치해야 한다.

따라서 새로운 오류 코드를 추가하는 대신 기존 오류코드를 재사용한다.

물론 오류 코드 대신 예외를 사용하면 Exception 클래스에서 파생되므로, 새 예외 클래스를 추가 해줄 수 있다.

반복하지 마라.

네 곳에서 코드가 중복되고 있다고 하자.
중복되면 코드 길이가 늘어날 뿐만 아니라 알고리즘이 변하면 네 곳을 모두 손봐야 한다. 만약 어느 한 곳이라도 빠트리면 큰일난다.

OOP에서는 코드를 부모 클래스로 몰아서 중복을 없앨 수 있다. 구조적 프로그래밍, AOP, COP 모두 중복 제거 전략이다.

구조적 프로그래밍

다익스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다. 즉, return 문은 하나여야 한다는 말이다. 루프 안에서 break, continue를 사용하지 말고, goto는 절대로, 절대로 안 된다.

이 구조적 프로그래밍의 목표와 규율은 함수가 클 때 상당한 이익을 제공한다.
함수를 작게 만든다면 return, break, continue를 여러 차례 사용해도 괜찮다. goto는 작은 함수에서 무조건 피해야 한다.

함수를 어떻게 짜죠?

SW를 짤 때 논문이나 기사를 작성할 때 처럼 먼저 생각을 기록한 후 읽기 좋게 다듬는다. 초안을 적고 원하는대로 읽힐 때 까지 말을 다듬고 문장을 고치고 문단을 정리한다.

함수도 마찬가지다. 초안은 길고 복잡할 수 있다. 들여쓰기도 많고 루프 중첩도 많다. 유닛 테스트까지 만든다.
그 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다.
이렇게 하더라도 코드는 항상 유닛 테스트를 통과한다.

처음부터 위에서 다뤘던 규칙을 따르는 함수를 모두 따르도록 만들 수 있는 사람은 거의 없다.

결론

함수를 잘 짜는 방법을 배웠다. 하지만 진짜 목표는 “시스템”이다. 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아 떨어져야 이야기를 풀어가기 쉬워진다.