클린코드 챌린지 #3

오늘 읽은 범위

3장.함수

책에서 기억하고 싶은 내용

1. 작게 만들어라
   • 함수를 만드는 첫번째 규칙은 '작게!'다. 함수를 만드는 둘째 규칙은 '더 작게!'다.
   • 블록과 들여쓰기 다시말해, if문/else문/while문 등에 들어가는 블록은 한 줄이어야 한다는 의미다. ... 이말은 중첩 구조가 생길만큼 함수가 커져서는 안 된다는 뜻이다. 그러므로 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다. 당연한 말이지만, 그래야 함수는 읽고 이해하기 쉬워진다.
2. 한 가지만 해라!
   • 함수는 한 가지를 해야 한다. 그 한가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
   • 지정된 함수 이름 아래서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한가지 작업만 한다.
   • 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러작업을 하는 셈이다.
3. 함수 당 추상화 수준은 하나로!
   • 함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야한다.
   • 코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. => 내려가기 규칙
   • 위에서 아래로 TO문단을 ㅇ릭어내려 가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기 쉬워진다.
4. Switch문
   • 각 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법 => 다형성을 이용한다.
5. 서술적인 이름을 사용하라!
   • 이름이 길어도 괜찮다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
   • 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.
   • 이름을 붙일 때는 일관성이 있어야한다. 모듈 내에서 함수 이름은 같은 문구,명사,동사를 사용한다.
6. 함수 인수
   • 인수가 3개 넘어가면 인수마다 유효한 값으로 모든 조합을 구성해 테스트하기가 상당히 부담스러워진다.
   • 최선은 입력 인수가 없는 경우이며, 차선은 입력 인수가 1개뿐인 경우다.
   • 많이 쓰는 단항 형식
     함수에 인수 1개를 넘기는 이유로 가장 흔한 경우
     1) 인수에 질문을 던지는 경우 : boolean fileExists("MyFile")
     2) 인수를 무너가로 변환해 결과를 반환하는 경우 : InputStream fileOpen("MyFile")
     3) 이벤트 함수
   • 플래그 인수 : 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이다.
   • 이항 함수 : 좌표 객체 만들때 유용하고 최대한 단항 함수로 바꾸도록 해야한다.
   • 삼항 함수 : 인수가 3개라 이해가 힘들다.
   • 인수 객체 : 인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 수도 있다.
   • 인수 목록 : 때로는 인수 개수가 가변적인 함수도 필요하다.
   • 동사와 키워드 : 함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야한다.
     ex) write(name) => writeField(name)
     assertEqualse => assertExpectedEqualsActual(expected, actual)
7. 부수 효과를 일으키지 마라!
   • 함수에서 한가지만 해야지 클래스 변수를 수정한다거나 함수로 넘어온 인수나 시스템 전역 변수를 수정하는 추가적인 작업은 안좋다. => 시간적인 결합, 순서 종속성 초래
   • 출력 인수 : 최대한 피해라. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
8. 명령과 조회를 분리하라!
   • 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야한다. 둘 다 하면 혼란을 초래한다. 명령과 조회를 분리하여 함수를 구성해라.
9. 오류 코드보다 예외를 사용하라!
   * 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.
   • Try/Catch 블록 뽑아내기
     - try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.
     - 정상 동작과 오류 처리 동작ㅇ르 분리하면 코드를 이해하고 수정하기 쉬워진다.
   • 오류 처리도 한 가지 작업이다.
     - 오류를 처리하는 함수는 오류만 처리해야 마땅하다.
   • Error.java 의존성 자석 : 오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다. 따라서 재컴파일/재배치 없이도 새 예외 클래스를 추가 할 수 있다.
10. 반복하지 마라!
    • 중복은 문제다. 코드 길이 증가 및 오류 발생 확률도 높아진다.
    • 구조적 프로그래밍, AOP, COP 모두 어떤면에서 중복 제거 전략이다.
11. 구조적 프로그래밍
    • 데이크스트 : 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야한다. -> 함수는 return 문이 하나여야 한다.(함수가 클때만 유용)
12. 함수를 어떻게 짜죠?
    • 소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다.
    • 코드가 길어질 수도 있고 그안에서 쪼개기도하고 테스트도 하고 한다. 규칙을 넣기도 하면서 만들어진다. -> 한번에 탁나오는 코드는 없다.
13. 결론
    • 프로그래밍의 기술은 언제나 언어 설계의 기술이다.
    • 대가 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이야기로 여긴다. 프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.
    • 시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 언어에 속한다.

오늘 읽은 소감

이번 챕터를 통해서 가독성도 좋고 효율적으로 함수를 만드는 방법을 익힐 수 있어 좋았다. 개발하다 보면 함수가 길어지고 테스트를 진행할 때도 오류가 발생하면 찾기 바빴는데 그 원인이 함수를 최대한 쪼개고 하나의 역할씩만 하게 해서 사용하지 않아서 그런 것임을 알게되었다. 이번 챕터를 읽으면서 저자가 강력하게 하지말라고 하는 부분들을 내가 하고 있어서 뜨끔했고 어서 지금 진행중인 프로젝트의 코드를 수정해야겠다고 생각했다. 결론에서 저자가 대가 프로그래머는 시스템을 풀어갈 이야기로 생각한다고 했다. 나는 시스템을 구현할 프로그램으로 바라보았기 때문에 언어를 활용하지 못하고 그지같이 짰던 것 같아서 반성했다. 이번에 함수를 어떻게 짜면 좋은지 규칙들을 알게되었으니 잘 지켜나가면서 시스템이라는 하나의 이야기를 잘 풀어나가는 프로그래머가 되야겠다.