[Clean Code] 3 : 함수

안녕하세요 :) Zedd입니다.

2장에 이어서~~~3장!! 함수네요!!

이 장은 특히 정말 예제 코드가 많아서...제가 요약한 것만 보시면 좀 이해가 안가실 수도 있어요. 참고로..이 책의 모든 예제는 Java로 이루어져 있음...

음..그러니까...음...요약을 하긴 할건데요, 암튼 완벽히 이해하실려면 코드를 같이 봐야 한다는 사실 ㅎㅎ

어떤 프로그램이든 가장 기본적인 단위가 함수입니다. 이 챕터에서는 함수를 "잘" 만드는 법을 소개하고 있어요.

의도를 분명히 하는 함수를 어떻게 구현할 수 있을까? 함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악 할 수 있을까? 

시작할게요!!

함수

---

● 작게 만들어라!

- 함수를 만드는 첫째 규칙은 '작게!'다. 

- 함수를 만드는 둘째 규칙은 '더 작게!'다.

함수가 작을 수록 더 좋다는 증거나 자료를 제시하기는 어렵지만, 오랜 시행착오를 바탕으로 저자는 작은 함수가 좋다고 확신하고 있어요.

- if 문/else 문/while 문 등에 들어가는 블록은 한줄이어야 한다. 대게 여기서 함수를 호출한다. == 중첩 구조가 생길만큼 함수가 커져서는 안된다. == 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다. 

● 한가지만 해라!

- 함수는 한 가지를 해야한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.

문제는 그 '한 가지'가 무엇인지 알기가 어렵다는 점. 

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

==> 단순히 다른 표현이 아니라 의미있는 이름으로 다른 함수를 추출 할 수 있다면 그 함수는 여러작업을 하는 셈.

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

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

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

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

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

- 하지만 추상화 수준이 하나인 함수를 구현하기란 쉽지 않다. 핵심은 짧으면서도 '한 가지'만 하는 함수다.

● Switch문

- Switch문은 작게 만들기 어렵다. 본질적으로 N가지를 처리하기 때문. 불행하게도 switch문을 완전히 피할 방법은 없다.

● 서술적인 이름을 사용하라!

- 좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않음. "코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다" 한 가지만 하는 작은 함수에 좋은 이름을 붙인다면, 이런 원칙을 달성함에 있어 이미 절반은 성공했다. 함수가 작고 단순 할 수록 서술적인 이름을 고르기도 쉬워진다.

- 이름이 길어도 괜찮다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 

- 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

- 서술적인 이름을 사용하면 개발자 머리속에서도 설계가 뚜렷해지므로, 코드를 개선하기 쉬워진다.

- 이름을 붙일 때는 일관성이 있어야 한다. 모듈내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다. (ex. includeSetupPage, includeSuiteSetupPage..등) 문체가 비슷하면 이야기를 순차적으로 풀어가기도 쉬워진다. 

● 함수 인수.

- 함수에서 가장 이상적인 인수는 0개(무항)이다. 3개는 가능한 피하는 편이 좋다. 4개 이상은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안된다.(뭐야..)

- 인수가 3개를 넘어가면 인수마다 유효한 값으로 모든 조합을 구성해 테스트하기가 상당히 부담스러워진다. 

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

○ 많이 쓰는 단항 형식

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

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

func fileExist(fileName : String)->Bool

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

- 다소 드물게 사용하지만, 그래도 아주 유용한 단항 함수 형식이 이벤트다. 이벤트 함수는 입력 인수만 있다. 출력 인수는 없다. 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다. 

var p = Point(0, 0)

위 코드가 좋은 예다. 직교 좌표계 점은 일반적으로 인수 2개를 취한다. 코드가 Point(0)이면 오히려 더 놀라리라! 하지만 여기서 인수 2개는 한 값을 표현하는 두 요소다. 두 요소에는 자연적인 순서도 있다. 즉, 자연적인 순서가 없거나 한값을 표현하지 않는다면 이항함수는 사용하지 않는 것이 좋다.

이항함수가 무조건 나쁘다는 소리는 아니다. 프로그램을 짜다보면 불가피한 경우도 생긴다. 하지만 그만큼 위험이 따른다는 사실을 이해하고, 가능하면 단항 함수로 바꾸도록 애써야 한다. 

○ 삼항 함수

인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 그래서 삼항 함수를 만들때는 신중히 고려하라 권한다.

○ 동사와 키워드

- 함수의 의도나 인수의 순서와 의도를 제대로 표현하려면, 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.

- 함수이름에 키워드를 추가. 즉, 함수이름에 인수 이름을 넣는다. 예를들어, assertEquals보다 assertExpectedEqualsActual(expected, actual)이 더 좋다. 그러면 인수 순서를 기억할 필요가 없어진다. 

==> 제 '개인적인' 생각으로는 Swift에서는 조금 안맞는? 그런 지침???같아요. 저는 addName( _ : String)보다는 add(name : String)이런식으로? 하라고..배웠기때문...그러니까 assertExpectedEqualsActual이렇게 함수 이름에 인수 이름을 넣기 보다는..Swift에서는 인수에 이름을 줄 수 있으니까 ㅎㅎ...키워드를 인수이름으로 넣는게 좋은 것 같아요. 물론 제 생각~!~!!~~

● 부수 효과(Side effect)를 일으키지 마라!

- 부수효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른짓도 하니까.

○ 출력인수

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

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

● 명령과 조회를 분리하라!

- 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야한다. 둘 다 하면 안된다. 객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다. 둘 다 하면 혼란을 초래한다. 

func set(attribute : String, value : String) -> Bool {}

위 함수가 이름이 attribute인 속성을 찾아 값을 value로 설정한 후, 성공하면  true를, 실패하면 false를 반환한다. 

if set("username","unclebob"){
    
}

(파라미터 이름을 일단 생략했습니다.)

독자 입장에서 위 코드를 읽어보면, 뜻을 이해할 수 없다. 해결책은 명령과 조회를 분리해 혼란을 제거.

if attributeExists("username"){
    setAttribute("username","unclebob")
}

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

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

if delete(page:Page) == E_OK)

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

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

○ Try/Catch 블록 뽑아내기

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

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

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

함수는 '한 가지' 작업만 해야한다. 오류처리도 '한 가지' 작업에 속한다. 그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다. 

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

● 구조적 프로그래밍

- 데이크스트라(별 생각없이 봤는데 다익스트라였네요 zzz)는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다. 즉, 함수는 return 문이 하나여야 한다는 말이다. 루프안에서 break나 continue를 사용해선 안되며(뜨끔;;;;;) goto는 절대로 절대로 안된다.

- 위 규칙은 함수가 아주 클때만 상당한 이익을 제공한다. 그러므로 함수를 작게 만든다면 간혹 return, break, continue를 여러차례 사용해도 괜찮다. 오히려 때로는 단일 입/출구 규칙보다 의도를 표현하기 쉬워진다. 

● 함수를 어떻게 짜죠?

- 소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다. 논문이나 기사를 작성할 때는 먼저 생각을 기록한 후, 읽기 좋게 다듬는다. 처음부터 탁 짜내지지 않는다. 그게 가능한 사람은 없다. 

● 결론

함수는 그 언어에서 동사며, 클래스는 명사다. 

대가 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이야기로 여긴다. 우리에게 진짜 목표는 시스템이라는 이야기를 풀어가는데 있다는 사실을 명심하기 바란다.