03. 함수

함수는 기본적인 단위이다.

01. 작게 만들어라 

- 블록 안에서 호출하는 함수 이름 적절히 짓기

- 들여쓰기 수준은 1단 or 2단이 넘아가면 안된다.

 

02. 한가지만 해라

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

 

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

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

코드는 위에서 아래로 이야기처럼 읽혀야한다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한번에 한단계씩 낮아진다.

3-2. switch 문
각 switch문은 n가지 일을 처리하지만, 다향성을 이용해 저차원 클래스를 숨기고 절대로 반복하지 않는다.

04. 서술적인 이름을 사용하라

- 함수 이름을 정할때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.
- 이름을  붙일때는 일관성이 있어야한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.
ex) includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPages

05. 함수인수
흔히 우리는 함수에다 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념이 익숙하다. 대개 함수에서 인수로 결화를 받으리라 기대하지 않으므로 최선은 인수가 없을 때, 차선은 인수가 1개뿐인 경우로 사용한다.

인수 개수는 0개(무항) === 이상적인 인수 
인수 개수는 1개(단항)
인수 개수는 2개(이항)
인수 개수는 3개(삼항) === 피하는게 좋음
인수 개수는 4개(사항) === 특별한 이유가 있어도 사용하지 않음

5-1. 많이 쓰는 단항 형식
함수에 인수 1개를 넘기는 이유로 가장 흔한 경우는 두가지다.

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

함수 이름을 지을 때는 두 경우로 분명히 구분하며 언제나 일관적인 방식으로 두 형식을 사용한다.

5-2. 플래그 인수

플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이므로 사용을 지양한다. 차라리 함수를 나눠서 사용하라

5-3. 이항함수
적절한 경우  ex) point p = new Point(0, 0) : 직교 좌표계 점
이항함수는 위험이 따르기에 가능하면 단항함수로 바꾸도록 애써야함

5-4. 삼항함수
적절한 경우  ex) awwertEquals(1.0, amount, .001)
부동소수점 비교가 상대적이라는 사실은 언제든 주지할 중요한 사항임

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

Circle makeCircle(double x, double y, double radius)
Circle makeCircle(point center, double radius)

객체를 생성해 인수를 줄이는 방법이 눈속임이라 여겨질지 모르지만 그렇지 않고, 위의 예제 처럼 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.

5-5. 인수 목록
인수 개수가 가변적인 함수가 때로는 필요하다. String.format 메서드가 좋은 예이다.

String.format("%s worked %.2f hours.", name, hours)

위 예제 처럼 가변 인수 전부를 동등하게 취급하면 List 형 인수 하나로 취급할 수있다. 가변 인수를 취하는 모든 함수에 같은 원리가 적용된다. 가변 인수를 취하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있다.

5-5. 동사와 키워드
함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.

단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
ex) writeField(name) === 이름(name)이 필드(field)다.

함수 이름에 키워드를 추가하는 형식 즉, 함수 이름에 인수 이름을 넣기
ex) assertExpectedEqualsActual(expected, actual) === 인수 순서를 기억할 필요가 없어진다.

06. 부수 효과를 일으키지 마라
부수 효과는 시간적인 결합이나 순서 종속성을 초래한다.  만약 시간적인 결합이 필요하다면 함수 이름에 분명히 명시한다.

6-1. 출력 인수
일반적으로 인수를 우리는 함수 입력으로 해석된다. 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다. 출력인수로 사용하라고 설계한 변수가 this이기 때문에 일반적으로 출력 인수는 피해야한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

07. 명령과 조회를 분리하라

함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 명령과 조회를 분리해 혼란스러움을 없애야 한다.

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 
if 문에서 명령을 표현식으로 사용을 하지 말고, Try/Catch 예외를 사용하면 원래 코드에서 분리가 되어 코드가 깔끔해진다.

8-1. Try/Catch
코드 구조에 혼란을 일으키며, 정상 동작과 오류처리 동작을 뒤섞어 별도 함수로 뽑아내는 편이 좋다. 
함수는 예외를 처리하지 않고 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉽다.

8-2. 오류 처리도 한 가지 작업이다.
함수는 한가지 작업해야 하는 것처럼, 오류 처리도 한가지 작업에 속한다. 그러므로 오류를 처리하는 함수는 오류만 처리해아 마땅하다. 함수에 키워드가 try가 있다면 함수는 try로 시작해 catch/finally 문으로 끝나야 한다.

8-3. Error.java 의존성 자석
오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어딘가에 오류 코드를 정의한다는 뜻이다.
public enum Error {

OK,
... 

No_SUCH;

}
위와 같은 클래스는 의존성 자석이다. 다른 클래스에서 Error enum을 import해 사용해야 하므로 만약 변경이 된다면 재컴파일/재배치가 번거롭기 때문에 새 오류 코드를 추가하는 대신 기존 오류ㅠ 코드를 재사용한다.

09. 반복하지 마라

코드 길이가 늘어나면서 알고리즘이 변하면 여러곳에서 손봐야 하고, 빠뜨리는 바람에 오류가 발생할 확률이 높아지기 때문에 객체지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다. 하위 루틴을 발명한 이래로 소프트웨어 개발에서 지금까지 일어난 혁신은 소스 코드에서 중복을 제거하려는 지속적인 노력으로 보인다.

10. 구조적 프로그래밍

데이크스트라의 구조적 프로그래밍 원칙에 따르면 모든 함수와 함수 내 모든 블록에 입구(entry)와 출구(exit)가 하나만 존재해야 한다. 즉, 함수는 return 문이 하나여야 하고, 루프 안에서 break나 continue를 사용해선 안된다. 함수 단위가 작다면 위 규칙은 별이익을 제공하지 못하지만 함수가 크다면 상당한 이익을 제공한다. 
함수를 작게 만든다면 return, break, continue를 여러 차례 사용해도 괜찮다.

함수를 짤 때 초안은 대개 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.
단위 테스트 케이스를 만들어 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거하여 만들어 낸다.
함수는 그 언어에서 동사며, 클래스는 명사다. 시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 바로 그 언어에 속한다.