어떤 프로그램이든 가장 기본적인 단위가 함수다.
함수를 잘 만드는 법을 소개한다.
1. 작게 만들어라!
함수는 작을수록 좋다.
블록과 들여쓰기
if, while문에 들어가는 블록은 한 줄이어야 한다.
중첩 구조가 생길만큼 함수가 커져서는 안 된다.
1단이나 2단을 넘지 않으면 읽고 이해하기 쉬워진다.
2. 한 가지만 해라!
함수는 한 가지를 해야 한다.
그 한가지를 잘 해야 한다.
그 한 가지만을 해야 한다.
지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.
함수를 만드는 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서다.
의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 것이다.
- 함수 내 섹션
한 가지 작업만 하는 함수는 자연스럽게 섹션으로 나누기 어렵다.
3. 함수 당 추상화 수준은 하나로!
함수가 확실히 ‘한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.
- 위에서 아래로 코드 읽기: 내려가기 규칙
코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다.
4. Switch문
switch 문은 다형성 객체를 생성하는 코드 안에서 단 한번만 참아준다.
5. 서술적인 이름을 사용하라!
한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 달성함에 있어 이미 절반은 성공했다.
길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
이름을 붙일 때는 일관성이 있어야 한다.
모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.
예) includeSetupAndTeardownPages,
includeSetupPages,
includeSuiteSetupPage,
includeSetupPage
6. 함수 인수
함수에서 이상적인 인수 개수는 0개다.
다음은 1개고, 다음은 2개다. 3개는 가능한 피하는 편이 좋다.
4개 이상은 사용하면 안된다.
- 많이 쓰는 단항 형식
함수에 인수 1개를 넘기는 이유
- 인수에 질문을 던지는 경우 boolean fileExists(’myfile’)
- 인수를 뭔가로 변환해 결과를 반환하는 경우
-
플래그 인수
플래그 인수는 추하다.
함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이다. -
이항 함수
이항 함수가 적절한 경우는 두 요소에 한 값을 표현하고 자연적인 순서가 있을 때이다.
가능하면 단항 함수로 바꾸도록 애써야 한다. -
삼항 함수
인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다.
삼항 함수를 만들 때는 신중히 고려해야 한다. -
인수 객체
인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어 본다. -
인수 목록
가변 인수를 취하는 모든 함수에 같은 원리가 적용된다. -
동사와 키워드
단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
예) writeField(name)
함수 이름에 키워드를 추가하는 형식 (인수 순서를 기억할 필요가 없어진다.)
예) assertExpectedEqualsActual(expected,actual)
7. 부수 효과를 일으키지 마라!
부수 효과는 거짓말이다.
함수에서 한 가지를 하겠다고 약속하고서는 남몰래 다른 것도 하니까.
많은 경우 시간적인 결합(특정 상황에서만 호출이 가능)이나 순서 종속성을 초래한다.
- 출력 인수
일반적으로 출력 인수는 피해야 한다.
8. 명령과 조회를 분리하라!
함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다.
둘 다 하면 안 된다.
객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.
9. 오류 코드보다 예외를 사용하라!
명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.
- TRY/CATCH 블록 뽑아내기
오류 처리도 한 가지 작업이므로 함수로 뽑아내야 한다.
10. 반복하지 마라!
중복을 없애면 가독성이 크게 높아진다.
중복은 소프트웨어에서 모든 악의 근원이다.
11. 구조적 프로그래밍
데이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다.
하지만 함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다.
12. 함수를 어떻게 짜죠?
소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다.
처음에는 길고 복잡하지만 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다.
메서드를 줄이고 순서를 바꾼다. 클래스를 쪼개기도 한다.
최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다.
결론
대가 프로그래머는 시스템을 프로그램이 아니라 이야기로 여긴다.
여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라 하지만 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하기 바란다.
