CS CleanCode - 함수

작게 만들어라!

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

이 규칙은 근거를 대기가 곤란하다. 함수가 작을수록 더 좋다는 증거나 자료를 제시하기도 어렵다. 하지만 나는 지난 40여년 동안 온갖 크기로 함수를 구현해봤다. 지금까지 경험을 바탕으로 그리고 오랜 시행착오를 바탕으로 나은 작은 함수가 좋다고 확신한다.

 

개인적인 생각

• 좋은 함수명과 작은 함수는 주석없이 코드를 읽게 만들어준다.
• 작은 함수는 재사용이 편리하고, 오류 추적이 쉽고, 테스트가 편하다.

그렇다면 얼마나 짧아야 좋을까? 80년대에는 함수가 한 화면을 넘어가면 안된다고 말했다. 당시 모니터 화면은 가로 80자 세로 24줄이었고 편집기에서 4줄을 관리용으로 사용했습니다. 가로 150자를 넘어서는 안 된다. 함수는 100줄을 넘어서는 안 된다. 아니 20줄도 길다.

 

블록과 들여쓰기

조건문 반복문 등에 들어가는 블록은 한 줄이어야 한다. 대게 거기서 함수를 호출한다. 그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이하히가도 쉬워진다.

 

중첩 구조가 생길만큼 함수가 커져서는 안 된다는 뜻이다. 즉, 함수의 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.

한 가지만 해라!

함수는 한 가지를 해야한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다. 이 충고에서 문제라면 그 '한 가지'가 무엇인지 알기가 어렵다는 점이다.

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

    return pageData.getHtml();
}

 

위 함수에서 세 가지를 한다고 주장할 수도 있다.

1. 페이지가 테스트 페이지인지 판단한다.
2. 그렇다면 설정 페이지와 해제 페이지를 넣는다.
3. 페이지를 HTML로 렌더링한다.

위에서 언급하는 세 단계는 지정된 함수 이름 아래에서 추상화 수준이 하나다. 함수를 간단한 TO 문단으로 기술할 수 있다.

* TO 문단 : LOGO 언어에서 사용하는 키워드(Python에서 def와 비슷한 의미). 모든 함수는 TO로 시작한다.

TO RenderPageWithSetupsAndTeardowns, 페이지가 테스트 페이지인지 확인한 후 테스트 페이지라면 설정 페이지와 해제 페이지를 넣는다. 테스트 페이지든 아니든 페이지를 HTML로 렌더링한다.

 

지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다. 어쨌거나 우리가 함수를 만드는 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서이다.

 

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

함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다. 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지 세부사항인지 구분하기 어렵기 탓이다. 게다가 깨진 창문처럼 다른 사람들이 함수에 세부사항을 점점 더 추가한다.

 

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

코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 다르게 표현하면 TO 문단을 읽듯이 프로그램이 읽혀야 한다는 의미이다.

TO 설정 페이지와 해제 페이지를 포함하려면, 설정 페이지를 포함하고, 테스트 페이지 내용을 포함하고, 해제 페이지를 포함한다.
    TO 설정 페이지를 포함하려면, 슈트이면 슈트 설정 페이지를 포함한 후 일반 설정 페이지를 포함한다.
    TO 슈트 설정 페이지를 포함하려면, 부모 계층에서 "SuiteSetUp" 페이지를 찾아 include 문과 페이지 경로를 추가한다.
    TO 부모 계층을 검색하려면, ...

추상화 수준이 하나인 함수를 구현하기란 쉽지 않다. 많은 프로그래마 곤란을 겪는다. 그렇지만 매우 중요한 규칙이다. 핵심은 짧으면서도 '한 가지'만 하는 함수이다.

 

Switch 문

'한 가지' 작업만 하는 switch 문도 만들기 어렵다. 본질적으로 switch 문은 N가지를 처리한다. 불행하게도 switch 문을 완전히 피할 방법은 없다. 하지만 다형성을 이용하여 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다.

 

public Money calculatePay(Employee e) throw 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);

함수 내부에 똑같이 Employee Type으로 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 HOURYL:
                return new HourlyEmployee(r);
            case SALARIED:
                return new SalariedEmployee(r);
            default:
                throw new InvalidEmployeeType(r.type);
        }
    }
}

switch 문을 추상 팩토리에 꽁꽁 숨기고 외부에 노출하지 않습니다. 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성합니다. caculatePay, isPayday, deliverPay 등과 같은 함수는 Employee 인터페이스를 거쳐 호출합니다. 그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.

 

일반적으로 나는 switch 문을 단 한 번만 참아준다. 다형적 객체를 생성하는 코드 안에서다.

 

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

좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않는다. 한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙에 달성함에 있어 이미 절반은 성공했다. 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.

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

 

• 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.
• 이름을 정하느라 시간을 들여도 괜찮다. 이런저런 이름을 넣어 코드를 읽어보면 더 좋다. 최신 IDE에서 이름 바꾸기는 식은 죽 먹기다.
• 이름을 붙일 때는 일관성이 있어야 한다.

 

함수 인수

함수에서 이상적인 인수 개수는 0개이며 인수는 적을 수록 좋다. 3개 가능하면 피하는 편이 좋고, 4개 이상은 특별한 이유가 필요하다.

인수는 어렵다. 인수는 개념을 이해하기 어렵게 만든다. 함수 내부 코드를 확인할 때 인수를 발견할 때마다 해석해야 한다. 테스트 관점에서 보면 인수는 더 어렵다. 인수 조합으로 함수를 검증할 때 인수가 많으면 검증할 테스트 케이스가 많아진다.

 

많이 쓰는 단항 형식

boolean fileExists(String name)

질문을 던지는 경우다.

 

InputStrema fileOpen(String name)

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

 

void passwordAttemptFailedNtimes(int attempts)

다소 드물게 사용하지만 그래도 아주 유용한 단항 함수 형식이 이벤트다.

 

플래그 인수

플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 왜냐면 함수가 한꺼번에 여러 가지를 처리한다고 공표하는 셈이기 때문이다.

fun doSomething(data: Data, flag: Boolean) {
    if (flag) {
        // positive
    } else {
        // negative
    }
}

 

이항 함수

writeField(name)
writeField(outputStream, name)

인수 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다. 둘다 의미는 명백하지만 전자가 더 쉽게 읽힌다.

 

Point p = new Point(0, 0);
// new Point(0); 좌표의 점이 하나면 오히려 더 이상하다.

물론 이항 함수가 적절한 경우도 있다. 좌표계 점은 일반적으로 인수 2개를 취한다. 하지만 여기서 인수 2개는 한 값을 표현하는 두 요소이고, 자연적인 순서도 있다. 반면 outputStream, name은 한 값을 표현하지도 않으며 자연적인 순서도 없다.

 

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

 

인수 객체

Circle makeCircle(double x, double y, double radius);
Circle makeCircle(Point center, double radius);

인수가 많이 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 집어본다.

 

인수 목록

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

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

때로는 인수의 개수가 가변적인 함수도 필요하다. 위 예처럼 인수 전부를 동등하게 취급하면 List 형 인수 하나로 취급할 수 있다. 이 논리로 따져보면 사실 String.format은 이항 함수이고 실제 선언부를 살펴보면 이항 함수인 것을 알 수 있다.

 

동사와 키워드

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

write(name)
writeField(name)

name 인수가 Field라는 것을 유추할 수 있다.

assertEquals(expected, actual)
assertExpectedEqualsActual(expected, actual)

함수 이름으로 인수 순서를 유추할 수 있다.

 

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

부수 효과는 예상치 못하게 클래스 변수를 수정합니다. 때로는 함수로 넘어온 인수나 시스템 전역 변수를 수정합니다. 이는 시간적인 결합이나 순서 종속성을 초래합니다.

public class UserValidator {
    private Cryptographer cryptographer;

    public boolean checkPassword(String userName, String password) {
        User user = UserGateway.findByName(userName);
        if (user != User.NULL) {
            String codedPharse = user.getPhraseEncodedByPassword();
            String phrase = cryptographer.decrypt(codedPhrase, password);
            if ("Valid Password".equals(phrase)) {
                Session.initialize();
                return true;
            }
        }

        return false;
    }
}

userName과 password를 확인하여 true/false를 반환하는 함수입니다. 하지만 여기서 Session.initialize()는 부수 효과를 일으킵니다. 함수 이름만 봤을 때는 세션 초기화를 예상할 수 없습니다. 함수 이름만 봤을 때 세션 초기화를 예상할 수 없기 때문에 오류를 발생할 수 있습니다.

 

명령과 조회를 분리하라!

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

 

public boolean set(String attribute, String value);

...


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


set("username", "unclebob")

attribute에 value를 설정하고 성공하면 true를 반환하는 set을 만들었다고 가정하겠습니다.

 

독자 입장에서는 set이 값을 설정하는 함수인지, 값을 확인하는 함수인지 의미가 모호합니다. 조건문에 사용하면 형용사의 역할로 확인하는 것 같고, 함수만 호출하면 동사의 역할로 설정하는 것 같습니다.

 

set을 setAndCheckIfExists라고 바꾸는 방법도 있지만 근본적인 해결 방법은 아닙니다.

 

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

근본적인 해결 방법은 명령과 조회를 분리하는 것입니다.

 

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

if (deletePage(page) == OK)

명령 함수에서 오류 코드를 반환하는 방식은 '명령과 조회를 분리하라!' 규칙을 미묘하게 위반합니다. 자칫하면 조건문에서 형용사처럼 사용하기 쉽습니다.

 

if (deletePage(page) == OK) {
    if (registry.deleteReference(page.name) == OK) {
        if (configKeys.deleteKey(page.name.makeKey()) == OK) {
            // Success Something
        } else {
            // Error Something
        }
    } else {
        // Error Something
    }
} else {
    // Error Something
}

오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제가 발생합니다.

 

try {
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
} catch(Exception e) {
    // Error Something
}

반면 예외를 사용하면 오류 처리 코드가 원래 코드와 분리되기 때문에 깔끔해집니다.

 

Try/Catch 뽑아내기

public void delete(Page page) {
    try {
        deletePageAndAllReferences(page);
    } catch (Exception e) {
        logError(e);
    }
}

private void deletePageAndAllReferences(Page page) {
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}

private void logError(Exception e) {
    
}

try/catch 블록은 원래 추하다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 그렇기 때문에 분리하는 것이 좋다.

 

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

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

 

Error.java 의존성 자석

오류 코드를 반환한다는 것은 클래스든, Enum이는 변수든 어디선가 오류 코드를 정의한다는 뜻이다. 이는 의존성 자석이다.(이 코드를 사용하면 어쩔 수 없이 의존성이 생긴다.)

public enum Error {
    OK,
    INVALID
    ...
}

즉 Enum이 변한다면 Enum을 사용하는 모든 클래스는 수정이 필요합니다. 오류 코드 대신 예외를 사용하고, 예외는 Exception 클래스에서 파생되기 때문에 재컴파일/재배치 없이도 예외 클래스를 추가할 수 있습니다.

 

반복하지 마라!

중복은 소프트웨어에서 모든 악의 근원입니다. 코드의 길이가 늘어나고 가독성이 떨어지고 알고리즘이 변하면 중복된 모든 곳을 수정해야 하며 실수로 수정하지 않으면 오류를 발생합니다.

 

구조적 프로그래밍

함수를 쉽게 파악할 수 있게 모든 함수와 모든 블록은 입구와 출구가 하나만 존재해야 한다고 말했습니다. 즉, 함수는 return 문이 하나여야 하고, 반복문은 break, continue를 사용해선 안 되며 goto는 절대로 안됩니다.

 

함수가 작을 경우 위 규칙은 별 이익을 제공하지 못하고 오히려 return, break, continue가 의도를 표현하기 쉬워집니다. 즉 구조적 프로그래밍은 크기가 큰 함수에서 큰 이익이 있습니다.

 

함수를 어떻게 짜죠?

처음에는 인수가 많고, 함수가 커지면서 들여쓰기 단계가 많고, 중복된 루프도 많다.  하지만 코드를 다듬고 중복을 제거하고 이름을 변경하면서 점차 클린한 함수가 완성된다.

처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.

결론

여기서 설명한 규칙을 잘 따른다면 클린한 함수를 만들 수 있을 것이다. 하지만 진짜 목표는 함수를 잘 짜는 것이 아니라 시스템이라는 이야기를 프로그래밍 언어를 통해 풀어가는데 있다는 사실을 명심하기 바란다.

 

느낀점

잘 짜여진 함수는 재사용하기 편하고, 재사용이 편하면 개발이 쉬워집니다. 게다가 테스트까지 통과하여 안전하고 이름만으로 함수의 의도를 알 수 있다면 개발이 편해질 것입니다. 이 장에서 배운 규칙을 잘 사용해야겠습니다.

 

• 함수 장 추론화 수준은 하나로에서 추론화 범위를 정하는 것이 어려운 것 같다.
• Error.java 규칙에서 Exception도 마찬가지로 변경하게 되면 관련된 클래스를 수정해야 하지 않나?