어떤 프로그램이든 가장 기본적인 단위가 함수다. 이 장은 함수를 잘 만드는 법을 소개한다. 의도를 분명히 표현하는 함수를 어떻게 구현할 수 있을까? 함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까?
작게 만들어라!
함수를 만드는 첫째 규칙은 작게!다. 함수를 만드는 둘째 규칙은 더 작게! 다.
블록과 들여쓰기
if문/else문/while문 등에 들어가는 블록은 한 줄이어야 한다. 대개 거기서 함수를 호출한다. 그러면 바깥을 감싸는 함수(enclosing function)가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.
이 말은 중첩 구조가 생길만큼 함수가 커져서는 안 된다는 뜻이다. 그러므로 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다. 그래야 함수는 읽고 이해하기 쉬워진다.
한 가지만 해라!
함수는 한 가지를 해야 한다. 그 한가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다. 우리가 함수를 만드는 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서이다.
함수가 한가지 만 하는지 판단하는 방법이 하나 더 있다. 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다. 한 가지 작업만 하는 함수는 섹션으로 나누기 어렵다.
함수 당 추상화 수준은 하나로!
함수가 확실히 한 가지 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다. 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 문제는 이 정도로 그치지 않는다. 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.
위에서 아래로 코드 읽기: 내려가기 규칙
코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 일련의 TO 문단을 읽듯이 프로그램이 읽혀야 한다. 핵심은 짧으면서도 한 가지만 하는 함수다. 위에서 아래로 TO 문단을 읽어내려 가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기가 쉬워진다.
LOGO언어에서 모든 함수는 키워드
TO로 시작한다.
Switch문
switch문, if/else가 여럿 이어지는 구문은 작게 만들기 어렵다. 본질적으로 switch문은 N가지를 처리한다. 불행하게도 switch문을 완전히 피할 방법은 없다. 하지만 각 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다. 다형성 polymorphism을 이용한다.
다형성은 그 프로그래밍 언어의 자료형 체계의 성질을 나타내는 것으로, 프로그램 언어의 각 요소들(상수, 변수, 오브젝트, 함수, 메소드 등)이 다양한 자료형에 속하는 것이 허가되는 성질을 가리킨다.
저자는 일반적으로 switch 문을 다형적 객체를 생성하는 코드 안에서, 단 한 번만 참아준다고 한다. 이렇게 상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다. 물론 불가피한 상황도 생긴다.
서술적인 이름을 사용하라!
함수가 하는 일을 좀 더 잘 표현해야 좋은 이름이라고 할 수 있다. 한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 절반은 성공했다고 볼 수 있다. 함수가 작고 단순할수록 서술적인 이름도 고르기 쉬워진다.
// 고치기 전
testableHtml
// 고치고 나서
SetupTeardDownIncluder.render이름이 길어도 괜찮다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다. 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.
함수 인수
함수에서 이상적인 인수 개수는 0개 (무항)다. 다음은 1개 (단항)고, 다음은 2개 (이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상 (다항)은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안된다.
매개변수(parameter)란 함수의 정의에서 전달받은 인수를 함수 내부로 전달하기 위해 사용하는 변수를 의미한다. 인수(argument)란 함수가 호출될 때 함수로 값을 전달해주는 값을 말한다.
많이 쓰는 단항 형식
함수에 인수 1개를 넘기는 가장 흔한 두가지 경우는 아래와 같다.
- 인수에 질문을 던지는 경우
- 인수로 뭔가를 변환해 결과를 반환하는 경우
플래그 인수
플래그 인수는 추하다. 함수로 Bool값을 넘기는 관례는 끔찍하다. 왜냐면 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까! 플래그가 참이면 이걸 하고 거짓이면 저걸 한다는 말이니까!
이항 함수
인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다. 이항 함수가 무조건 나쁘다는 소리는 아니다. 프로그램을 짜다보면 불가피한 경우도 생긴다. 하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다.
삼항 함수
인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 순서, 주춤, 무시로 야기되는 문제가 두 배 이상 늘어난다. 아래 함수를 보자.
assertEquals(message, expected, actual)저자는 위 함수를 보고 수없이 멈칫하고 주춤했다고 한다. 매번 함수를 볼 때마다 주춤했다가 message를 무시해야 한다는 사실을 상기했다고도 한다.
인수 객체
인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.
// 삼항 함수
Circle makeCircle(double x, double y, double radius);
// 객체를 생성해 이항 함수로
Circle makeCircle(Point center, double radius);객체를 생성해 인수를 줄이는 방법이 눈속임이라 여겨질지 모르겠지만 그렇지 않다. 위 예제에서 x와 y를 묶었듯이 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.
인수 목록
때로는 인수 개수가 가변적인 함수도 필요하다. String.format 메서드가 좋은 예다.
// String.format 선언부
public String format(String format, Object... args);
// example
String.format("%s worked %.2f hours.", name, hours);위 예제처럼 가변 인수 전부를 동등하게 취급하면 List형 인수 하나로 취급할 수 있다. 가변 인수를 취하는 모든 함수에 같은 원리가 적용된다. 가변 인수를 취하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있다.
매번 함수에 들어가는 인수의 개수가 변하는 것을
가변 인수(variable argument)라고 한다
동사와 키워드
함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필요하다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. 함수 이름에 키워드 즉, 인수 이름을 넣으면 인수 순서를 기억할 필요가 없어진다.
부수 효과를 일으키지 마라!
부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까. 때로는 예상치 못하게 클래스 변수를 수정한다. 때로는 함수를 넘어온 인수나 시스템 전역 변수를 수정한다. 어느 쪽이든 해로운 거짓말이다.
부수 효과는 많은 경우 시간적인 결합(temporal coupling)이나 종속성(order dependency)을 초래한다.
출력 인수
일반적으로 우리는 인수를 함수 입력으로 해석한다. 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다. 출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다. 일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
명령과 조회를 분리하라!
함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘 다 하면 안된다. 객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다. 둘 다 하면 혼란을 초래한다.
오류 코드보다 예외를 사용하라!
명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 If문에서 명령을 표현식으로 사용하기 쉬운 탓이다. 오류 코드 대신 try와 catch블록으로 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.
Try/Catch 블록 뽑아내기
try/catch 블록은 원래 추하다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다. 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.
오류 처리도 한 가지 작업이다.
함수는 한 가지 작업만 해야 한다. 오류 처리도 한 가지작업에 속한다. 그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다. 함수에 키워드 try가 있다면 try문으로 시작해 catch/finally 문으로 끝나야 한다는 말이다.
반복하지 마라!
책의 예제에서 나온 나쁜 예시에서는 알고리즘이 네번이나 반복되고 있었다. 리팩토링 한 예제에서는 include 방법으로 중복을 없앤다. 중복을 없앴더니 모듈 가독성이 크게 높아졌다. 어쩌면 중복은 소프트웨어에서 모든 악의 근원이다 (!) 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.
구조적 프로그래밍
에츠허르 데이크스트라(Edsger Dijkstra)의 구조적 프로그래밍 원칙. 구조적 프로그래밍은 프로그램을 작성할 때, 알고리즘을 세분화해 계층적인 구조가 되도록 설계하는 프로그래밍 방법.
데이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다. 즉, 함수는 return 문이 하나여야 한다는 말이다. 루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로, 절대로 안된다.
함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다. 반면, goto 문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야 한다.
함수를 어떻게 짜죠?
소프트웨어를 짜는 행위는 글짓기와 비슷하다. 논문이나 기사를 작성할 때는 먼저 생각을 기록한 후 읽기 좋게 다듬는다. 초안은 대개 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.
함수를 짤 때도 마찬가지다. 처음에는 길고 복잡하고, 인수 목록도 길고, 중복되는 코드를 작성한다. 그 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 그리고 최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다. 처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.
결론
각각의 언어에서 함수는 동사며, 클래스는 명사다. 프로그래밍의 기술은 언제나 언어 설계의 기술이다. 대가 프로그래머는 시스템을 구현할 프로그램이 아니라 풀어갈 이야기로 여긴다. 이 장은 함수를 잘 만드는 기교를 소개했다. 여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라. 하지만 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하길 바란다.
느낀 점
이번 장을 읽으면서는 1장에서 느껴보지 못한 저자의 강력함을 느낄 수 있었다. 모든 소제목의 끝에는 느낌표가 붙어있고, ‘추하다’라는 말을 쓰는데 스스럼이 없다. 슈퍼맨이 돌아왔다에서 아이들이 새로 들어올 때마다 청학동에 보내서 ‘예의’가 무엇인지 엄하게 가르치는 훈장님처럼, 갓 프로그래밍을 시작해 아주 제 마음대로 함수를 작성하는 나 같은 사람에게 “함수는 이렇게 작성하는 거다!” 하며 가르쳐 주는 느낌이랄까. 좀 억지 같기도 하다. 그냥 슈퍼맨이 돌아왔다는 내가 너무 좋아하는 프로그램이라서 한번 말해보고 싶어서 억지로 끼워 맞춰봤다.
이 책의 처음부터 지금까지 (아직 3장까지밖에 읽지 않았지만….) 일맥상통하게 이어지는 논점은 코드를 읽을 때 기승전결이 있어야 하고 글을 읽듯 위에서 아래로 술술 읽혀야 한다는 것이다. 이런 점은 결론 부분에서도 나왔다.
소프트웨어를 짜는 행위는 글짓기와 비슷하다. 처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.
초장에 그렇게 나를 혼내놓고.. 처음부터 탁 짜내는 사람은 없다는 말로 위로해준다. 이건 마치 청학동에 이제 막 들어온 아이들에게 무섭게 으름장을 놓고 집에 돌아갈 때 즈음 되니 친절하게 대해주는 훈장님과 무엇이 다른가. 아무튼 이번 장에서는 1, 2장과 다르게 마냥 고개를 끄덕이며 읽지는 않았다. 나는 자바스크립트를 공부한 지 1년 정도 된 사람이고 이 책은 다른 언어로 기술되어 있다. 중간중간 모르는 개념이 나오면 (GOTO라던지 구조적 프로그래밍이라던지) 찾아보며 예제를 알음알음 읽어나가는데 그것도 그것 나름의 재미가 있다. 앞으로 어떻게 함수를 작성해나가야 할지 훈장님에게 제대로 가르침 받았으니 처음부터는 아닐지라도, 좋은 코드로 계속해서 고쳐나갈 수 있는 프로그래머로 성장하고 싶다. 아디오스.