[클린 코드] 3장. 함수

작게 만들어라!

• 프로그램의 가장 기본적인 단위인 함수
• 함수를 만드는 첫째 규칙은 '작게!'다. 함수를 만드는 둘째 규칙은 '더 작게!'다.
• if 문/else 문/while 문 등에 들어가는 블록은 한 줄이어야 하며 대게 거기서 함수를 호출한다.
  그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.

// good
if (isTestPage(pageData))
    // 설정 페이지와 해제 페이지를 테스트 페이지에 넣은 후 해당 테스트 페이지를 HTML로 렌더링하기 위해
    // 설정 페이지와 해제 페이지를 테스트 페이지에 넣음
    includeSetupAndTeardownPages(pageData, isSuite);

한 가지만 해라!

• 함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한가지만을 해야 한다.
• 우리가 함수를 만드는 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서이다.
• 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.
• 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

// bad
버퍼를 생성하고, 페이지를 가져오고, 
상속된 페이지를 검색하고, 
경로를 렌더링하고, 
불가사의한 문자열을 덧붙이고, 
HTML을 생성한다.

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

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

• 함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
• 코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.
• 위에서 아래로 문단을 읽어내려 가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기가 쉬워진다.

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

Switch문

• 본질적으로 switch 문은 N가지를 처리하므로 작게 만들기 어렵다.
• 그러므로 상속 관계를 통해 switch 문을 추상 팩토리에 숨기고 아무에게도 보여주지 않도록 함
  
• 이 후 팩토리는 switch 문을 사용해 적절한 파생 클래스의 인스턴스를 생성하고
  다형성으로 인해 실제 파생 클래스의 함수가 실행된다.

// bad
public Money caculatePay(Employee e) throws InvalidEmployeeType {
    switch (e.type) {
      case COMMISIONED:
        return calculateCommisionedPay(e);
      case HOURLY:
        return calculateHourlyPay(e);
      case SALARIED:
        return calculateSalariedPay(e);
      default:
        throw new InvalidEmployeeType(e.type);
    }
}
            
// good
public abstract class Employee {
  // 함수는 Employee 인터페이스를 거쳐 호출됨
  public abstract boolean isPayday();
  public abstract Money calculatePay();
  public abstract void deliverPay(Money pay);
}

public interface EmployeeFactory {
  // swtich 문을 추상 팩토리에 숨김
  public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}

public class EmployeeFactoryImpl implements EmployeeFactory {
  public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
      // 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성
      switch (e.type) {
      case COMMISIONED:
        return new calculateCommisionedPay(e);
      case HOURLY:
        return new calculateHourlyPay(e);
      case SALARIED:
        return new calculateSalariedPay(e);
      default:
        throw new InvalidEmployeeType(e.type);
    }
  }
}

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

• 한 가지만 하는 작은 함수에 함수가 하는 일을 좀 더 잘 표현하는 좋은 이름을 붙인다.
• 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
  길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
• 서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.
• 이름을 붙일 때는 일관성이 있어야 한다.
• 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.

// good
includeSetupAndTeardownPages
includeSetupPages
includeSuiteSetupPage
includeSetupPage
includeTeardownPages
includeSuiteTeardownPage
includeTeardownPage

함수 인수

• 함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)이고, 다음은 2개(이항)다.
  3개(삼항)은 가능한 피하는 편이 좋다. 4개 이상(다항)은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다.
• 인수에 질문을 던지는 경우, 인수를 뭔가로 변환해 반환하는 경우, 이벤트의 경우가 아니라면 단항 함수는 가급적 피한다.
• 플래그 인수는 함수로 부울 값을 넘기게 되므로 함수가 한꺼번에 여러 가지를 처리한다고 공표하는 것이다.
  그러므로 두 함수로 나눠야 마땅하다.
• 이항 함수의 경우 첫 인수를 무시해야 더 쉽게 읽히게 되는데 어떤 코드든 무시할 경우 무시한 코드에 오류가 숨어드므로
  가능하면 단항 함수로 바꾸도록 애써야 한다.
• 인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.
• 때로는 인수 개수가 가변적인 함수도 필요하다. 하지만 삼항 함수를 넘어서는 인수를 사용할 경우 문제가 있다.
• 함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필요하다.
  단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 하며, 함수 이름에 키워드(인수 이름)를 추가하는 형식으로 작성도 가능하다.

// bad
Circle makeCircle(double x, double y, double radius);
asserEquals(expected, actual)

// good
Circle makeCircle(Point center, double radius);
writeField(name)
assertExpectedEqualsActual(expected, actual)

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

• 함수에 한 가지를 하겠다고 약속하고선 남몰래 다른 짓을 하는 부수 효과는 거짓말이다.
• 부수 효과는 시간적인 결합을 초래하고 이는 혼란을 일으킨다.
• 만약 시간적인 결합이 필요하다면 함수 이름에 분명히 명시해야 하며
  이 경우에도 함수가 '한 가지'만 한다는 규칙을 위반하게 된다.
• 일반적으로 출력 인수는 피하며 출력 인수로 사용하라고 설계한 변수인 this를 사용하며,
  함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

// bad
public class UserValidator {
  private Cryptographer cryptographer;
  
  public boolean checkPassword(String userName, String password) {
    User user = UserGateway.findByName(userName);
    if (user != User.NULL) {
      String codePhrase = user.getPhraseEncodedByPassword();
      String phrase = cryptographer.decrypt(codedPhrase, password);
      if ("Valid Password".equals(phrase)) {
        // 부수 효과로 인해 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처할 수 있음
        Session.initialize(); 
        return true;
      }
    }
    return false;
  }
}

명령과 조회를 분리하라!

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

// attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true를 반환하고 실패하면 false를 반환하는 함수
public boolean set(String attribute, String value);

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

// good
if (attributeExists("username")) { // 조회
  setAttribute("username", "unclebob"); // 명령 분리
  ...
}

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

• 명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.
• 오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪친다.
• 반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.
• try/catch 블록은 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞으므로 별도 함수로 뽑아내는 편이 좋다.
• 오류 처리도 '한 가지' 작업에 속하므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다.

// bad
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");
      ...
}

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

// very good
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());
}

반복하지 마라!

• 중복으로 인해 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 모든 곳을 손봐야 하며
  어느 한곳이라도 빠뜨리는 바람에 오류가 발생할 확률도 높아진다.
• 중복을 없애면 모듈 가독성이 크게 높아진다.
• 중복은 소프트웨어에서 모든 악의 근원이다.
  많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.
  객체지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다.
  구조적 프로그래밍, AOP, COP 모두 어떤 면에서 중복 제거 전략이다.

구조적 프로그래밍

• 구조적 프로그래밍의 목표와 규율로 인해
  함수가 아주 클 때에는 return 문이 하나여야 하며 루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로 안된다.
• 하지만 함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮으며 
  goto 문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야만 한다. 

함수를 어떻게 짜죠?

• 처음에는 길고 복잡하다.
  들여쓰기 단계도 많고 중복된 루프도 많다.
  인수 목록도 아주 길다.
  이름은 즉흥적이고 코드는 중복된다.
  그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
• 그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다.
  메서드를 줄이고 순서를 바꾼다.
  때로는 전체 클래스를 쪼개기도 한다.
  이와중에도 코드는 항상 단위 테스트를 통과한다.
• 최종적으로 규칙을 따르는 함수가 얻어진다. 
  처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.