함수를 잘 만드는 법

Hant·2021년 10월 28일
CLEAN CODE
0

Clean Code

목록 보기
2/13
post-thumbnail

1. 작게 만들어라!

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

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

function renderPageWithSetupsAndTeardowns(pageData: PageData, isSuite: boolean): string {
  if (isTestPage(pageData)) {
    includeSetupAndTeardownPages(pageData, isSuite);
  }

  return pageData.getHtml();
}

2. 한 가지만 해라!

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

지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 합니다. 함수를 만드는 이유는 큰 개념을 다음 수준에서 여러 단계로 나눠 수행하기 위함입니다. 작게 만들어라에서 사용한 예시를 TO 문단으로 기술하면 다음과 같습니다.

TO RenderPageWithSetupsAndTeardowns, 페이지가 테스트 페이지인지 확인 한 후 테스트 페이지라면 설정 페이지와 해제 페이지를 넣습니다. 테스트 페이지든 아니든 페이지를 HTML로 렌더링합니다.

함수가 한 가지만 하는지 판단하는 방법이 하나 더 있습니다. 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈입니다. 한 가지 작업만 하는 함수는 자연스럽게 섹션으로 나누기 어렵습니다.

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

함수가 확실히 한 가지 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 합니다. 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈립니다. 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓입니다.

const html: string = pageData.getHtml(); // 추상화 수준이 높음
const pagePathName: string = PathParser.render(pagePath); // 추상화 수준이 중간
buffer.append(pagePathName); // 추상화 수준이 낮음

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

코드는 위에서 아래로 이야기처럼 읽혀야 좋습니다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 옵니다.

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

4. Switch 문

switch 문은 작게 만들기 어렵습니다. case 분기가 단 두 개인 switch 문도 너무 길며, 단일 블록이나 함수가 좋습니다. 또한 한 가지 작업만 하는 switch 문도 만들기 어렵습니다. 본질적으로 switch 문은 N가지를 처리합니다. 불행하게도 swtich 문을 완전히 피할 방법은 없습니다. 하지만 다형성(Polymorphism)을 이용해서 swtich 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있습니다.

function calculatePay(e: Employee): Money {
  switch (e.type) {
    case COMMISSIONED:
      return calculateCommissionedPay(e);
    case HOURLY:
      return calculateHourlyPay(e);
    case SALARIED:
      return calculateSalariedPau(e);
    default:
      throw new InvalidEmployeeType(e.type);
  }
}

위 함수에는 몇 가지 문제가 있습니다. 첫째, 함수가 깁니다. 새 직원 유형을 추가하면 더 길어집니다. 둘째, 한 가지 작업만 수행하지 않습니다. 셋째, SRP(Single Responsibility Principle)를 위반합니다. 코드를 변경할 이유가 여럿이기 때문입니다. 넷째, OCP(Open Closed Principle)를 위반합니다. 새 직원 유형을 추가할 때마다 코드를 변경하기 때문입니다. 하지만 가장 심각한 문제라면 위 함수와 구조가 동일한 함수가 무한정 존재한다는 사실입니다. 예를 들어, 다음과 같은 함수가 가능합니다.

function isPayday(e: Employee, date: Date): boolaen;
function deliverPay(e: Employee, pay: Money): void;

다음 코드는 이 문제를 해결한 코드입니다. switch 문을 추상 팩토리(ABSTRACT FACTORY)에 꽁꽁 숨깁니다. 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성합니다. calculatePay, isPayday, deliverPay 등과 같은 함수는 Employee 인터페이스를 거쳐 호출됩니다. 그러면 다향성으로 인해 실제 파생 클래스의 함수가 실행됩니다.

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

interface EmployeeFactory {
  makeEmployee(r: EmployeeRecord): Employee;
}

class EmployeeFactoryImpl implements EmployeeFactory {
  makeEmployee(r: EmployeeRecord): Employee {
    switch (r.type) {
      case COMMISSIONED:
        return new CommissionedEmplyee(r);
      case HOURLY:
        return new HourlyEmployee(r);
      case SALARIED:
        return new SalariedEmplyee(r);
      default:
        throw new InvalidEmployeeType(r.type);
    }
  }
}

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

함수가 작고 단순할수록 서술적인 이름을 고르기 쉬워집니다.이름이 길어도 괜찮습니다. 길고 서술적인 이름이 짧고 어려운 이름보터 좋습니다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋습니다. 함수 이름을 정할 떄는 여러 단어가 쉽게 읽히는 명명법을 사용합니다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택합니다. 서술적인 이름을 사용하면 개발자 머리속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워집니다.

이름을 붙일 때는 일관성이 있어야 합니다. 모듈 내에서 함수 이름을 같은 문구, 명사, 동사를 사용합니다. includeSetupAndThreadownPages, includeSetupPages, includeSuiteSeutpPage, includeSetupPage 등이 좋은 예입니다. 문제가 비슷하면 이야기를 순차적으로 풀어가기도 쉬워집니다. 방금 열거한 함수를 살펴보면, 당장 이런 질문이 떠오릅니다. includeTeardownPages, includeSuiteTeardownPage, includeTeardownPage도 있나요?

6. 함수 인수

함수에서 이상적인 인수개수는 0개(무항)입니다. 다음은 1개(단항)고, 다음은 2개(이항)입니다. 3개(삼항)는 가능한 피하는 편이 좋습니다. 4개 이상(다항)은 특별한 이유가 필요합니다. 특별한 이유가 있어도 사용하면 안됩니다.

6.1. 많이 쓰는 단항 형식

함수에서 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지입니다. 하나는 인수로 질문을 던지는 경우입니다. 다른 하나는 인수를 뭔가로 변환해 결과를 반환하는 경우입니다. 이들 두 경우는 독자가 당연하게 받아들입니다. 함수 이름을 지을 때는 두 경우를 분명히 구분합니다. 또한 언제나 일관적인 방식으로 두 형식을 사용합니다.

const exist: boolean = fs.existsSync("MyFile"); // 인수로 질문을 던지는 경우
const wstream: fs.WriteStream = fs.createWriteStream("MyFile"); // 인수를 변환하는 경우

변환 함수에서 출력 인수를 사용하면 혼란을 일으킵니다. 흔히 우리는 함수에다 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙합니다. 대개 함수에서 인수로 결과를 받으리라 기대하지 않습니다. 입력 인수를 변환하는 함수라면 변환 결과는 반환값으로 돌려줍니다. 입력 인수를 그대로 돌려주는 함수라 할지라도 변환 함수 형식을 따르는 편이 좋습니다. 적어도 변환 형태는 유지하기 때문입니다.

transfrom(object); // (X)
const transformedObject = transform(object); // (O)

6.2. 플래그 인수

함수로 부울 값을 넘기는 관례는 정말로 끔찍합니다. 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈입니다. 플래그가 참일 때와 거짓일 때 다른 일을 한다는 말입니다. 이는 두가지 함수로 나누어야 마땅합니다.

6.3. 이항 함수

인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵습니다. 물론 이항 함수가 적절한 경우도 있습니다. 인수 2개가 한 값을 표현하고, 두 요소에 자연적인 순서가 있는 경우입니다.

const point: Point = new Point(0, 0);

만약 두 인수의 자연적인 순서가 없다면, 이 순서를 인위적으로 기억해야하는 상황이 발생합니다. 하지만 이항 함수가 무조건 나쁘다는 소리는 아닙니다. 프로그램을 짜다 보면 불가피한 경우도 생깁니다. 하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 합니다.

// 개선의 여지가 있는 이항 함수 예시
const result = writeField(outputStream, name);

// 클래스의 구성원으로 만들어 개선
const result = outputStream.writeField(name);

// 새 클래스를 만들어 개선
const writeField = new WriteField(outputStream);
const result = writeStream.write(name);

6.4. 삼항 함수

인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어 봅니다. 예를 들어, 다음 두 함수를 살펴봅시다.

function makeCircle(x: number, y: number, radius: number): Circle;
function makeCircle(center: Point, radius: number): Circle;

객체를 생성해 인수를 줄이는 방법이 눈 속임이라 여겨질지 모르지만 그렇지 않습니다. 위 예제에서 x와 y를 묶었듯이 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 됩니다.

6.5. 인수 목록

때로는 인수 개수가 가변적인 함수도 필요합니다. 가변 인수를 취하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있습니다. 하지만 이를 넘어서는 인수를 사용할 경우에는 문제가 있습니다.

function monad(...args: number[]): void;
function dyad(name: string, ...args: number[]): void;
function triad(name: string, count: number, ...args: number[]): void;

6.6. 동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수입니다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 합니다. 예를 들어, write(name)은 누구나 곧바로 이해합니다. 이름(name)이 무엇이든 쓴다(write)는 뜻입니다. 좀 더 나은 이름은 writeField(name)입니다. 그러면 이름(name)이 필드(Field)라는 사실이 분명히 드러납니다.

마지막 예제는 함수 이름에 키워드를 추가하는 형식입니다. 즉, 함수 이름에 인수 이름을 넣습니다. 예를 들어, assertEquals보다 assertExpectedEqualsActual(expected, actual)이 더 좋습니다. 그러면 인수 순서를 기억할 핋요가 없어집니다.

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

부수 효과는 함수에서 한 가지를 하겠다고 약속하고 남몰래 다른 짓을 하는 것입니다. 많은 경우 시간적인 결합(Temporal Coupling)이나 순서 종속성(Order Dependency)을 초래합니다.

class UserValidator {
  private cryptographer: Cryptographer;

  public checkPassword(userName: string, password: string): boolean {
    const user: User = UserGateway.findByName(userName);
    if (user !== User.NULL) {
      const codedPhrase: string = user.getPhraseEncodedByPassword();
      const phrase: string = this.cryptographer.decrypt(codedPhrase, password);
      if (phrase === "Valid Password") {
        Session.initialize(); // 부수 효과!
        return true;
      }
    }
    return false;
  }
}

이런 부수 효과는 시간적인 결합을 초래합니다. 즉, checkPassword 함수는 특정 상황에서만 호출이 가능합니다. 다시 말해, 세션을 초기화해도 괜찮은 경우에만 호출이 가능합니다. 자칫 잘못 호출하면 의도하지 않게 세션 정보가 날아갑니다. 시간적인 결합은 혼란을 일으킵니다. 특히 부수 효과로 숨겨진 경우에는 더더욱 혼란이 커집니다. 만약 시간적이 결합이 필요하다면 checkPasswordAndInitializeSession와 같은 이름으로 분명히 명시합니다. 물론 함수가 한 가지만 한다는 규칙을 위반합니다.

7.1. 출력 인수

일반적으로 우리는 인수를 함수 입력으로 해석합니다. 어느 정도 프로그래밍 경력이 쌓였다면 인수를 출력으로 사용하는 함수에 어색함을 느낍니다.

appendFooter(report);

이 함수는 무언가에 report를 바닥글로 첨부할까요? 아니면 report에 바닥글을 첨부하는 것일까요? 함수 선언부를 찾아보면 분명해 집니다. 객체 지향 프로그래밍이 나오기 전에는 출력 인수가 불가피한 경우도 있었습니다. 하지만 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없습니다. 다시 말해 report가 출력 인수일 경우 appendFooter는 다음과 같이 호출하는 방식이 좋습니다.

report.appendFooter();

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

함수는 객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나입니다. 둘 다 하면 혼란을 초래합니다. 예를 들어, 다음 함수를 살펴봅시다.

function set(attribute: string, value: string): boolean;

이 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true를 반환하고 실패하면 false를 반환합니다. 그래서 다음과 같이 괴상한 코드가 나옵니다.

if (set("username", "ucclebob")) {
  // ...
}

함수를 구현한 개발자는 set을 동사로 의도했습니다. 하지만 if 문에 넣고 보면 형용사로 느껴집니다. 그래서 if 문은 "username 속성이 unclebob으로 설정되어 있다면 ..." 으로 읽힙니다. "username을 unclebob으로 설정하는데 성공하면 ..."으로 읽히지 않습니다. set이라는 함수 이름을 setAndCheckIfExist라고 바꾸는 방법도 있지만 if 문에 넣고 보면 여전히 어색합니다. 진짜 해결책은 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법입니다.

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

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

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

if (deletePage(page) === "E_OK") {
  // ...
}

위 코드는 동사/형용사 혼란을 일으키지 않는 대신 여러 단계로 중첩되는 코드를 야기합니다. 오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힙니다.

if (deletePage(page) === E_OK) {
  if (registry.deleteReference(page.name) === E_OK) {
    if (configKeys.deleteKey(page.name.makeKey()) === E_OK) {
      console.log("page deleted");
    } else {
      console.error("configKey not deleted");
    }
  } else {
    console.error("deleteReference from registry failed");
  }
} else {
  console.error("delete failed");
  return E_ERROR;
}

반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해집니다.

try {
  deletePage(page);
  registry.deleteReference(page.name);
  configKeys.deleteKey(page.name.makeKey());
} catch (e) {
  console.error(e);
}

9.1. Try/Catch 블록 뽑아내기

try/catch 블록은 원래 추합니다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞습니다. 그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋습니다. 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워집니다.

function deletePageAndAllReference(page: Page): void {
  deletePage(page);
  registry.deleteReference(page.name);
  configKeys.deleteKey(page.name.makeKey());
}

function logError(e: Error): void {
  console.error(e);
}

function deleteAll(page: Page): void {
  try {
    deletePageAndAllReference(page);
  } catch (e) {
    logError(e);
  }
}

9.2. 오류 처리도 한 가지 작업입니다.

함수는 한 가지 작업만 해야합니다. 오류 처리도 한 가지 작업에 속합니다. 그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅합니다. 함수에 키워드 try가 있담녀 함수는 try로 시작해 catch/finally 문으로 끝나야 한다는 말입니다.

10. 반복하지 마라

중복은 소프트웨어에서 모든 악의 근원입니다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔습니다. 예를 들어, E. F. 커드(E.F.codd)는 자료에서 중복을 제거할 목적으로 관계형 데이터베이스에 정규 형식을 만들었습니다. 객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앱니다. 구조적 프로그래밍, AOP(Aspect Oriented Programming), COP(Component Oriented Programming) 모두 어떤 면에서 중복 제거 전략입니다. 하위 루틴을 발명한 이래로 소프트웨어 개발에서 지금까지 일어난 혁신은 소스 코드에서 중복을 제거하려는 지속적인 노력으로 보입니다.

11. 구조적 프로그래밍

어떤 프로그래머는 에츠허르 데이크스트라(Edsger Dijkstra)의 구조적 프로그래밍 원칙을 따릅니다. 데이트스트라는 모든 함수와 함수 내 모든 블록에 입구(Entry)와 출구(Exit)가 하나만 존재해야 한다고 말했습니다. 즉, 함수는 return 문이 하나여야 한다는 말입니다. 루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로 안 됩니다.

구조적 프로그래밍의 목표와 규칙을 공감하지만 함수가 작다면 위 규칙을 별 이익을 제공하지 못합니다. 함수가 아주 클 때만 상당한 이익을 제공합니다. 그러므로 함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮습니다. 오히려 때로는 단일 입/출구 규칙(Single Entry-Exit Rule)보다 의도를 표현하기 쉬워집니다.

12. 함수를 어떻게 짜죠?

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

처음에는 길고 복잡합니다. 들여쓰기 단계도 많고 중복된 루프도 많습니다. 인수 목록도 아주 깁니다. 이름은 즉흥적이고 코드는 중복됩니다. 그 서투른 코드르 빠짐없이 테스트하는 단위 테스트 케이스도 만듭니다.

그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거합니다. 메서드를 줄이고 순서를 바꿉니다. 때로는 전체 클래스를 쪼개기도 합니다. 이 와중에도 코드는 항상 단위 테스트를 통과합니다.

13. 결론

모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한 도메인 특화 언어(Domain Specific Language, DSL)로 만들어집니다. 함수는 그 언어에서 동사며, 클래스는 명사입니다. 대가(Master) 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이야기로 여깁니다. 여러분이 작성한는 함수가 분명하고 정확한 언어로 깔끔하게 맞아 떨어져야 이갸기를 풀어가기 쉬어진다는 사실을 기억하기 바랍니다.

14. 출처

  • 제목: 클린 코드 - 애자일 소프트웨어 장인 정신
  • 저자: 로버트 C.마틴
  • 옮긴이: 박재호, 이해영
  • 출판사: 인사이트
profile
Hant
끊임없이 도전하는 프론트 개발자가 되고자 노력합니다.
이전 포스트

의미있는 이름

다음 포스트

좋은 주석과 나쁜 주석

0개의 댓글