함수

함수를 작게 만들자

함수는 길어도 10줄 이내로 만들자.

블록과 들여쓰기

if문/else 문/while 문 등에 들어가는 블록은 한 줄이어야 한다. 대개 거기서 함수를 호출한다. 그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.
중첩 구조가 생길만큼 함수가 커져서는 안 된다. 그러므로 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.

함수는 한 가지만 하도록 하자

지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다. 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

함수 당 추상화 수준은 하나로 만들자

함수가 한 가지 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다. 한 함수 내에 추상화 수준을 섞으면 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려워져 코드를 읽는 사람이 헷갈린다.
근본 개념과 세부사항을 뒤섞기 시작하면, 사람들이 함수에 세부사항을 점점 더 추가하게 된다.

내려가기 규칙

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

Switch문

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

...

public Employee makeEmployee(EmployeeRecord r) {
    switch(r.type) {
        case COMMISSIONED:
            return new CommissionedEmployee(r);
        case HOURLY:
            return new HourlyEmployee(r);
        case SALARIED:
            return new SalariedEmployee(r);
        default:
            throw new InvalidEmployeeType(r.type);
    }
}

서술적인 이름을 사용하자

함수가 하는 일을 좀 더 잘 표현하면 좋은 이름이다. 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다. includeSetupAndTeardownPages, includeSetupPages, includeSetupPage 등이 좋은 예다.

함수 인수

함수에서 이상적인 인수 개수는 0개다. 4개 이상은 사용하면 안 된다. 인수는 개념을 이해하기 어렵게 만든다. 테스트 관점에서 보면 인수는 더 어렵다. 갖가지 인수 조합으로 함수를 검증하는 테스트 케이스를 작성해야 하기 때문이다.
출력 인수는 입력 인수보다 이해하기 어렵다. 흔히 우리는 함수에다 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙하다. 대개 함수에서 인수로 결과를 받으리라 기대하지 않는다. 그래서 출력 인수는 독자가 코드를 재차 확인하게 만든다.

단항 함수

  • 인수에 질문을 던지는 경우 boolean fileExists("MyFile")
  • 인수를 변환해 결과를 반환하는 경우 InputStream fileOpen("MyFile")
  • 이벤트 함수, 이벤트 함수는 입력 인수만 있고 출력 인수는 없다. 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다.

위 경우가 아니라면 단항 함수는 가급적 피하자.

변환 함수

입력 인수를 변환하는 함수라면 변환 결과는 반환값으로 돌려주도록 하자.
StringBuffer transform(StringBuffer in)이 void transform(StringBuffer in)보다 좋다. 입력 인수를 그대로 돌려주는 함수라 할지라도 변환 함수 형식을 따르는 편이 좋다.

플래그 인수

함수로 boolean 값을 넘기는 함수는 함수가 한꺼번에 여러 가지를 처리한다고 공표하는 셈이다. 되도록 사용하지 말자.

인수 객체

인수가 2~3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어보자. 객체를 생성해 인수를 줄이는 방법은 인수의 개념을 표현하게 된다.

가변 인수

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

가변 인수를 취하는 모든 함수는 단항, 이항, 삼항 함수로 취급할 수 있다. 하지만 이를 넘어서는 인수를 사용할 경우에는 문제가 있다.

출력 인수

객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다. 출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택하자.

동사와 키워드

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

  • 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. writeField(name)
  • 함수 이름에 인수 이름을 넣으면 인수 순서를 기억할 필요가 없어진다. assertEquals(expected, actual) 보다 assertExpectedEqualsActual(expected, actual)이 더 좋다.

부수 효과를 일으키지 말자

함수에서 한 가지를 하겠다고 약속하고선 다른 일을 하는 부수효과는 좋지 않다. 예를 들어, checkPassword 메서드에서 userName과 password를 확인하고 세션을 초기화하는 작업을 부수적으로 수행한다면 시간적인 결합을 초래한다. 즉, checkPassword 메서드는 특정 상황에서만 호출이 가능하다. 자칫 잘못 호출하면 의도하지 않게 세션 정보가 날아간다.

명령과 조회를 분리하자

함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘 다 하면 안 된다. 객체 상태를 변경하거나 객체 정보를 반환하거나 둘 중 하나다.

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

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 logError(Exception e) {
    logger.log(e.getMessage));
}

delete 함수는 모든 오류를 처리한다. 실제로 페이지를 제거하는 함수 deletePageAndAllReferences는 예외를 처리하지 않는다. 이렇게 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.

오류를 처리하는 함수는 오류만 처리해야 마땅하다. 함수에 키워드 try가 있다면 함수는 try문으로 시작해 catch/finally 문으로 끝나야 한다는 말이다.

의존성 자석

오류 코드를 반환한다는 이야기는 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.

public enum Error {
    OK,
    INVALID,
    NO_SUCH,
    LOCKED,
    OUT_OF_RESOURCES,
    WAITING_FOR_EVENT;
}

위와 같은 클래스는 다른 클래스에서 Error enum을 import해 사용해야 하므로 의존성 자석이다. 즉, Error enum이 변한다면 Error enum을 사용하는 클래스 전부를 다시 컴파일해야 한다. 그래서 Error 클래스 변경이 어려워진다.
오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생되어 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다.

중복을 없애자

코드가 중복되면 코드 길이가 늘어날 뿐 아니라, 수정할 일이 생겼을 때, 어느 한곳이라도 빠뜨리면 오류가 발생하게 된다.
소프트웨어의 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.

구조적 프로그래밍

모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다는 원칙. 즉, 함수는 return 문이 하나여야 한다. 루프 안에서 break나 continue를 사용해선 안되며 goto는 절대로 안 된다.
구조적 프로그래밍은 함수가 아주 클 때만 상당한 이익을 제공한다. 그러므로 함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다. 오히려 단일 입/출구 규칙보다 의도를 표현하기 쉬워진다.

함수 작성법

처음 함수를 짤 때는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다. 이름은 즉흥적이고 코드는 중복된다. 하지만 단위 테스트 케이스는 꼭 작성하자.
그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다. 이와중에도 코드는 항상 단위 테스트를 통과해야 한다.

Categories:

Updated:

Comments