[클린코드] 함수

3-2 함수가 읽기 쉽고 이해하기 쉬운 이유는 무엇일까?

의도를 분명히 표현하는 함수를 어떻게 구현할 수 있을까?

함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까?

 

이 질문들과 함께 챕터를 읽어보자.

작게 만들어라!

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

→ 이 함수는 이야기처럼 술술 읽혀진다.

 

블록과 들여쓰기

if문 / else문 / while문 등에 들어가는 블록은 한 줄이어야한다는 의미이다.

• 대개 거기서 함수를 호출한다.
• 중첩 구조가 생길만큼 함수가 커져서는 안된다
  → 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다.

한 가지만 해라!

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

그 “한가지”가 무엇일까?

위의 목록 3-3은 한가지만 하는가? 아니면 세가지를 하는가? 라는 질문을 던지고 있다.

 

3-3에서 하는 작업들(테스트 페이지인지 판단, 그렇다면 설정 페이지와 해제 페이지를 넣음, 페이지를 HTML로 렌더링)은 추상화 수준이 같기 때문에 한 작업을 수행한다고 한다. 의미를 유지하면서 더이상 줄이기가 불가능하다.

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

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

• 함수가 확실히 “한가지” 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
• 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.
  특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다.
• 위에서 아래로 코드 읽기: 내려가기 규칙
  • 내려가기 규칙: 한 함수 다음에는 추상화 수준이 한단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한번에 한단계씩 낮아진다.
  • 핵심은 짧으면서도 “한 가지”만 하는 함수다.

Switch 문

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

• 함수가 길다 → 새 직원 유형을 추가하면 더 길어진다.
• “한가지” 작업만 수행하지 않는다.
• SRP(Single Responsibility Principle, 단일책임원칙)을 위반한다. → 코드를 변경할 이유가 여럿이기 때문이다.
• OCP(Open Closed Principle, 개방-폐쇄 원칙)를 위반한다. → 새 직원 유형을 추가할 때마다 코드를 변경하기 때문이다.
• OCP: 기존의 코드를 변경하지 않으면서, 기능을 추가할 수 있도록 설계가 되어야 한다는 원칙
• 가장 심각한 문제라면, 위 함수와 구조가 동일한 함수가 무한정 존재한다는 사실이다.모두 똑같이 유해한 구조이다.
• isPayDay(Employee e, Date date);

이 문제들을 다음과 같은 해결법으로 개선할 수 있다.

• switch 문을 추상 팩토리에 숨겨 아무에게도 보여주지 않는다.
• 적절한 Employee 파생 클래스의 인스턴스를 생성하여, 함수들을 Employee 인터페이스를 거쳐 호출하도록 하자.
  → 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.

public abstract clas Employee {
    public abstract boolean isPayday();
    public abstract Money calculatePay();
    public abstract void deliverPay(Money pay);
}
 
// 팩토리는 switch문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다.
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 COMMISSIONED:
            return new CommissionedEmployee(r);
        case HOURLY:
            return new HourlyEmployee(r);
        case SALARIED:
            return new SalariedEmployee(r);
        default:
            throw new InvalidEmployeeType(r.type);
    }
}

서술적인 이름을 사용하라

• 코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드로 불러도 되겠다 - 워드
• 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
• 이름을 붙일 때는 일관성이 있어야 한다.

함수 인수

함수에서 이상적인 인수 개수는 0개(무항), 다음이 1개(단항) → 2개(이항)

단항 함수

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

1. 인수에 질문을 던지는 경우
2. 인수를 뭔가로 변환해 결과를 반환하는 경우
3. (다소 드물게 사용) 이벤트 함수일 경우 (이 경우에는 이벤트라는 사실이 코드에 명확하게 드러나야 한다.) → 입력 인수만 있고 출력 인수는 없다.
4. ex) passwordAttemptFailedNtimes(int attempts)

플래그 인수

플래그 인수는 추하다. 쓰지마라. bool 값을 넘기는 것 자체가 그 함수는 한꺼번에 여러가지 일을 처리한다고 공표하는 것과 마찬가지다.

• render(boolean isSuite) X
• renderForSuite()와 renderForSingleTest() O

이항 함수

• 단항 함수보다 이해하기가 어렵다.
• Point 클래스의 경우에는 이항 함수가 적절하다. 적도 좌표계 점은 일반적으로 인수 2개를 취하기 때문이다. Point p = new Point(x,y);
• 무조건 나쁜 것은 아니지만, 인수가 2개이니 만큼 이해가 어렵고 위험이 따르므로 가능하면 단항으로 바꾸도록 애써야 한다.아니면 outputStream을 현재 클래스 구성원 변수로 만들어 인수로 넘기지 않도록 한다.
• 아니면 FieldWriter라는 새 클래스를 만들어 구성자에서 outputStream을 받고 write 메서드를 구현한다.
• 예를 들어, writeField 메서드를 outputStream 클래스 구성원으로 만들어 outputStream.writeField(name)으로 호출한다.

삼항 함수

이항 함수보다 이해하기가 훨씬 어려우므로, 위험도 2배 이상 늘어난다. 삼항 함수를 만들 때는 신중히 고려하라.

함수를 살펴볼 때 주춤하지 않도록…!

 

인수 객체

인수가 많이 필요할 경우, 일부 인수를 독자적인 클래스 변수로 선언할 가능성을 살펴보자 x,y를 인자로 넘기는 것보다 Point를 넘기는 것이 더 낫다.

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

 

인수 목록

• 인수 개수가 가변적인 함수일 경우 String.format 메서드가 좋은 예String.format의 인수는 List형 인수이기 때문에 이항함수라고 할 수 있다.
• public String format(String format, Object... args)
• 가변 인수를 취하는 모든 함수에 같은 원리가 적용 (단항, 이항, 삼항 함수로 취급)void dyad(String name, Integer... args);
• void triad(String name, int count, Integer... args);
• void monad(Integer... args);

동사와 키워드

• 함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수
• 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
• writeField(name) 'field'인 'name'이 무엇이든 'write' 한다.
• 함수 이름에 키워드를 추가해보자. (함수 이름에 인수 이름을 넣자)checkPassword -> checkPasswordAndInitializeSession
• assertExpectedEqualsActual(expected, actual) → 인수 순서를 기억할 필요가 없어진다.

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

(p.54)

부수 효과는 거짓말이다. 함수에서 한가지를 하겠다고 약속하고는 남몰래 다른 짓을 하는 것이므로, 한 함수에서는 딱 한가지만 수행할 것!

아래 코드에서 Session.initialize();는 함수명과는 맞지 않는 부수효과이다.

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

그럴 경우에는 함수 이름에 분명히 명시해주자.

checkPasswordAndInitializeSession()이라는 이름이 훨씬 좋다. 단, 함수가 '한 가지'만 한다는 규칙을 위반하지만..

 

출력 인수

appendFooter(s) 무언가에 s를 바닥글로 첨부할까? 아니면 s에 바닥글을 첨부할까? 인수 s는 입력이띾 출력일까?

함수 선언부를 찾아보면 분명해진다.

public void appendFooter(StringBuffer report)

함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다.

• 일반적으로 인수를 함수 입력으로 해석
• 일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하자.
• public void appendFooter(StringBuffer report) -> report.appendFooter()

명령과 조회를 분리하라!

함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘다 하면 혼란을 초래하낟.

• 모호한 의미의 코드username이 unclebob으로 설정되어 있는지 확인하는 코드인가? 아니면 unclebob으로 설장하는 코드인가?
• 함수를 호출하는 코드만 봐서는 의미가 모호하다.
• if (set("username", "unclebob"))
• 명령과 조회를 분리한 코드setAndCheckIfExists라고 바꾸는 방법도 있지만 if 문에 넣고 보면 여전히 어색하다.

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

• 진짜 해결책은 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법이다.
• 사실 username을 unclebob으로 설정하는 코드이다.

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

• 명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 위반한다.
• 오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 하는 문제가 발생한다.
• 오류 코드 대신 예외(ex. 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());
}

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

• 함수에 키워드 try가 있다면 함수는 try 문으로 시작해 catch/finally 문으로 끝나야 한다.

반복하지 마라!

• 중복은 소프트웨어에서 모든 악의 근원이다.
• 객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다. (구조ㅓ적 프로그래밍, AOP, COP 모두 어떤 면에서 중복 제거 전략이다)

구조적 프로그래밍

• 데이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다. → 함수는 return 문이 하나여야 한다.
• 함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다.
• 하지만 함수가 아주 커지면 return문은 하나여야 상당한 이익을 제공한다.

함수를 어떻게 짜죠?

• 초안은 대개 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.
• 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 전체 클래스를 쪼개기도 한다.

결론

대가 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이야기로 여긴다.

프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.