함수

작게 만들어라!

함수를 만드는 첫째 규칙은 '작게!'다. 둘째 규칙은 '더 작게'이다.

const renderPageWithSetupsAndTeardowns : string = (pageData : PageData, isSuite : boolean) => {
  if(isTestPage(pageData)){
    includeSetupAndTeardownPages(pageData, isSuite)
    return pageData.getHtml();
  }
}

블록과 들여쓰기

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

이는 중첩 구조가 생길만큼 함수가 커서는 안 된다는 뜻이다.

함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다. 그래야 읽기 쉽다.

한가지만 해라!

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

지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.

의미있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러가지 일을 하고 있는 것이다.

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

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

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

한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.

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

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

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

함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.

서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.

이름을 붙일 때는 일관성이 있어야 한다.

함수 이름은 같은 문구, 명사, 동사를 사용한다.

// 예)
includeSetupAndTeardownPage
includeSetupPages
includeSuiteTeardownPage
includeTeardownPage

함수 인수

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

3개(삼항)는 가능한 한 피하는게 좋다.

`4개 이상(다항)은 사용하면 안된다.

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

우리는 함수에다 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙하다. 대게 함수에서 인수로 결과를 받으리라 기대하지 않는다.

setupTeardownIncluder.render(pageData)

// pageData 객체 내용을 렌더링 하겠다.(이해하기 쉬움)

많이 쓰는 단항 형식

  1. 인수에 질문을 던지는 경우

const fileExists("MyFile") // return boolean

  1. 인수를 뭔가로 변환해 결과를 반환하는 경우

passwordAttemptFailedNtimes(attempts)

이벤트 함수는 조심해서 사용한다. 이벤트라는 사실이 코드에 명확히 드러나야 한다. 이름과 문맥을 주의해서 선택한다.

플래그 인수

함수로 boolean값을 넘기는 관례는 끔찍하다. 왜냐하면, 함수가 한꺼번에 여러가지를 처리한다고 대놓고 공표하는 것이기 때문이다.

이항 함수

인수가 2개인 함수는 인수가 1개인 함수보다 이해하기가 어렵다.

당연하게 여겨지는 이항함수 assertEquals(expected, actual)에도 문제가 있다.

expected인수에 actual 값을 집어넣는 실수를 할 수도 있다.

인수의 순서를 인위적으로 기억해야 한다.

이항 함수가 무조건 나쁘다는 것은 아니다. 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸려고 노력해야 한다.

삼항 함수

인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 순서, 주춤, 무시로 야기되는 문제가 두배로 늘어난다.

삼항 함수를 만들 때는 신중히 고려하라

인수객체

인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언하는 가능성도 고려해보자.


// AS-IS
const makeCircle : Circle(x : number, y : number, radius : number) => {}

// TO-BE

type Pointer = {
  x : number,
  y : number
}

const makeCircle : Circle(center : Pointer, radius : number) => {}

변수를 묶어 넘기려면 이름을 붙여야 함에 따라, 개념을 표현하게 된다.

인수 목록

때로는 인수 개수가 가변적인 함수가 필요하다.

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

const foramt : string  (format : string, ...args : any[]) => {}

동사와 키워드

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

단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.

const write : string (name : string) => {}

// 이름이 무엇이든 쓴다라는 뜻이다.

또는 함수 이름에 키워드를 추가한다.

assertExpectedEqualsActual(expected, actual)

이렇게 할 경우, 인수 순서를 기억할 필요가 없어진다.

부수 효과(Side Effect)를 일으키지 마라!

Side Effect는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 것도 하기 떄문이다.

자칫하면 의도하지 않은 효과가 발생되어 혼란을 일으키게 된다.

명령과 조회를 분리하라!

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

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 if문에서 명령을 표현식으로 사용하기 쉬운 탓이다.

try {
  deletePage(page);
  ...
} catch(error : Error) {
  console.log(error)
}

Try/Catch블록 뽑아내기 & 오류 처리도 한 가지 작업이다.

Try/Catch 블록을 사용할 경우, 코드 구조에 혼란을 줄 수 있으며 정상 동작과 오류 처리 동작을 뒤섞는다.

Try/Catch 블록을 별도 함수로 뽑아내는 것이 좋다. 오류 처리도 한가지 작업으로 생각하고, 오류를 처리하는 함수는 오류만 처리해야 한다.

반복하지 마라

중복은 소프트웨어에서 모든 악의 근원이다.

함수를 어떻게 짜죠?

소프트웨어를 짜는 행위는 글짓기와 비슷하다.

처음에는 길고 복잡하다. 중복되는 루프와 인수 목록도 아주 길다. 이름은 즉흥적이고 중복된다. 서투른 코드를 빠짐없이 테스트 하는 단위 테스트도 만든다. 이후, 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. (리팩토링) 메서드를 줄이고 순서를 바꾼다. 이 와중에도 항상 단위 테스트를 통과한다.

처음부터 탁 짜내지는 않는다. 그게 가능한 사람은 없다.

Previous의미 있는 이름Next주석

Last updated