README.md

3장 함수

함수를 읽기 쉽고, 의도를 분명히 표현하며, 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있게 하는 방법.

프로그래머는 시스템을 "구현할" 프로그램이 아니라 "풀어갈" 이야기로 여긴다. 프로그래밍 언어라는 수단을 이용해 좀 더 풍부하고, 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.
- 62p -

작게 만들어라

• 함수가 작았을 때 더 좋다는 근거는 없지만 수많은 시행착오 결과 함수는 작을수록 좋다.
• 들여쓰기 수준은 1~2단을 넘어서지 않아야 한다.

한 가지만 해라

• 함수는 한 가지'만' 해야하고, 그 한가지를 '잘' 해야한다.
• 함수가 하는 일의 개수는 함수 이름 아래 추상화 수준의 개수를 의미한다.(함수 이름 아래에서 추상화 수준이 한 가지라면, 그 함수는 한가지를 하고 있다.)
• 만약 함수에서 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하고 있다.

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

• 함수 내에서 사용된 문장들은 동일한 추상화 수준을 가져야 한다.
• 코드는 위에서 아래로 이야기처럼 읽혀야 좋다.(내려가기 규칙)

Switch 문

• Switch 문이나 if/else 가 여럿 이어지는 구문은 작게 만들기 어렵다.
• 다형성(polymorphism)을 이용하여 Switch 문은 저차원 클래스에 숨기고 절대로 반복하지 않게 한다.

서술적인 이름을 사용하라

• 길고 서술적인 이름은 짧고 어려운 이름보다 좋고, 길고 서술적인 주석보다 좋다.
• 함수 이름을 정할 땐 여러 단어가 쉽게 읽히는 명명법을 사용하고, 여러 단어를 사용해 함수의 기능을 잘 표현하는 이름을 선택한다.
• 같은 문구, 명사, 동사를 사용하여 일관성 있게 이름을 짓는다.

함수 인수

• 함수에서 이상적인 인수 개수는 0개로, 3개는 지양, 4개는 사용하지 말아야 한다.
• 인수는 개념을 이해하기 어렵게 만들고 테스트를 어렵게 한다.

많이 쓰는 단항 형식

1. 인수에 질문을 던지는 경우 (ex.boolean fileExists("MyFile"))
2. 이벤트 함수 (ex.passwordAttempFailedNTimes(int attempts))
   • 이벤트 함수는 입력 인수만 있고 출력 인수는 없다.
   • 이벤트라는 사실이 명확히 드러나도록 이름과 문맥을 주의해 사용해야 한다.

플래그 인수

• 플래그 인수를 쓴다는 건 함수가 한꺼번에 여러 가지를 처리한다는 것과 같으므로 지양한다.

이항 함수

• 직교 좌표계 점처럼 이항 함수가 더 적절한 경우도 있지만 보통 단항 함수가 더 이해하기 쉽고 위험 부담이 적다.
• 이항 함수로 쓸 경우, 인수가 한 값을 표현하지 않을 위험, 자연적인 순서가 없어 혼란을 야기할 위험 등이 존재한다는 점을 이해해야 한다.

삼항 함수

• 삼항 함수부터는 이항 함수에서 야기되는 문제가 두 배 이상 늘어나므로 신중히 고려해야 한다.

인수 객체

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

인수 목록

• 때로는 String.format 메서드처럼 인수 개수가 가변적인 함수도 필요하다.
• 가변 인수를 취하는 모든 함수에서 가변 인수 전부를 동등하게 취급하면 결국 List 형 인수 하나로 취급할 수 있기 때문에 이항, 삼항 함수로 취급하는 것이 가능하다. 단 이를 넘어서는 인수를 사용하면 문제가 될 수 있다.

동사와 키워드

• 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
• 함수에 인수 이름과 같은 키워드를 사용하면 순서와 의도를 잘 나타낼 수 있다.

부수 효과를 일으키지 마라

• 부수 효과는 함수에서 한 가지 이외의 일을 수행하게 하고 시간적 결합(temporal coupling), 순서 종속성(order dependency)을 초래한다.

출력 인수

• 일반적으로 우리는 인수를 함수 입력으로 해석하므로 출력 인수를 지양한다.
• 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 사용한다.

명령과 조회를 분리하라

• 함수는 객체 정보를 변경하거나 객체 정보를 반환하거나 둘 중 하나만 해야 한다.

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

• 오류 코드를 반환하는 방식은 명령을 표현식으로 사용하기 쉬워 명령/조회를 분리한다는 규칙을 위반할 수 있고, 반환된 오류 코드를 곧바로 처리해야 한다는 문제점이 있다.

Try/Catch 블록 뽑아내기

• Try/Catch 블록은 코드 구조에 혼란을 일으키고 정상 동작과 오류 처리 동작을 뒤섞을 수 있으므로 별도 함수로 뽑아내는 것이 좋다.

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

• 오류 처리 함수 또한 오류만 처리해야 한다.

Error.java 의존성 자석

• 오류 코드를 반환하면 오류 코드에 대해 정의한 의존성 자석 클래스가 생긴다.
• 의존성 자석 클래스는 다른 클래스에서 import 해 사용해야하므로 클래스에 변화가 생길 경우 재컴파일/재배치가 필요해, 번거롭다.

반복하지 마라

• 중복이 생기면 코드 길이가 늘어나고, 알고리즘이 변했을 때 여러 곳을 선봐야 해 오류가 발생할 확률이 증가한다.
• 중복을 없애면 모듈 가독성이 증가한다.

구조적 프로그래밍

• 구조적 프로그래밍에서는 함수는 모든 함수 내 입구와 출구가 하나만 존재해야 한다. 따라서 return 문이 하나여야 하고, 루프 안에서 break, continue 를 사용해선 안되며, goto 는 절대로 사용할 수 없다.
• 함수를 작게 만든다면 간혹 return, break, continue 를 여러 차례 사용해도 괜찮고, 때론 단일 입/출구 규칙보다 의도 표현이 쉬워진다.
• goto 문은 큰 함수에서만 의미가 있으므로 작은 함수에선 피해야 한다.

함수를 어떻게 짜죠?

1. 서투른 코드를 작성한다.
2. 서투른 코드를 빠짐없이 테스트 하는 단위 테스트 케이스를 만든다.
3. 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고, 순서를 바꾼다. 전체 클래스를 쪼갠다.
4. 3번 이후에도 항상 단위 테스트를 통과하게 한다.