3장 함수

어떤 프로그램이든 가장 기본적인 단위가 함수다. 이 장은 함수를 잘 만드는 법을 소개한다. 의도를 분명하게 표현하는 함수를 어떻게 구현할 수 있을까? 함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까?

작게 만들어라!

Sparkle은 모든 함수가 2줄, 3줄, 4줄 정도였다. 각 함수가 너무도 명백했다. 각 함수가 이야기 하나를 표현했다. 각 함수가 너무도 멋지게 다음 무대를 준비했다. 바로 이것이 답이다.

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

블록과 들여쓰기

if/else/while 문 등에 들어가는 블록은 한 줄이어야 한다는 의미다. 그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.

이 말은 중첩 구조가 생길 만큼 함수가 커져서는 안 된다는 뜻이다. 그러므로 함수에서 들여쓰기 수준은 1단이나 3단을 넘어서면 안 된다. 그래야 함수는 읽고 이해하기 쉬워진다.

한 가지만 해라!

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

이 충고에서 문제라면 그 한 가지가 무엇인지 알기가 어렵다는 점이다. 함수가 한 가지만 하는지 판단하는 방법은 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 것이다.

함수 내 섹션

한 함수 내에서 여러 섹션으로 나눠질 수 있다면, 그 함수는 여러 작업을 한다는 증거다. 한 가지 작업만 하는 함수는 자연스럽게 섹션을 나누기 어렵다.

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

함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다. 예를 들어, getHTML()은 추상화 수준이 아주 높다. 반면, String pagePathName = PathParser.render(pagePath);는 추상화 수준이 중간이다. 그리고, .append("\n");은 추상화 수준이 아주 낮다.

한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지 아니면 세부 사항인지 구분하기 어려운 탓이다. 하지만 문제는 이 정도로 그치지 않는다. 근본 개념과 세부 사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부 사항을 점점 더 추가한다.

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

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

예시:

설정 페이지와 해제 페이지를 포함하려면, 설정 페이지를 포함하고, 테스트 페이지 내용을 포함하고, 해제 페이지를 포함한다.

설정 페이지를 포함하려면, 슈트이면 슈트 설정 페이지를 포함한 후 일반 설정 페이지를 포함한다.

슈트 설정 페이지를 포함하려면, 부모 계층에서 "SuiteSetUp" 페이지를 찾아 include문과 페이지 경로를 추가한다.

부모 계층을 검색하려면, ...

각 함수는 다음 함수를 소개한다. 또한 각 함수는 일정한 추상화 수준을 유지한다. 이처럼 위에서 아래로 읽어 내려가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기가 쉬워진다.

Switch 문

switch 문은 작게 만들기 어렵다. case 분기가 단 두 개인 switch 문도 너무 길며, 한 가지 작업만 하는 switch 문도 만들기 어렵다. 본질적으로 switch 문은 N 가지를 처리한다. 불행하게도 switch 문을 완전히 피할 방법은 없다. 하지만 각 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다. 물론 다형성을 이용한다.

switch 문 사용의 나쁜 예제:

public Money calculatePay(Employee e) throws InvalidEmployeeType {
    switch (e.type) {
        case COMMISSIONED:
            return calculateCommissionedPay(e);
        case HOURLY:
            return calculateHourlyPay(e);
        case SALARIED:
            return calculateSalariedPay(e);
        default:
            throw new InvalidEmployeeType(e.type);
    }
}
 

위 함수에는 몇 가지 문제가 있다.

• 함수가 길다. 새 직원 유형을 추가하면 더 길어진다.
• 한 가지 작업만 수행하지 않는다.
• SRP(Single Responsibility Principle)을 위반한다. 코드를 변경할 이슈가 여럿이기 때문이다.
• OCP(Open Closed Principle)를 위반한다. 기존의 코드를 변경하지 않으면서 기능을 추가할 수 있도록 설계가 되어야 하지만, 새 직원 유형을 추가할 때마다 코드를 변경해야 하기 때문이다.
• 가장 심각한 문제는 위 함수와 구조가 동일한 함수가 무한정 존재한다는 것이다. 예를 들어, isPayday(Employee e, Date date) 또는 DeliverPay(Employee e, Money pay) 등이다.

switch 문 사용의 좋은 예제:

public abstract class Employee {
    public abstract boolean isPayday();
    public abstract Money calculatePay();
    public abstract void deliverPay(Money pay);
}
// ------------------------------
public interface EmployeeFactory {
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}
// ------------------------------
public class EmployeeFactoryImpl implements EmployeeFactory {
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
        switch (r.type) {
            case COMMISSIONED:
                return new CommissionedEmployee(r);
            case HOURLY:
                return new HourlyEmployee(r);
            case SALARIED:
                return new SalariedEmploye(r);
            default:
                throw new InvalidEmployeeType(r.type);
        }
    }
}

switch 문을 abstract factory에 꼭꼭 숨겨서 아무에게도 보여주지 않는다. 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다. calculatePay, isPayday, deliverPay 등과 같은 함수는 Employee 인터페이스를 거쳐 호출된다. 그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행된다. 일반적으로 switch 문은 다형적 객체를 생성하는 코드 안에서만 사용하는 게 좋다.

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

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

이름이 길어도 괜찮다. 겁먹을 필요 없다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다. 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

이름을 정하느라 시간을 들여도 괜찮다. 이런저런 이름을 넣어 코드를 읽어보면 더 좋다. 서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다. 좋은 이름을 고른 후 코드를 더 좋게 재구성하는 사례도 없지 않다.

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

함수 인수

함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)고, 그 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상(다항)은 특별한 이유가 필요하.. 특별한 이유가 있어도 사용하면 안 된다.

인수는 어렵다. 인수는 개념을 이해하기 어렵게 만든다. 코드를 읽는 사람에게는 includeSetupPageInto(newPageContent)보다 includeSetupPage()가 이해하기 더 쉽다. includeSetupPageInto(newPageContent)는 함수 이름과 인수 사이에 추상화 수준이 다르다. 게다가 코드를 읽는 사람이 현시점에서 별로 중요하지 않은 세부사항을 알아야 한다.

테스트 관점에서 보면 인수는 더 어렵다. 갖가지 인수 조합으로 함수를 검증하는 테스트 케이스를 작성해야 한다. 하지만 인수가 없다면 간단하다. 인수가 하나라도 괜찮다. 인수가 2개면 조금 복잡해진다. 인수가 3개를 넘어가면 인수마다 유효한 값으로 모든 조합을 구성해 테스트하기가 상당히 부담스러워진다.

많이 쓰는 단항 형식

함수에 인수 1개를 전달하는 이유로 가장 흔한 경우는,

1. 인수에 질문을 던지는 경우다. 예: booelan fileExists(＂MyFile＂)
2. 인수를 뭔가로 변환해 결과를 반환하는 경우다. 예: InputStream fileOpen(＂MyFile＂)

이들 두 경우는 독자가 당연하게 받아들인다. 함수 이름을 지을 때는 두 경우를 분명히 구분한다. 또한, 언제나 일관적인 방식으로 두 형식을 사용한다.

다소 드물게 사용하지만 그래도 아주 유용한 단항 함수 형식은 이벤트다. 이벤트 함수는 입력 인수만 있다. 출력 인수는 없다. 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다. (예: passwordAttemptFailedNtimes(int attempts)) 이벤트 함수는 조심해서 사용한다. 이벤트라는 사실이 코드에 명확히 드러나야 한다. 그러므로 이름과 문맥을 주의해서 선택한다.

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

플래그 인수

플래그 인수는 추하다.

수로 bool 값을 넘기는 관례는 정말로 끔찍하다. 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 뜻과 같다. 플래그가 참이면 이걸 하고, 거짓이면 저걸 한다는 뜻이다. 예를 들어 render(true)라는 코드는 헷갈리기 십상이다. renderForSuite()와 renderForSingleTest()라는 함수로 나눠야 마땅하다.

이항 함수

인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다. 예를 들어, writeField(name)은 writeField(outputStream, name)보다 이해하기 쉽다. 둘 다 의미는 명백하지만, 전자가 더 쉽게 읽히고 더 빨리 이해된다. 후자는 잠시 주춤하며 첫 인수를 무시해야 한다는 사실을 깨닫는 시간이 필요하다. 그리고 바로 그 사실이 결국은 문제를 일으킨다. 어떤 코드든 절대로 무시하면 안 되기 때문이다. 무시한 코드에 오류가 숨어들기 때문이다.

이항 함수가 적절한 경우는 자연적인 순서가 있는 경우다. 예를 들어, Point p = new Point(0, 0);이다. 직교 좌표계 점의 인수 2개는 한 값을 표현하는 두 요소이며, 자연석인 순서도 존재한다.

이항 함수가 무조건 나쁘다는 말은 아니다. 프로그램을 짜다 보면 불가피한 경우도 생긴다. 하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다. 예를 들어, writeField 메서드를 outputStream 클래스 구성원으로 만들어 outputStream.writeField(name)으로 호출한다. 아니면 outputStream을 현재 클래스 구성원 변수로 만들어 인수로 넘기지 않는다. 아니면 FieldWriter라는 새 클래스를 만들어 구성자에서 outputStream을 받고 write 메서드를 구현한다.

삼항 함수

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

삼항 함수가 적절한 예시: assertEquals(1.0, amount, .001) 이 함수는 여전히 주춤하게 되지만 그만한 가치가 충분하다. 부동소수점 비교가 상대적이라는 사실은 언제든 주지할 중요한 사항이기 때문이다.

인수 객체

인수가 2~3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다. 예를 들어, Circle makeCircle(double x, double y, double radius)는 Circle makeCircle(Point center, double radius)로 바꿀 수 있다. 객체를 생성해 인수를 줄이는 방법이 눈속임이라 여겨질지 모르지만 그렇지 않다. 위 예제에서 x와 y를 묶었듯이 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.

인수 목록

때로는 인수 개수가 가변적인 함수도 필요하다. String.format 메서드가 좋은 예다.

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

위 예제처럼 가변 인수 전부를 동등하게 취급하면 List 형 인수 하나로 취급할 수 있다. 이런 논리를 바탕으로 String.format은 사실상 이항 함수라고 할 수 있다.

public String format(String format, Object... args);

동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. 예를 들어, write(name)은 누구나 곧바로 이해한다. 이름이 무엇이든 쓴다는 뜻이다. 좀 더 나은 이름은 writeField(name)이다. 그러면 이름이 필드라는 사실이 분명히 드러난다.

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

부수 효과를 일으키지 마라!

부수효과는 거짓말이다.

함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓을 하는 것이다. 때로는 예상치 못하게 클래스 변수를 수정한다. 때로는 함수로 넘어온 인수나 시스템 전역 변수를 수정한다. 어느 쪽이든 교활하고 해로운 거짓말이다. 많은 경우 시간적인 결합(temporal coupling)이나 순서 종속성(order dependency)을 초래한다.

예를 들어, checkPassword(String userName, String password) 함수는 사용자가 입력한 비밀번호를 검사한다. 이 함수는 사용자의 인증 정보가 유효한지 확인하는 역할을 한다. 여기서, 사용자의 인증 정보가 유효하지 않은 경우에 session 정보를 초기화하는 작업을 수행한다고 할 때, 부수 효과를 일으키는 함수가 된다. 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다. 그래서 함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처하게 된다.

출력 인수

함수가 인수를 입력받으면 인수는 조회와 반환, 이 두 가지 목적으로 처리된다.

일반적으로 우리는 인수를 함수 입력으로 해석한다. 예를 들어, appendFooter(s)라는 함수를 호출하면 s라는 footer를 무언가에 추가한다고 생각한다. 하지만 함수 선언문을 보면 public void appendFooter(StringBuffer report)라고 되어 있다면? 이 함수는 report에 footer를 추가한다. 인수 s가 출력 인수라는 사실은 함수 선언부를 찾아보고 나서야 알게 된다. 이런 함수는 이해하기 어렵다.

이처럼 반환하지 않는 출력 인수는 report.appendFooter() 이런 식으로 report를 메서드의 인수로 넣는 게 아니라 report 안에 appendFooter 메서드를 넣어 인수를 제거하는 것이 좋다.

명령과 조회를 분리하라!

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

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

나쁜 예시:

if (set("username", "unclebob"))...

이 함수를 보고 set 함수가 어떤 역할을 하는지 명확히 알 수 없다. ＂username＂이 ＂unclebob＂으로 설정되어 있는지 확인하는 코드인지, ＂username＂을 ＂unclebob＂으로 설정하는 코드인지 코드만 봐서는 의미가 모호하다.

좋은 예시:

if (attributeExits("username")) {
    setAttribute("username", "unclebob");
}

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 아래와 같이 if 문에서 명령을 표현식으로 사용하기 쉬운 탓이다.

나쁜 예시:

if (deletePage(page) == E_OK) {
    // ...
} else {
    logger.log("Delete failed");
}

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

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

좋은 예시:

try {
    deletePage(page);
    // ...
} catch (Exception e) {
    logger.log(e.getMessage());
}

Try/Catch 블록 뽑아내기

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

public void delete(Page page) {
    try {
        deletePageAndAllReferences(page);
    } catch (Exception e) {
        logError(e);
    }
}
 
private void deletePageAndAllReferences(Page page) throws Exception {
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}
 
private void logEror(Exception e) {
    logger.log(e.getMessage());
}

위에서 delete 함수는 모든 오류를 처리한다. 그래서 코드를 이해하기 쉽다. 한번 훑어보고 넘어가면 충분하다. 실제로 페이지를 제거하는 함수는 deletePageAndAllReferences이다. deletePageAndAllReferences 함수는 예외를 처리하지 않는다. 이렇게 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.

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

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

Error.java 의존성 자석

오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다. 이것은 오류 코드를 정의한 클래스에 의존한다는 뜻이다. 이것은 의존성 자석이다. 예외는 Exception 클래스에서 파생된다. 따라서 오류 코드를 반환하는 대신 예외를 던지면 오류 코드를 정의한 클래스에 의존하지 않을 수 있다.

반복하지 마라!

중복은 문제다.

코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 중복된 코드를 찾아 모두 수정해야 한다. 게다가 어느 한 곳이라도 빠뜨리게 되면 버그가 생긴다. 중복을 제거해보면 모듈의 가독성 또한 크게 높아지는 사실을 알게 된다.

중복은 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다. 객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다. 구조적 프로그래밍, AOP(Aspect Oriented Programming), COP(Component Oriented Programming) 모두 어떤 면에서 중복을 제거 전략이다.

함수를 어떻게 짜죠?

소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다. 논문이나 기사를 작성할 때는 먼저 생각을 기록한 후 읽기 좋게 다듬는다. 초안은 대개 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.

함수를 짤 때도 마찬가지다. 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프로 많다. 인수 목록도 아주 길다. 이름은 즉흥적이고 코드는 중복된다. 그 서투를 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.

그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때론느 전체 클래스를 쪼개기도 한다. 이 와중에도 코드는 항상 단위 테스트를 통과해야 한다.

그러면 최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어지게 된다. 처음부터 탁 짜내지지 않는다. 그게 가능한 사람은 없으리라.

결론

모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한 도메인 특화 언어(Domain Specific Language)로 만들어진다. 함수는 그 언어에서 동사며, 클래스는 명사다. 프로그래밍의 기술은 언제나 언어 설계의 기술이다.

Master 프로그래머는 시스템을 구현할 프로그램이 아니라 풀어갈 이야기로 여긴다. 프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다. 시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 바로 그 언어에 속한다. 재귀라는 기교로 각 동작은 바로 그 도메인에 특화된 언어를 사용해 자신만의 이야기를 풀어간다.

이 장은 함수를 잘 만드는 기교를 소개했다. 여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라. 하지만 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하자. 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다는 사실을 기억하자.