의도를 분명히 표현하는 함수를 어떻게 구현할 수 있을까?
함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까?
작게 만들어라!
함수가 얼마나 짧아야 할까???
이것보다는 짧아야 한다. 사실 밑에 처럼 더 줄 일 수도 있다.
다시 말해 if문/ else 문/ while 문 등에 들어가는 블록은 한 줄 이어야 한다는 의미다. 이 말은 중첩구조가 생길만큼 함수가 커져서는 안된다는 뜻이다.
그러므로 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다.
한가지만 해라!
함수는 한가지를 해야 한다. 그 한가지를 잘 해야 한다. 한가지만을 해야 한다.
위의 예제 코드 3-3은 한가지를 하는가? 세가지를 한다고 주장할 수도 있다.
- 페이지가 테스트 페이지인지 확인한다.
- 그렇다면 설정페이지와 해제페이지를 넣는다.
- 페이지를 HTML로 렌더링 한다.
위에서 언급하는 세 단계는 지정된 함수 이름 아래에서 추상화 수준이 하나다.
추상화 수준
{A,B,C}라는 기능을 하는 큰 개념을 분해하여 A,B,C 라는 기능을 만들었다. 그리고 나눠진 3가지의 기능을 단계 별로 수행하는 {}를 만들고 연결시켜 줬다. 결국 A,B,C가 하나의 추상화 수준이 되는 것이다. ({} => A,B,C)
함수가 한가지만 하는지 판단하는 방법이 하나 더 있다. 단순히 다른 표현이 아니라
의미있는 이름으로 다른 함수를 추출 할 수 있다면 그 함수는 여러 작업을 하는 셈이다.
함수 당 추상화 수준은 하나로!
getHtml() 은 추상화 수준이 아주 높다.
반면 String pagePathName = PathParser.render(pagepath); 는 추상화 수준이 중간이다.
그리고 .append("\n") 와 같은 코드는 추상화 수준이 아주 낮다.
한 함수 내에서 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.
특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다.
위에서 아래로 코드 읽기: 내려가기 규칙!
한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 즉 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한번에 한 단계씩 낮아진다. 이것을 내려가기 규칙이라 부른다.
서술적인 이름을 사용하라!
한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 달성함에 있어 이미 절반은 성공했다. 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.
이름이 길어도 괜찮다. 겁먹을 필요없다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다. 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다
함수 인수
함수에서 이상적인 인수 개수는 0개다. 다음은 1개고, 다음은 2개다. 3개는 가능한 피하는 편이 좋다. 4개 이상은 특별한 이유가 필요하다.
- 많이 쓰는 단항혁식
- 인수에 질문을 던지는 경우 ex) fileExists("MyFile")
- 인수를 뭔가로 변환해 결과를 반환하는 경우다.
-
플래그 인수
플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말 끔찍하다.
why??? 함수가 한꺼번에 여러가지를 처리한다고 대놓고 공표하는 셈이다.
플래그가 참이면 이걸하고 거짓이면 저걸 한다는 의미이다. -
이항 함수
이항 함수가 무조건 나쁘다는 소리는 아니다. 프로그램을 짜다보면 불가피한
경우도 생긴다. 하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항함수로
바꾸도록 애써야 한다.
부수 효과를 일으키지 마라!
부수효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까.
여기서 함수가 일으키는 부수효과는 Session.initialize() 호출 이다.
checkPassword 함수는 이름 그대로 암호만 확인을 해야 한다.
명령과 조회를 분리하라
함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘 다 하면 안된다. 객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.
ex)
if (set("username", "unclebob"))...
=> "username" 이 "unclebob"으로 설정되어 있는지 확인하는 코드인가?
함수를 구현한 개발자는 set을 동사로 의도했다. 하지만 if 문에 넣고 보면 형용사로 느껴진다.
진짜 해결책은 명령과 조회를 분리해 혼란을 뿌리뽑자.
if (attributeExists("username")) {
setAttribute("username", "unclebob");
...
}
오류코드보다 예외를 사용하라.
위의 오류 코드 보다는 예외를 사용하자.
반복하지 마라!!
중복은 문제다. 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 다 손봐야 한다.
출처
코드 사진 : Clean Code Pdf 전자책
함수 추상화 개념 : https://sosimhan-dev.tistory.com/4
