[클린코드] 함수

함수

---

작게 만들어라

---

함수는 작을수록 좋다.

 

좋은 함수를 가진 코드 예시

 

public static String renderPageWithSetupsAndTeardowns(
	PageData pageData, boolean isSuite) throws Exception {
    if (isTestPage(pageData))
    	includeSetupAndTeardownPages(pageData, isSuite);
    return pageData.getHtml();
}

블록과 들여쓰기

if문/else문/while문 등에 들어가는 블록은 한 줄이어야 한다. 들여쓰기 수주은 1단이나 2단을 넘어서면 안 된다.

중첩구조가 생길만큼 함수가 커져서는 안 된다.

한 가지만 해라

---

함수는 한가지를 해야한다. 그리고 그 한가지를 잘 해야 한다.

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

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

 

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

---

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

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

 

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

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

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

 

※ 내려가기 규칙

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

Switch 문

switch문은 작게 만들기 어렵고 한 가지 작업만 하는 switch문은 만들기 어렵다. (switch문은 N가지를 처리한다)

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

즉, swith문을 추상 팩토리에 숨기는 것이다.

서술적인 이름을 사용하라

---

함수는 하는 일을 좀 더 잘 표현하는 이름을 사용해야 한다.

이름이 길어도 좋으니, 서술적인 이름을 고르는 것이 좋다.

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

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

 

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

(예 :  includeSetupAndTeardownPages)

문체가 비슷하면 이야기를 순차적으로 풀어가기 쉬워진다.

함수 인수

함수에서 인수는 0개(무항), 1개(단항), 2개(이항) 순으로 이상적이다. ( 인수 3개(삼항) 이상은 피하는 것이 좋음 )

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

 

많이 쓰는 단항 형식

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

1. 인수에 질문을 던지는 경우

2. 인수를 뭔가로 변환해 결과를 반환하는 경우

 

유용한 단항 함수 형식 : 이벤트

 

이벤트 함수는 입력 인수만 있고 출력 인수는 없다.

프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다.

이벤트 함수를 사용할 때는 이벤트라는 사실이 코드에 명확히 들어나야된다.

따라서, 이벤트 함수를 사용하고자 할 때에는 이름과 문맥을 주의해서 선택해야한다.

 

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

입력인수를 그대로 돌려주는 함수라 할지라도 변환 함수 형식을 따르는 편이 좋다.

플래그 인수

플래그 인수는 비추한다. 함수로 부울 값을 넘기게 되면 함수가 여러 가지를 한꺼번에 처리하게 된다.

이항 함수

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

Point p = new Point(0, 0)과 같이

인수 2개가 한 값을 표현하는 요소이고, 자연적인 순서가 있으면 이항 함수가 적절한 경우도 있다.

 

이항 함수가 무조건 나쁘다는 것은 아니다. 프로그램을 짜다보면 불가피하게 사용하는 경우도 있다.

하지만 그만큼 위험이 따른다는 사실을 이해하고 단항 함수로 바꾸도록 애써야 한다.

삼항 함수

인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 순서, 주춤, 무시로 야기되는 문제가 두 배 이상 늘어난다. 따라서 삼항 함수를 만들 때는 신중하게 고려하는 것을 권고한다.

인수 객체

인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다. 객체를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.

인수 목록

때로는 인수 개수가 가변적인 함수도 필요하다. 가변 인수를 취하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있다. 하지만 이를 넘어서는 인수를 사용할 경우에는 문제가 있다.

동사와 키워드

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

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

함수에 키워드를 추가하는 형식이다. 즉, 함수 이름에 인수 이름을 넣는다.

부수 효과를 일으키지 마라

---

부수 효과는 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 것도 하는 것을 의미한다.

많은 경우 시간적인 결합이나 순서 종속성을 초래한다.

시간적 결합은 혼란을 일으킨다. 특히 부수 효과로 숨겨진 경우에는 더더욱 혼란이 커진다.

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

출력 인수

일반적으로 인수를 함수 입력으로 해석한다. 

객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다.

출력 인수로 사용하라고 설계한 변수가 this이기 때문이다.

 

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

명령과 조회를 분리하라

---

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

객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다. 둘 다 하면 혼란을 초래한다.

진짜 해결책은 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법이다.

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

---

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

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

 

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

 

Try/Catch 블록 뽑아내기

try/catch 블록은 원래 좋지 않다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 try/catch 블록을 별도 함수로 뽑아낸 편이 좋다.

 

정상 동작과 오류 처리 동작으로 분리하면 코드를 이해하고 수정하기 시워진다.

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

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

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

함수에 키워드 try가 있다면 함수는 try 문으로 시작해 catch/finally 문으로 끝나야 한다는 말이다.

Error.java 의존성 자석

오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.

프로그래머는 재컴파일/재배치가 번거롭기에 새 오류 코드를 정의하고 싶지 않다. 그래서 새 오류 코드를 추가하는 대신 기존 오류 코드를 재사용한다. 

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

따라서 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다.

반복하지 마라

---

중복은 문제다. 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 해당 하는 부분 모두 손봐야 한다.

게다가 어느 한곳이라도 빠뜨리게 되면 오류가 발생할 확률도 배가 된다.

중복을 없애면 모듈 가독성이 크게 높아진다.

 

객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다.

중복을 제거하기 위한 전략에는 구조적 프로그래밍, AOP, COP가 있다.

구조적 프로그래밍

---

함수는 return문이 하나여야 한다.

루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로 안 된다.

 

구조적 프로그래밍은 함수가 작을 땐 별 이익을 제공받지 못하지만 함수가 클 때만 상당한 이익을 제공한다.

 

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

오히려 때로는 단일 입/출구 규칙보다 의도를 표현하기 쉬워진다.

반면, goto문은 큰 함수에서만 의미가 있으므로 작은 함수에서는 피해야만 한다.