Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL 3장. 함수
#clean_code
2년 전
342


TIL (Today I Learned)

2022.02.22 ~ 2022.02.23

오늘 읽은 범위

3장. 함수

책에서 기억하고 싶은 내용을 써보세요.

  • 어떤 프로그램이든 가장 기본적인 단위가 함수다

  • 읽기 쉽고 이해하기 쉬운, 의도를 분명히 표현하는, 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있는 함수 만드는 규칙

    1. 작게 만들어라!
      블록과 들여쓰기 - if 문/else 문/while 문 등에 들어가는 블록은 한 줄이여햐 한다.
      위의 블록 안에서 함수를 호출한다.
      중첩 구조가 생길만큼 함수가 커져서는 안 된다.
      함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.

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

    3. 함수 당 추상화 수준은 하나로!
      함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
      한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다.
      근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 추가한다.
      위에서 아래로 코드 읽기: 내려가기 규칙
      - 코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다.

    4. Switch 문


      본질적으로 switch 문(if/else 가 여럿 이어지는 구문) N가지를 처리한다.
      => 각 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다. 다형성을 이용
      ex) switch 문을 추상 팩토리에 숨기고 팩토리는 switch 문을 사용해 적절한 실제 파생 클래 스의 인스턴스를 생성한다.

    5. 서술적인 이름을 사용하라!
      "코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다"
      한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 달성함에 있어 이미 절반은 성공했다. 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.
      길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
      함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.
      서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.

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


      테스트 관점에서 보면 인수는 더 어렵다. 갖가지 인수 조합으로 함수를 검증하는 테스트 케이스를작성한다고 상상해보라! 인수가 없다면 간단하다.
      출력 인수는 입력 인수보다 이해하기 어렵다. 흔히 우리는 함수에다 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙하다.
      많이 쓰는 단항 형식
      - 1) 인수에 질문을 던지는 경우
      2) 인수를 뭔가로 변환해 결과를 반환하는 경우
      플래그 인수
      -함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 함수가 한꺼번에 여러 가지를 처리한다고 대 놓고 공표하는 셈이니까! 플래그가 참이면 이걸 하고 거짓이면 저걸 한다는 말이니까!
      이항 함수
      - 이항 함수가 무조건 나쁘다는 소리는 아니다. 프로그램을 짜다보면 불가피한 경우도 생긴다. 하 지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다.
      삼항 함수
      - 인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다.
      인수 객체
      - 인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.
      인수 목록
      - 떄로는 인수 개수가 가변적인 함수도 필요하다. String.format 메서드가 좋은예
      public String format(String format, Object... args)
      동사와 키워드
      - 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
      함수 이름에 키워드를 추가하는 형식이다. 함수 이름에 인수 이름을 넣는다.
      ex) assertEqual 보다 assertExpectedEqualsActual(expected, actual) 이 더 좋다.
      인수 순서를 기억할 필요가 없어진다.

    7. 부수 효과를 일으키지 마라!
      많은 경우 시간적인 결합이나 순서 종속성을 초래한다.
      출력 인수
      - 일반적으로 우리는 인수를 함수 입력으로 해석한다.
      객체 지향 프로그래밍이 나오기 전에는 출력 인수가 불가피한 경우도 있었다. 하지만 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다. 출력 인수로 사용하라고 설계한 변수가 바로 this 이기 때문이다.
      출력 인수를 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

    8. 명령과 조회를 분리하라!
      함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다.
      객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.

    9. 오류 코드보다 예외를 사용하라!
      명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 if 문에서 명령을 표현식으로 사용하기 쉬운 탓이다.
      오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.
      Try/Catch 블록 뽑아내기
      - try/catch 블록은 코드 구조에 혼란을 일으키며, 정상 동작과 오류처리 동작을 뒤섞는다.
      try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.
      정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.
      오류 처리도 한 가지 작업이다.
      - 함수는 '한 가지' 작업만 해야 한다. 오류 처리도 '한 가지' 작업에 속한다.
      함수에 키워드 try가 있다면 함수는 try 문으로 시작해 catch/finally 문으로 끝나야 한다는 말 이다.
      Error.java 의존성 자석
      - 오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.
      오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다.

    10. 반복하지 마라!
      중복은 문제다. 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 변경된 곳 모두를 손봐야 하니까.
      중복은 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.

    11. 구조적 프로그래밍
      모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다.
      함수는 return 문이 하나여야 한다는 말이다. 루프 안에서 break나 continue를 사용하선 안 되며, goto는 절대로 절대로 안 된다. => 함수가 아주 클 때만 상당한 이익을 제공
      함수를 작게 만든다면 간혹 return, break, continue 를 여러 차례 사용해도 괜찮다.

    12. 함수를 어떻게 짜죠?
      서투른 코드를 빠짐없이 테스트 하는 단위 테스트 케이스를 만들고 서투른 코드를 다듬어 가면서 항상 단위 테스트를 통과할 수 있도록.

  • 모든 시스템은 특정 응용 분야 시스템을 기술하 목적으로 프로그래머가 설계한 도메인 특화 언어로 만들어진다. 함수는 그 언어에서 동사며, 클래스는 명사다.

  • master프로그래머는 시스템을 구현할 프로그램이 아니라 풀어갈 이야기로 여긴다.
    프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다. 시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 바로 그 언어에 속한다.


오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

  • 내가 그 동안 작성해온 코드들이 생각났다. 그 중에는 오늘 배운 함수를 잘 만드는 규칙을 따르며 작성한 코드도 있었지만, 작성한 나 이외에 다른 사람이 보았을 때 장황하고 쉽게 이해하기 어려운 코드들도 있다. 결국 이러한 코드들이 모여서 똥덩어리 코드집합이 되는것이라 생각하니 당장에 작업중이던 코드부터 뜯어 고쳐놔야겠다는 생각이 들었다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

  • 출력 인수를 사용하는 사례와 예제를 좀 더 찾아서 어떠한 형태가 출력 인수를 사용하는 경우인지를 직관적으로 확인할 수 있도록 하자.

  • 단일 입/출구 규칙(single entry-exit rule)