[클린 코드 (Clean Code)] Ch3. 함수

Ch3. 함수

작게 만들어라

• 함수를 만드는 첫째 규칙은 '작게!'

• 함수를 만드는 둘째 규칙은 '더 작게!'

• 얼마나 짧아야 하는가?

  • 일반적으로 아래 예시 정도로 짧게 작성해야한다!

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

  • 블록과 들여쓰기

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

한 가지만 해라

• 함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
  • 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 하는 것
  • 또는, 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 것

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

• 함수 내 모든 문장의 추상화 수준이 동일 해야 함
• 위에서 아래로 코드 읽기 : 내려가기 규칙
  • 코드는 위에서 아래로 이야기처럼 읽혀야 좋다!
  • 매우 어렵지만 매우 중요한 규칙

서술적인 이름을 사용하라

• 짧은 이름이 마냥 좋은 것은 아니다.
• 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워짐
  • 길고 서술적인 이름 >>> 짧고 어려운 이름
  • 길고 서술적인 이름 >>> 길고 서술적인 주석
    • 뒤의 챕터에 나오지만, 주석은 없으면 없을수록 좋은 코드이다
• 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법 사용
  • 여러 단어를 사용해 함수 기능을 잘 표현하는 이름 선택
• 이름을 붙일 때는 일관성이 있어야 함
  • 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용
    • e.g.
      • includeSetupAndTeardownPages
      • includeSetupPages
      • includeSuiteSetupPage
      • includeSetupPage

함수 인수

• 함수에서 이상적인 인수 개수는 0개다.

  • 그리고 1개, 2개, 3개 이상은 피하는 편이 좋다.

• 많이 쓰는 단항 형식

  • 함수에 인수 1개를 넘기는 흔한 두 가지 이유
    • 인수에 질문을 던지는 경우
      • e.g. boolean fileExists("MyFile")
    • 인수를 뭔가로 변환해 결과를 반환하는 경우
      • e.g. InputStream fileOpen("MyFile")

• 플래그 인수

  • 플래그 인수는 추하다...
  • 함수로 부울 값을 넘기는 것은 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 얘기하는 셈

• 인수 객체

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

    • e.g.

        Circle makeCircle(double x, double y, double radius);
        Circle makeCircle(Point center, double radius);

      • x와 y를 묶어서 넘기기 때문에 결국 어떤 개념을 표현해내는 것

• 동사와 키워드

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

부수 효과를 일으키지 마라

• 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓을 하지 말자

명령과 조회를 분리하라

• 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야함

  • 객체 상태를 변경하거나

  • 객체 정보를 반환하거나

  • e.g.

      if (set("username", "unclebob")) ...

    • "username"이 "unclebob"으로 설정되어있는지 확인하는 코드?

    • "username"을 "unclebob"으로 설정하는 코드?

      → 해결책 : 명령과 조회를 분리해 혼란을 애초에 없애는 것

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

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

• if else를 이용한 오류 코드 대신 예외 처리를 사용하면 오류 처리 코드가 원래 코드에서 분리되어 코드가 깔끔해짐

    public void delete(Page page){
        try{
            deletePage(page);
            registry.deleteReference(page.name);
            configKeys.deleteKey(page.name.makeKey());
        }
        catch (Exception e){
            logger.log(e.getMessage());
        }
    }

  • 위의 함수 마저도 정리를 해보면

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

  • 오류처리도 한 가지 작업으로 볼 수 있기 때문에, 오류를 처리하는 함수는 오류만 처리해야한다!

  • 이처럼 최대한 기능을 분리하고, 이해하기 쉽게 함수명을 짠다.

반복하지 마라

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

함수를 어떻게 짜죠?

• 처음에는 길고 복잡하지만
• 코드를 다듬고
• 함수를 만들고
• 이름을 바꾸고
• 중복을 제거하고
• 메서드를 줄이고
• 순서를 바꾸고
• 때로는 전체 클래스를 쪼개기도 한다
• 하지만 이 와중에 코드는 단위 테스트를 통과해야한다.

결론

• 함수는 그 언어에서 동사며, 클래스는 명사다.