[클린코드] 3장 함수

5 분 소요

작게 만들어라!

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

블록과 들여쓰기

다시 말해, if 문/else 문/while 문 등에 들어가는 블록은 한 줄이어야 한다는 의미다. 대게 거기서 함수를 호출한다.
바깥을 감사는 함수(enclosing function)가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다. 이 말은 중첩 구조가 생길만큼 함수가 커져서는 안된다는 뜻이다.
그러므로 함수에서 들여쓰기 수주은 1단이나 2단을 넘어서면 안 된다. 당연한 말이지만, 그래야 함수는 읽고 이해하기 쉬워진다.

한가지만 해라!

함수는 한 가지를 해야한다. 그 한 가지를 잘해야 한다. 그 한 가지만을 해야 한다. 함수가 ‘한 가지’만 하는지 판단하는 방법은 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

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

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

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

코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.
즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. 이것을 내려가기규칙이라 부른다. 하지만 추상화 수준이 하나인 함수를 구현하기란 쉽지 않다. 많은 프로그래머가 곤란을 겪는다. 그렇지만 매우 중요한 규칙이다.
핵심은 짧으면서도 ‘한 가지’만 하는 함수다.

Switch 문

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

public Money calculatePay(Employee e) throws InvalidEmployeeType {
        switch(e.type)  {
            case COMMISSIONED:
                return calulateCommisionedPay(e);
            case HOURLY:
                return calulateHourlyPay(e);
            case SALARIED:
                return calulateSalariedPay(e);
            case default:
                return new InvalidEmployeeType(e.type);
        }
}

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

함수가 길다.
‘한 가지’ 작업만 수행하지 않는다.
SRP(Single Responsibility Principle)를 위반한다.
OCP(Open Closed Principle)를 위반한다.

public abstract class Employee {
    public abstract boolean isPayday();

    public abstract Money calculatePay();

    public abstract void deliveryPay(Money money);
}

public interface EmployeeFactory() {
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}

public class EmployeeFactoryIml implements EmployeeFactory {
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
        switch (r.type) {
            case COMMISSIONED:
                return new CommissionedEmployee(r);
            case HOURLY:
                return new HourlyEmployee(e);
            case SALARIED:
                return new SalariedEmployee(e);
            case default:
                return new InvalidEmployeeType(e.type);
        }
    }
}

이 문제를 해결한 코드다.
switch 문을 추상 팩토리에 꽁꽁 숨긴다. 아무에게도 보여주지 않는다.
팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다.
calculatePay, isPayday, deliveryPay 등과 같은 함수는 Employee 인터페이스를 거쳐 호출한다.
그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.

서술적인 이름을 사용하라

좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않다. “코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다” 한가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 달섬함에 있어 이미 절반은 성공했다. 함수가 작고 단순할수록 이름을 고르기도 쉬워진다.
이름이 길어도 괜찮다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코들를 개선하기 쉬워진다.
이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.
ex) includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage, includeSetupPage

함수 인수

함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)이고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개(다항)은 특별한 이유가 필요하다.
테스트 관점에서 보면 인수는 더 어렵다. 갖가지 인수 조합으로 함수를 검증하는 테스트 케이스를 작성한다고 상상해보라! 인수가 없다면 간단하다.
최선은 입력 인수가 없는 경우이며, 차성은 입력 인수가 1개뿐인 경우다.

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

부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까.

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".equal(phrase)) {
                Session.initialize();
                return true;
            }
        }
        return false;
    }
}

여기서, 함수가 일으키는 부수 효과는 Session.initialize(); 호출이다. 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다. 그래서 함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다. 위 함수 이름은 checkPasswordAndInitializeSession이라는 이름이 훨씬 좋다. 물론 함수가 ‘한 가지’만 한다는 규칙을 위반하지만

출력 인수

일반적으로 우리는 인수를 함수 입력으로 해석한ㄴ다. 어느 정도 프로그래밍 경력이 쌓였다면 인수를 출력으로 사용하는 함수에 어색함을 느낀다.
예를 들어 appendFooter(s)이 함수는 무언가에 s를 바닥글로 첨부할까? 아니면 s에 바닥글을 첨부할까?
인수 s는 입력일까 출력일까? 함수 선언부를 찾아보면 분명해진다.

public void appendFooter(StringBuffer report){...}

인수 s가 출력 인수라는 사실은 분명하지만 함수 선언부를 찾아보고 나서야 알았다.
함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다.
인지적으로 거슬린다는 뜻이므로 피햐야 한다.

객체 지향 프로그래밍이 나오기 전에는 출력 인수가 불가피한 경우도 있었다. 하지만 객체지향 언어에서는 출력 인수를 사용할 필요가 거의 없다.
출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다. 다시말해, report.appendFooter()와 같은 방식으로 호출하는것이 좋다.

명령과 조회를 분리하라!

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

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 if 문에서 명력 표현식으로 사용하기 쉬운 탓이다.
if (deletePage(page) == E_OK)
위 코드는 동사/형용사 혼란을 일으키지 않는 대신 여러 단계로 중첩되는 코드를 야기한다. 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.

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

try{
    deletePage(page);
} catch (Exception e) {
    logger.error("delete failed");
}

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

Try/Catch 블록 뽑아내기

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

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

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

private void logError(Exception e){
    logger.log(e.getMessage);
}

함수를 어떻게 짜죠?

소프트웨어를 짜는 행위는 글짓기와 비슷하다. 논문이나 기사를 작성할 때는 먼저 생각을 기록한 후 읽기 좋게 다듬는다.
함수를 짤 때도 마찬가지다. 처음에는 길고 복잡하다. 하지만 그 서투른 코들를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다.
최종저긍로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다. 처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.

결론

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

대가(master) 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이야기로 여긴다. 프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.

진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하기 바란다. 여러분이 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기 쉬워진다는 사실을 기억하기 바란다.

참조

클린코드

hongmo