[Clean Code] 3. 함수

작게 만들어라!

함수를 만드는 가장 중요한 규칙은 '작게!'이다. 이 규칙은 근거를 대기가 곤란하다. 함수가 작을수록 더 좋다는 증거를 제시하기도 어렵다. 하지만 여러 프로그래머의 수년 동안의 경험을 바탕으로 이 결론이 도출된 것은 저명한 사실이다. 오랜 시행착오로부터 우러나오는 경험을 바탕으로 함수는 작을수록 좋다는 것을 도출해낸 것이다.

그렇다면 얼마나 짧아야 좋을까? 다음 코드를 보자.

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

(여기서 저자는 함수가 이 정도로 작아야 한다는 것과 각 함수들이 무엇을 할것인지 명확하게 서술하고 있다는 사실을 강조한다.)

 

블록과 들여쓰기

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

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

 

한 가지만 해라!

다음은 지난 30여년 동안 여러 가지 다양한 표현으로 프로그래머들에게 주어진 충고이다.

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

이 충고에서 문제라면 그 '한 가지'가 무엇인지 알기가 어렵다는 점이다. 위 코드는 한 가지만 하는가? 세 가지를 한다고 주장할 수 있다. 

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

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

다양한 추상화 수준에서 여러 단계를 처리한다면 그 함수는 여러 작업을 하는 것이다. 

함수가 한 가지만 하는지 판단하는 방법이 하나 더 있다. 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 것이다.  

 

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

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

한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람은 헷갈리기 마련이다. 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다. 하지만 문제는 이 정도로 그치지 않는다. 이렇게 뒤섞기 시작하면, 프로그래머는 함수에 세부사항을 점점 더 추가한다.

 

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

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

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

 

Switch문

switch문은 작게 만들기 어렵다. switch문을 통해 한 두 가지 이상 작업만 하게 되더라도 너무 길다. 

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

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

위 함수에는 몇 가지 문제가 있다. 첫번째로 함수가 너무 길다. 새 직원 유형을 추가하면 더 길어질 것이다. 둘째, 한 가지 작업만 수행하지 않는다. 셋째, SPR(Single Responsibility Priciple, 단일 책임 원칙)을 위반한다. 코드를 변경할 이유가 여럿 존재한다. 넷째, OCP(Open-Closed Priciple, 개방 폐쇄 원칙)을 위반한다. 새 직원 유형을 추가할 때마다 코드를 변경하기 때문이다. 

 

이 문제를 해결한 코드는 아래와 같다.

public abstract class Employee {
    public abstract Money calculatePay();
}

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 COMMISSSIONED:
                return new CommissionedEmployee(r);
            case HOURLY:
                return new  HourlyEmployee(r);
            case SALARIED:
                return new SalariedEmployee(r);
            default:
                throw new InvalidEmployeeType(r.type);
        }
    }
}

switch 문을 추상 팩토리에 숨기고 아무에게도 보여주지 않는다. 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다. 그러면 다형성으로 인해 실제 파생 클래스의 함수(여기서는 calculatePay)가 실행된다. 

 

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

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

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

이름을 정하느라 시간을 들여도 괜찮다. 이런저런 이름을 넣어보고 코드를 읽어보거나 IDE를 이용해 이런저런 이름을 알아보는 것도 좋은 방법 중 하나이다. 서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지기 때문에 코드를 개선하기 더 쉬워진다. 

이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다. 

 

함수 인수

함수에서 이상적인 인수 개수는 0개이다. 다음은 1개이고, 다음은 2개이다. 3개는 가능한 피하는 편이 좋다. 4개 이상은 특별한 이유가 필요하다. 사실 특별한 이유가 있더라도 사용하면 안 된다.

인수는 어렵다. 인수는 개념을 이해하기 어렵게 만든다. 이것이 인수가 적을수록 좋은 이유다. 

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

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

예를 들어, SetupTeardownIncluder.render(pageData)는 매우 이해하기 쉽다. pagaData 객체 내용을 렌더링 하는다는 의도를 바로 알 수 있다.

 

많이 쓰는 단항 형식

함수에 인수를 1개 넘기는 경우는 흔히 두 가지이다. 하나는 인수에 질문을 던지는 경우이다. boolean fileExist("MyFile")이 좋은 예다. 다른 하나는 인수를 뭔가로 변환해 결과를 반환하는 경우이다. InpuStream fileOpen("MyFile")은 String 형의 파일 이름을 InputStream으로 변환한다.

이러한 경우를 제외하면 단항 함수는 가급적 피하는 것이 좋다. 

 

플래그 인수

플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 피해야 한다. 이는 함수에서 한꺼번에 여러 가지를 처리한다고 대놓고 표현하는 셈이기 때문이다. 부울 값이 참일 경우와 거짓일 경우 하는 일이 달라질 것이 확실하다.

 

이항 함수

인수가 2개인 함수는 1개인 함수보다 이해하기 어렵다. 인수가 2개인 함수는 이해하는데 있어서 인수를 무시하고 지나칠 수 있기 때문에 오류가 숨어 들어갈 가능성이 있다. 

물론 이항 함수가 적절한 경우도 있다. 직교 좌표계 점은 일반적으로 인수 2개를 취한다. new Point(0, 0) 이런 식으로 말이다. 

이항 함수부터는 인수가 오는 순서를 주의해야 한다. 예를 들어 foo(int start, int end)가 있다고 가정해보자. 이 순서를 맞게 제한해주는 기능은 없기 때문에 프로그래머는 함수 호출 시 start, end 인수가 오는 순서를 반대로 사용할 수도 있다.  

이항 함수가 무조건 나쁘다는 뜻은 아니다. 코드를 짜다보면 불가피한 경우가 생기기 마련이니까 말이다. 하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다. 

 

삼항 함수

인수가 3개인 함수는 이항 함수보다 훨씬 더 이해하기 어렵다. 이항 함수에서 야기됐던 문제가 배로 늘어난다. 그래서 삼항 함수를 만들 때에는 신중히 고려해야 한다.

 

인수 객체

인수가 2~3개 이상 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.

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

객체를 생성해 인수를 줄이는 방법은 눈속임이라 여겨질지 모르지만 절대 그렇지 않다. 위 코드에서 x와 y를 묶었듯, 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국 개념을 표현하게 된다. 

 

동사와 키워드

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

단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. 예를 들어, write(name)은 누구나 곧바로 이해한다. 이름(name)이 무엇이든 쓴다(write)는 뜻이기 때문이다. 

함수 이름에 키워드를 추가한다면 인수 순서를 기억할 필요가 없어진다. 예를 들어 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 codedPhrase = user.getPhraseEncodedByPassword();
            String phrase = cryptographer.decrypt(codedPhrase, password);
            if ("Valid Password".equals(phrase)) {
                Session.initialize();
                return true;
            }
        }
        return false;
    }
}

 여기서, 함수가 일으키는 부수 효과는 Session.initialize() 호출이다. checkPassword 함수는 암호를 확인한다. 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다. 함수 이름만 보고 호출하는 사용자는 기존 세션 정보를 지워버릴 위험에 처할 수 있다. 

또한 이렇게 되면 시간적인 결합을 초래한다. checkPassword 함수는 특정 상황에서만 호출이 가능하기 때문이다. 세션을 초기화해도 괜찮은 경우에만 해당 함수를 호출할 수 있다. 자칫 잘못 호출하면 세션 정보가 날아갈 수 있기 때문이다. 

차라리 해당 함수는 checkPasswordAndInitializeSession 이라는 이름이 훨씬 좋다. 물론 한가지 작업만 해야 한다는 규칙에 위배되겠지만...

 

명령과 조회를 분리하라!

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

public boolean set(String attribute, String value);

이 함수는 attribute를 찾아 value로 설정한 후 성공하면 true를 반환하고 실패하면 false를 반환한다. 그럼 다음과 같이 괴상한 코드가 나온다.

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

이렇게 보면 함수를 구현한 프로그래머의 의도를 파악하기가 어렵다. 'username을 unclebob으로 설정하는데 성공하면' 인지 'username이 unclebob으로 설정되어 있다면' 인지 헷갈리다. setAndCheckIfExists로 함수명을 알맞게 바꾸는 방법도 있지만 if문 안에서는 여전히 어색하다. 진짜 해결책은 명령과 조회를 분리해 혼란을 뿌리 뽑은 방법이다.

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

 

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

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

if (deletePage(page) == E_OK)

위 코드는 동사/형용사 혼란을 일으키지 않는 대신 여러 단계로 중첩되는 코드를 야기한다. 오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.

if(deletePage(page) == E_OK) {
    if (registry.deleteReference(page.name) == E_OK) {
        if (configKeys.deleteKey(page.name.makeKey()) == E_OK) {
            logger.log("page deleted");
        } else {
            logger.log("configKey not deleted");
        }
    } else {
        logger.log("deletereference from registry failed");
    }
} else {
    logger.log("delete failed");
    return E_ERROR;
}

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

try {
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}
catch (Exception e) {
    logger.log(e.getMessage());
}

 

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

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

 

반복하지 마라!

중복은 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 여러 곳을 수정해야 한다. 어느 한 곳이라도 누락되어 오류가 발생할 확률도 높다.

어쩌면 중복은 소프트웨어에서 모든 악의 근원이라 할 수 있다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다. 예를 들어 객체 지향 프로그래밍은 코드를 부모 클래스에 몰아 중복을 없앤다. 구조적 프로그래밍, AOP, COP 모두 어떤 면에서 중복 제거 전략이다. 소프트웨어 개발에서 지금까지 일어나 혁신은 소스 코드에서 중복을 제거하려는 지속적인 노력으로 보인다.