[클린코드] 3장 함수 with Typescript

3장 함수

함수는 프로그램의 가장 기본적인 단위이다.

이 장에서는,

• 의도를 분명하게 표현하는 함수를 만드는 방법
• 프로그램 내부를 직관적으로 파악할 수 있도록 함수를 쉽게 읽고 이해할 수 있도록 만드는 방법

에 대해서 알아본다.

---

작게 만들어라!

함수는 작을수록 더 좋다. 그래야 읽고 이해하기 쉬워진다.

조건문, 반복문 등에 들어가는 블록은 한 줄이어야 한다. 즉,

• 중첩 구조가 생길 만큼 함수가 커져서는 안 된다.
• 함수에서 들여 쓰기 수준은 2단을 넘어서면 안 된다.

 

한 가지만 해라!

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

여기에서 ‘한 가지를 한다’가 의미하는 것은 추상화 수준이 하나인 단계만 수행한다는 것이다.

단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

 

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

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

한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지, 세부사항인지 구분하기 어렵기 때문이다.

근분 개념과 세부사항이 뒤섞이면 함수에 세부사항을 점점 추가하게 된다.

 

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

내려가기 규칙이란, 위에서 아래로 갈수록 함수 추상화 수준이 한 단계씩 낮아진다는 규칙이다.

위에서 아래로 읽어 내려가듯 코드를 구현하면 추상화 수준을 일관되게 유지하기 쉬워진다.

 

Switch 문

본질적으로 switch 문은 N가지 일을 한다. 또한 작게 만들기 힘들다.

switch문을 사용해야 한다면 코드를 저차원 클래스에 숨기고 절대로 반복하지 않도록 한다.

function calculatePay(e: Employee) {
	switch (e.type) {
		case COMISSIONED:
			return calculateComissionedPay(e);
		case HOURLY:
			return calculateHourlyPay(e);
		case SALARIED:
			return calculateSalariedPay(e);
    default:
      throw new InvalidEmployeeType(e.type)
	}
}

위 코드의 문제점은 다음과 같다

1. 함수가 길다. Employee type이 추가된다면 더 길어진다.
2. 한 가지 작업만 수행하지 않는다.
3. Single Responsibility Principle을 위반한다. 코드를 변경할 이유가 여럿이기 때문에
4. Open Closed Principle을 위반한다. 새 type이 추가할 때마다 코드를 변경하기 때문에
5. 위 함수와 구조가 동일한 코드가 무한정 존재하게 된다.
6. ex) isPayday(e: Employee, date: Date), deliverPay(e: Employee, pay: Money)

이 문제를 해결하려면

• switch 문을 팩토리 함수로 꽁꽁 숨긴다.
• 유형별 Employee는 상속을 통한 다형성을 이용하여 구현하고, 팩토리 함수를 통해서만 생성한다.

 

먼저 모든 유형의 Employee가 상속받는 추상 클래스는 다음처럼 구현할 수 있다.

abstract class Employee {
  protected record: EmployeeRecord;
  protected abstract isPayday(): boolean;
  protected abstract caclulatePay(): Money;
  protected abstract deliverPay(pay: Money): void;

  constructor(r: EmployeeRecord) {
    this.record = r;
  }
}

 

각 type 별로 파생 클래스를 다음처럼 구현한다.

// Employee의 파생 클래스
class ComissionedEmployee extends Employee {
  protected isPayday(): boolean {
    ...
  }
  protected caclulatePay(): number {
    ...
  }
  protected deliverPay(pay: number): void {
    ...
  }
}

 

팩토리 함수는 다음처럼 구현한다.

function makeEmployee(r: EmployeeRecord): Employee {
  switch (r.type) {
    case 'COMISSIONED':
      return new ComissionedEmployee(r); //Employee의 파생 클래스
    case 'HOURLY':
      return HourlyEmployee(r); //Employee의 파생 클래스
    case 'SALARIED':
      return SalariedEmployee(r); //Employee의 파생 클래스
    default:
      throw new InvalidEmployeeType(r.type);
  }
}

 

이제 다른 모든 코드에서 Employee의 type별로 switch문을 사용할 일이 없어진다.

또한, 새로운 type이 추가되더라도 팩토리 함수를 제외한 다른 코드는 변경하지 않아도 된다.

const employee = makeEmployee(record);
// switch 문이 필요없다
if(employee.isPayday())
	employee.deliverPay();

 

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

좋은 이름이 주는 가치는 클린코드 전반에 거쳐서 강조하고 있는 내용이다.

함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.

• 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
• 이름을 붙일 때 일관성이 있어야 한다. 모듈 내에서 같은 문구, 명사, 동사를 사용하여 문체를 비슷하게 만들어라

 

함수 인수

• 함수 인수는 0개 인 것이 가장 좋고 가능한 3개 이상은 피하는 편이 좋다.
  • 테스트 관점에서도 인수가 많을수록 모든 조합을 구성해 테스트하기가 부담스러워진다.
• 출력 인수는 이해하기 어려우므로 지양한다. 함수에서 인수로 결과를 받는 것은 직관적이지 않기 때문이다.

 

많이 쓰는 단항 형식

단항 함수를 사용하는 경우는 크게 세 가지이다.

1. 인수에 질문을 던지는 경우
2. ex) fileExists: (path: string) ⇒ boolean
3. 인수를 뭔가로 변환해 결과를 반환하는 경우
4. ex) fileOpen: (path: string) ⇒ InputStream
5. 단항 함수를 이벤트로 사용하는 경우 - 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다. ex) passwordAttemptFailedNtimes: (attempts: number) ⇒ void

함수 이름을 지을 때는 세 경우를 분명히 구분하고, 일관적인 방식으로 각 형식을 사용해야 한다.

이벤트 함수는 이벤트라는 사실이 코드에 명확히 드러나야 한다.

 

플래그 인수

플래그 인수는 함수가 여러 가지 일을 한다는 뜻이다.

가능한 두 개의 함수로 분리한다.

 

이항 함수, 삼항 함수

이항함수가 적절한 경우는 한 값을 표현하는 두 요소인 경우, 자연적인 순서가 있는 경우이다.

ex) const point = new Point(0, 0)

이항 함수는 단항 함수보다 이해하기 어렵기 때문에 지양하는 편이 좋다.

무조건 나쁜 건 아니지만 위험이 따른다는 사실을 이해하고, 가능하면 단항 함수로 바꾸도록 애써야 한다.

삼항 함수 또한 당연히 이항 함수보다 훨씬 더 어렵다. 신중히 고려하여 사용해야 한다.

 

인수 객체

인수가 2개 이상 필요하다면 일부를 독자적인 클래스나 object 변수로 선언할 수 있는지 짚어본다.

변수를 묶어서 넘길 때 이름을 붙여야 하므로 결국은 개념을 표현할 수 있게 된다.

function makeCircle(x: number, y: number, radius: number)

type Point = {x: number, y: number}
function makeCircle(point: Point, radius: number)

 

동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하기 위한 좋은 함수 이름은 다음처럼 지을 수 있다.

• 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
• writeField(name)
• 함수 이름에 키워드를 추가한다. 즉, 함수 이름에 인수 이름을 넣는다.
• assertEquals(expected, actual) → assertExpectedEqualsActual(expected, actual)

 

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

많은 경우 시간적인 결합이나 순서 종속성을 초래할 수 있다.

function checkPassword(username: string, password: string) {
  const user = findByName(username)
  if(user) {
		const codedPhrase = getPhraseEncodedByPassword();
    const phrase = decrypt(codedPhrase, password);
    if ("Valid Password" === phrase) {
      Session.initialize(); // 🔴 함수가 일으키는 부수 효과
      return true
    }
  }
  return false
}

checkPassword라는 함수 이름에서 세션을 초기화한다는 사실이 드러나지 않는다.

이런 부수 효과가 시간적인 결합을 초래한다. 즉, 세션을 초기화해도 괜찮은 경우에만 호출이 가능하다.

시간적인 결합이 필요하다면 함수 이름에 분명히 명시하도록 한다.

 

명령과 조회를 분리하라!

함수는 객체 상태를 변경하거나, 객체 정보를 반환하거나 둘 중 하나만 하도록 한다.

// 🔴 username 속성을 unclebob으로 바꾸는 것에 성공하면 true, 실패하면 false를 반환하는 함수
// username이 unclebob으로 설정되어 있다면...으로 읽힌다
if(set("username", "unclebob")) ...

// 🟢 조회와 명령을 다른 함수로 분리해서 혼란을 일으키지 않는다.
if(attributeExists("username")) {
	setAttribute("username", "unclebob")
}

 

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

오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 위반한다.

또한, 여러 단계로 중첩되는 코드를 야기하게 된다. 호출자는 오류 코드를 곧바로 처리해야 하기 때문이다.

반면 예외를 사용하면 try/catch 문을 통해 오류 처리 코드가 원래 코드에서 분리될 수 있다.

 

try/catch 블록 뽑아내기

try/catch문은 정상 동작과 오류 처리 동작을 뒤섞는다.

따라서 별도 함수로 뽑아내는 편이 좋다.

 

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

따라서 오류를 처리하는 함수는 오류만 처리한다.

 

구조적 프로그래밍

모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다.

• 함수는 return 문이 하나여야 한다
• 루프 안에서 break, continue를 사용해선 안된다.

단, 함수가 아주 클 때만 상당한 이익을 제공한다.

함수를 작게 만든다면 return, break, continue의 사용이 의도를 표현하는 데 더 유리할 수 있다.