3장 함수
작게 만들어라!
함수를 만드는 첫째 규칙은 '작게!'다. 함수를 만드는 둘째 규칙은 '더 작게!'다.
지금까지 경험을 바탕으로 그리고 오랜 시행착오를 바탕으로 나는 작은 함수가 좋다고 생각한다.
블록과 들여쓰기
if 문/else 문/while 문 등에 들어가는 블록은 한 줄이어야 한다.
=> 중첩 구조가 생길만큼 함수가 커져서는 안 된다
=> 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.
한 가지만 해라!
함수는 한 가지를 해야한다. 그 한 가지를 잘 해야 한다. 그 한가지만을 해야한다.
- 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행해야함
- 의미 있는 이름으로 다른 함수를 추출하지 않아야 함
함수 당 추상화 수준은 하나로!
함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
위에서 아래로 코드 읽기: 내려가기 규칙
- 코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
- 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다.
핵심은 짧으면서도 '한 가지'만 하는 함수다. 위에서 아래로 문단을 읽어내려 가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기가 쉬워진다.
서술적인 이름을 사용하라!
서술적인 이름은 함수가 하는 일을 좀 더 잘 표현하므로 훨씬 좋은 이름이다. 좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않다. 워드가 말했던 원칙을 기억하는가?
코드를 읽으면서 짐작했던 기능을 각 루틴이 수행한다면 깨끗한 코드라 불러도 되겠다.
서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
👩🏻💻 💡 끼어들기
정말 정말 공감한다. 함수명을 보고 함수의 역할을 생각할 수 있다면, 그 함수 해석의 반은 성공했다고 생각한다. 이름은 최대한 직관적이게 지어야한다고 생각한다.
함수 인수
함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상(다항)은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안된다. 최선은 입력 인수가 없는 경우이며, 차선은 입력 인수가 1개뿐인 경우다.
플래그 인수
플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 왜냐고? 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까!
(❌) render(true)(⭕️)
renderForSuite()
renderForSingleTest()👩🏻💻 💡 끼어들기
'부울 인자값을 가지고 함수를 함수형 프로그래밍으로 구현하려면 어떻게 해야하지?'라는 의문이 든다.
동사와 키워드
함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. 아래 코드에서 좀 더 나은 코드는 후자이다. name이 field라는 사실이 분명히 드러나기 때문이다.
(❌) write(name)(⭕️) writeField(name)함수 이름에 키워드를 추가하는 형식도 있다. 함수 이름에 인수 이름을 넣는 형식이다. 아래 코드에서 전자는 expected 다음에 actual이 온다는 순서를 인위적으로 기억해야 한다. 하지만 후자는 인수 순서를 기억할 필요가 없어진다.
(❌) assertEquals(expected, actual)(⭕️) assertExpectedEqualsActual(expected, actual)부수 효과를 일으키지 마라!
부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까. 많은 경우 시간적인 결합이나 순서 종속성을 초래한다. 시간적인 결합은 혼란을 일으킨다. 특히 부수 효과로 숨겨진 경우에는 더더욱 혼란이 커진다. 만약 시간적인 결합이 필요하다면 함수 이름에 분명히 명시한다.
👩🏻💻 💡 끼어들기
함수형 프로그래밍의 관점은 부수효과를 피해야한다고 되어있다. 하지만 실상 부수효과를 피한 순수함수를 이용하는 것보다, 부수효과를 잘 다룰 수 있어야 한다고 생각한다.
명령과 조회를 분리하라!
함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야한다.
명령과 조회를 분리해 애초에 뿌리를 뽑는 방법이다.
예를 들어, 다음 함수를 살펴보자.
(❌)
public boolean set(String attribute, String value);
if (set("username", "unclebob"))...(⭕️)
if (attributeExists("username")) {
setAttribute("username", "unclebob");
...
}오류 코드보다 예외를 사용하라!
명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.
Try/Catch 블록 뽑아내기
try/catch 블록은 원래 추하다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.
public void delete(Page page) {
try {
deletePageAndAllReferencs(page);
}
catch (Exception e) {
logError(e);
}
}오류 처리도 한 가지 작업이다.
함수는 '한 가지' 작업만 해야한다. 오류 처리도 '한 가지' 작업에 속한다. 그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다.
반복하지 마라!
중복을 없애면 모듈 가독성이 크게 높아졌다는 사실을 깨달으리라. 어쩌면 중복은 소프트웨어에서 모든 악의 근원이다.
👩🏻💻 💡 끼어들기
중복만 줄여도 코드의 반이 줄어든다.
함수를 어떻게 짜죠?
소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다. 내가 함수를 짤 때도 마찬가지다. 나는 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다.
👩🏻💻 💡 끼어들기
너무너무 공감한다. 위의 설명들이 코드를 클린하게 짜고자 노력했던 나의 방법들이다. 이름을 바꿈으로써, 코드의 가독성을 높이고, 중복을 제거함으로써 불필요한 함수를 제거할 수 있다. 함수에 올바른 순서를 보장하게 하는 것 또한 개발자의 몫!
결론
이 장은 함수를 잘 만드는 기교를 소개했다. 여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라. 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기 쉬워진다는 사실을 기억하기 바란다.
-알라딘 eBook <클린 코드 Clean Code> (로버트 C. 마틴 지음, 이해영.박재호 옮김) 중에서
