본문 바로가기

공부/노개북

[노개북] '클린 코드' Assignment #05

📌 1 주차
화, 수 | Assignment #5
- 📖 3장. 함수
- 📝 TIL

💡 TIL (Today I Learned)

2022.02.22.화 ~ 2022.02.23.수

📖 오늘 읽은 범위

3장. 함수

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

  • 작게 만들어라! : 함수를 만드는 첫째 규칙은 '작게!'다. 각 함수가 명백하게 하나의 이야기를 표현해야한다. - p.42
  • 블록과 들여쓰기 : if문/else문/while문 등에서 대게 함수를 호출함으로 들어가는 블록은 한줄이어햐 한다.(블록 안에서 호출하는 함수 이름을 적절히 짓는 것을 잊지 말기!) 함수에서 들여쓰기는 1단이나 2단을 넘어서면 안 된다. - p.43
  • 한 가지만 해라! : 함수는 한 가지를 해야한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야한다. 한 가지 = 추상화 수준이 하나인 단계만 수행하는 함수 - p.44
  • 함수 내 섹션 : 섹션으로 나눠진다는 것은 한 함수에서 여러 작업을 한다는 증거다. - p.45
  • 함수 당 추상화 수준은 하나로! : 수가 확실한 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야한다. 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈리며 근본 개념과 세부사항을 섞으면 깨어진 창문처럼 함수에 세부사항이 점점 더 추가된다. - p.46
  • 위에서 아래로 코드 읽기(내려가기 규칙) : 코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. 이것이 내려가기 규칙이다. - p.46
  • Swith문 : 불행히도 swith문을 완저히 피할 방법은 없다. 해결할 수 있는 방법은 swith문을 추상 팩토리에 꽁꽁 숨긴다. 팩토리는 swith문을 사용해 적절한 파생 클래스의 인스터스를 생성한다. 상속 관계로 숨긴 후에는 다른 코드에 노출하지 않는다. - p.47
  • 서술적인 이름을 사용하라! : 함수가 하는 일을 좀 더 잘 표현하는 이름이 좋은 이름이다. 함수가 작고 단순할수록 서술적인 이름을 고르기 쉬워진다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋으며, 이름을 정하느라 시간을 들여도 괜찮다! 이런저럼 이름을 넣어서 코드를 읽어보는게 좋다. 일관성이 있도록 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다. - p.49
  • 함수 인수 : 함수에서 이상적인 인수 개수는 0개(무항)이다. 함수 이름과 인수 사이의 추상화 수준이 다르므로 인수는 개념을 이해하기 어렵게 만든다. 출력 인수는 허둥지둥 코드를 재차 확인하게 만듬으로 이해하기 어렵다. 최선은 0개, 차선은 1개 - p.50
  • 많이 쓰는 단항 형식 : 1개를 넘기는 이유는 인수에 질문을 던지는 경우(ex. 참인지 아닌지), 인수를 뭔가로 반환해 결과를 반환하는 경우다. - p.51
  • 플래그 인수 : 함수로 부울 값을 넘기는 것은 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이다. - p.52
  • 이항 함수 : 2개인 함수는 1개인 함수보다 이해하기 어렵다. 이항 함수가 무조건 나쁘지는 않지만, 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다. p.52
  • 동사 키워드 : 함수의 의도나 인수의 순서와 의도를 표현하기 위해 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. 또 함수 이름에 키워드를 추가하는 형식은 인수 순서를 기억할 필요가 없어지게 만든다. - p.54
  • 부수 효과를 일으키지 마라! : 함수에서 한 가지를 하겠다고 하지만 예상치 못하게 클래스 변수를 지정, 함수로 넘어온 인수나 시스템 전역 변수를 수정하는 것은 시간적인 결합이나 순서 종속성을 초래한다. - p.54
  • 출력 인수 : 출력 인수라는 사실을 함수 선언부에서 알게 되는 것은 코드를 보다가 주춤하는 행위와 같다. 출력 인수를 피하며, 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택하여야 한다. - p.56
  • 명령과 조회를 분리하라! : 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. - p.56 
  • 오류 코드보다 예외를 사용하라! : if문으로 처리하는 경우에는 여러 단계로 중첩되는 코드를 야기하게 된다. 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리됨으로 코드가 깔끔해진다. - p.57
  • Try/Catch 블록 뽑아내기 : Try/Catch 블록은 코드 구조에 혼란을 일으키고 정상 동작과 오류 처리 동작을 섞음으로 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다. - p.58
  • 오류 처리도 한 가지 작업이다. : 오류 처리도 '한 가지' 작업에 속한다. 그러므로 오류를 처리하는 함수는 오류만 처리해야 한다. - p.59
  • Error.java 의존성 자석 : 오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생됨으로 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다.- p.60
  • 반복하지 마라! : 알고리즘이 반복되면서 다른 코드와 섞인다면 코드 길이도 늘어나지만 알고르짐이 변하게 되면 손봐야 할 곳도 많아진다. 이에 따라 한곳이라도 빠트리면 오류가 발생할 확률도 그에 비례하여 배로 늘어난다. - p.60
  • 구조적 프로그래밍 : 에츠허르 테이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다. 즉, 함수의 return문은 하나여야 한다. 이는 함수가 아주 클 때만 이익을 제공하며, 작게 만든다면 return, break, continue를 여러 차례 사용해도 괜찮다. - p.61
  • 함수를 어떻게 짜죠? : 소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다. 초안은 대게 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다. 코드를 다듬고 -> 함수를 만들고 -> 이름을 바꾸고 -> 중복을 제거 -> 메서드를 줄이고 -> 순서를 바꾸고 -> 클래스를 쪼갠다. 처음부터 탁 짜내지지 않는다. 그게 가능한 사람은 없으리라. - p.61
  • 결론 : 시스템은 풀어갈 이야기며, 함수는 그 언어에서 동사며, 클래스는 명사다. 여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라. 하지만 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하기 바란다. - p.62

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

  • 이틀에 나누어서 읽을 정도로 많고 중요한 내용들이었다. 책을 읽으면서의 회사 생활이 서서히 달라지고 있다는게 보인다. 함수에 모든 것을 다 때려넣어서 한번에 되는 것을 목표로 했던 지난 날의 시간을 되돌아 보게 되었다.
  • 어쩜 이렇게도 이 책의 내용과 정말 반대대로 살아오고 있던 내가 대단하다...🤣 정확하게 모든 일들을 반대로 하고 있었다. 아직은 배우는 시점으로 더 고착되기 전에 바꿀 수 있음에 감사하다!
  • 한 가지의 일을 하는 함수부터 차근 차근 바꿔나갈 생각이다🛠 

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

  • Java code : 
throws Exception : 메소드에서 처리하지않은 모든 예외를 호출한 곳으로 떠넘기기
String Buffer : String 클래스의 인스턴스는 한번 생성되면 변경이 안되지만, Buffer는 값이 변경 가능하고 추가도 가능함
  • Swith문 : If문과 같은 조건문이나 변수의 값에 따라 실행됨