3장. 함수

목차

• 1. 작게 만들어라
• 2. 한 가지만 해라!
• 3. 함수 당 추상화 수준은 하나로!
  • 3-1. 위에서 아래로 코드 읽기: 내려가기 규칙
• 4. Switch문
• 5. 서술적인 이름을 사용하라!
• 6. 함수 인수
  • 6-1. 많이 쓰는 단항 형식
  • 6-2. 플래그 인수
  • 6-3. 이항 함수
  • 6-3. 인수 객체
  • 6-4. 인수 목록
  • 6-5. 동사와 키워드
• 7. 부수효과를 일으키지 마라!
  • 7-1. 출력 인수
• 8. 명령과 조회를 분리하라!
• 9. 오류 코드보다 예외를 사용하라!
  • 9-1. Try/Catch 블록 뽑아내기
  • 9-2. 오류 처리도 한 가지 작업이다
  • 9-3. Error.java 의존성 자석
• 10. 반복하지 마라!
• 11. 구조적 프로그래밍
• 12. 함수를 어떻게 짜죠?

Table of contents generated with markdown-toc

---

1. 작게 만들어라

함수를 만드는 첫 째 규칙은 작게이다! 두 번 째 규칙은 더 작게이다.
저자의 경험을 바탕으로 그리고 오랜 시행착오를 바탕으로 작은 함수가 더 좋다고 확신한다.

그렇다면 얼마나 짧아야 좋을까?

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

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

2. 한 가지만 해라!

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

여기서 그 한 가지라는 말이 애매하다. 보는 관점에 따라 범위가 달라지기 때문이다.

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

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

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

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

코드는 위에서 아래로 이야기처럼 읽혀야 좋다.

한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.
즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다.

코드를 위에서 아래로 읽으면서 함수의 역할 자체가 점점 작아진다는 의미?

4. Switch문

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

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

위 코드의 문제점

1. 코드가 길다. 새 직원 유형을 추가하면 더 길어진다.
2. '한 가지' 작업만 수행하지 않는다.
3. SPR를 위반한다. 코드를 변경할 이유가 여럿이기 때문이다.
4. OCP를 위반한다. 새 직원 유형을 추가할 때마다 코드를 변경하기 때문이다.
5. 위 함수와 구조가 동일한 함수가 무한정 존재한다.

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

public abstract class Employee {
  public abstract boolean isPayday();
  public abstract Money calculatePay();
  public abstract void deliverPay(Money money);
}

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

public class EmployeeFactoryImpl implements EmplyeeFactory {
  public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
    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);
    }
  }
}

이 부분 잘 이해되지 않음

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

워드가 말했던 원칙 중, '코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다' 를 생각해보자.

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

함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.
그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

이름을 붙일 때는 일관성이 있어야 한다.
예를 들어, includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage와 같이

6. 함수 인수

함수에서 이상적인 인수 개수는 0개. 다음으로 1개. 다음으로 2개이다.
3개 이상은 가능한 피하는 것이 좋다.
4개 이상은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안된다.

인수는 어렵다. 인수는 개념을 이해하기 어렵게 만든다.

예를 들어, includeSetupPageInto(new PageContent)보다 includeSetupPage()가 이해하기 더 쉽다.

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

6-1. 많이 쓰는 단항 형식

함수에 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지이다.

1. 인수에 질문을 던지는 경우
2. 인수를 뭔가로 변환해 결과를 반환하는 경우

6-2. 플래그 인수

플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다.
왜냐면, 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까!
플래그가 참이면 이걸 하고 거짓이면 저걸 한다는 말이니까!

6-3. 이항 함수

인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
예를 들어, writeField(name)보다 writeField(outputStream, name)보다 이해하기 쉽다.

물론 Point p = new Point(0, 0)은 이항 함수가 적절한 경우다.

6-3. 인수 객체

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

예를 들어, Circle makeCircle(double x, double y, double radius);를 Circle makeCircle(Point center, double radius);로 수정해보자

6-4. 인수 목록

때로는 인수 개수가 가변적인 함수도 필요하다. String.format 메서드가 좋은 예다.

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

위 코드처럼 가변 인수를 전부 동등하게 취급하면 List형 인수 하나로 취급할 수 있다.
이런 논리로 따져보면 String.format은 사실상 이항 함수이다.

실제로 String.format 선언부를 살펴보면 이항 함수라는 사실이 분명히 드러난다.
public String format(String format, Object... args)

가변 인수를 취하는 모든 함수에 같은 원리가 적용된다.

6-5. 동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.
단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.

예를 들어, write(name)은 누구나 곧바로 이해한다.
좀 더 나은 이름은 writeField(name)이다.

마지막 예제는 함수 이름에 키워드를 추가하는 형식이다.
즉, 함수 이름에 인수 이름을 넣는다.

예를 들어, assertEqual보다 assertExpectedEqualsActual(expected, actual)이 더 좋다.

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

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

만약 필요하다면 함수 이름에 분명히 명시하자.
물론 함수가 한 가지 일만 한다는 것을 위반하지만.

7-1. 출력 인수

객체 지향 프로그래밍이 나오기 전에는 출력 인수가 불가피한 경우도 있었다.
하지만 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다.

출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다.

일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

이 부분 이해 잘 안감

8. 명령과 조회를 분리하라!

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

public boolean set(String attribute, String value);

if(set("username", "unclebob"))...
코드를 처음 읽는 사람이 위 if문을 보고 어떻게 생각할까?
"username"을 "unclebob"으로 설정하는 코드인가?
혹은 "username"이 "unclebob"으로 설정되어 있는지 확인하는 코드인가 ?
헷갈릴 수 있다.

set함수를 setAndCheckIfExists라고 바꾸는 방법도 있지만 아래와 같이

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

조회와 명령을 분리하는 방법이 더 낫다.

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.

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("deletedReference 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());
}

가 훨 낫다.

9-1. Try/Catch 블록 뽑아내기

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

이렇게 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.

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

함수는 한 가지 작업만 해야 한다. 오류처리도 한 가지 작업에 속한다.

9-3. Error.java 의존성 자석

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

이는 다른 클래스에서 해당 오류 코드를 사용할 때 import해 사용해야 한다는 말이다.
즉, 오류 코드가 변한다면 오류 코드를 사용하는 다른 모든 클래스를 수정해야 하는 일이 생긴다.

때문에 오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다.

10. 반복하지 마라!

반복되면 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 반복되는 부분을 모두 손봐야 한다.
게다가 어느 한 곳이라도 빠뜨리는 바람에 오류가 발생할 확률도 증가한다.

중복은 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.

11. 구조적 프로그래밍

어떤 프로그래머는 에츠허르 데이크스트라의 구조적 프로그래밍 원칙을 따른다.
데이스크트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다.

즉, 함수는 return 문이 하나여야 한다는 말이다.
루프 안에서 break나 continue를 사용해선 안되며 goto는 절대로 안된다.

하지만 이는 함수가 아주 클 때만 상당한 이익을 제공한다.

함수를 작게 만든다면 return, break, continue를 여러 차례 사용해도 괜찮다.
오히려 때로는 단일 입/출구 규칙보다 의도를 표현하기 쉬워진다.

반면, goto문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야 한다.

12. 함수를 어떻게 짜죠?

소프트웨어를 짜는 행위는 어느 글짓기와 비슷하다.
논문이나 기사를 작성할 때는 먼저 생각을 기록 후 읽기 좋게 다듬는다.
초안은 대게 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.

프로그래밍할 때도 마찬가지이다. 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다. 이름은 즉흥적이고 코드는 중복된다. 하지만 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.

그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다. 이와중에도 코드는 항상 단위 테스트를 통과한다.
최종적으로는 이 장에서 설명하는 규칙을 따르는 함수가 얻어진다.

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