[Clean Code] 3. 함수

 

👩‍💻 2장. 의미있는 이름 보고, 현재 진행 중인 프로젝트에 대해서 적용하려고 보는데..와.. 나름 변수명이나 메서드명 지을 때 생각하고 지었다고 생각했었는데 개판이다 ㅋㅋ 어디서부터 어떻게 고쳐야할지.. ^^;; 

조금씩 고쳐가자..! 라는 마인드로 봐야지.. 그리고 앞으로는 꼭 더!!! 생각하고 이름 지을 것이다.. 아 완전 후회중 ㅜ 

1. 변수(메서드 또는 클래스) 의 존재 이유는 ? 
2. 수행 기능은 ? 
3. 사용 방법은 ? 

최소한 이 3가지 질문은 하고 이름 짓기 ..!!!  이 글을 보는 분(?) 들은 이렇게 하고 계신가요..? 

아무튼.. 의미 있는 이름 짓기를 기억하며 3장 함수에 대해서 오늘은 공부할 것이다. 

 

 

 

작게 만들어라 p.42 

함수를 만드는 첫째 규칙은 '작게!' 다. 그리고 둘째 규칙은 '더 작게!'다. 


블록과 들여쓰기 
if/else문, while문 등에 들어가는 블록은 한 줄이어야 한다는 의미고 대개 거기서 함수를 호출한다. 
그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면 코드를 이해하기도 쉬워진다. 

함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다. 당연한 말이지만 그래야 함수는 읽고 이해하기 쉬워진다. 

👩‍💻 음.. 이거 가능한가 ..? 싶다... 정말 다 함수로 만들어야 가능한 일인데..!!! 이게 맞는건가??? 일단 더 읽어봐야겠다.. 

책에서 나온 예제를 보면 확실히 코드가 짧으니까 이해는 잘 되긴 하는데.. 

 

 

 

한 가지만 해라 ! p.44

 

함수는 한 가지를 해야 한다. 그 한가지를 잘 해야 한다. 그 한 가지만을 해야 한다. 

지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다. 

함수가 '한 가지'만 하는지 판단하는 방법이 하나 있는데, 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다. 

한 가지 작업만 하는 함수는 자연스럽게 세션을 나누기 어렵다. 

 

 

 

함수 당 추상화 수준은 하나로 ! p.45

함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야한다. 
getHtml() 은 추상화 수준이 높다.
String pagePathName = PathParser.render(pagepath); 는 추상화 수준이 중간이다. 
그리고 .append("\n") 와 같은 코드는 추상화 수준이 아주 낮다. 
한 함수 내에 이렇게 추상화 수준이 섞여 있으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지 아니면 세부 사항인지 구분하기 어려운 탓이다. 

내려가기 규칙 
한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. 

👩‍💻 함수가 한 가지 기능만 해야 한다.. 무슨 말을 하고 싶은지 알겠는데... 추상화 수준을 동일 시 하는건 너무 어려운 것 같다... 이걸 어떻게 한 수준으로만 유지하지..? 많은 고민이 필요할 것 같다.. 예시가 필요해 😂

 

 

 

 

서술적인 이름을 사용하라! p.49

좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않다. 
"코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라고 불러도 되겠다."  한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 달성함에 있어 이미 절반은 성공했다. 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다. 

이름이 길어도 괜찮다. 겁먹을 필요없다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다. 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 
그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다. 

서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다. 

이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다. 

👩‍💻 : 어제 의미있는 이름으로 변경하겠다고 메서드명도 좀 보는데 이름이 점점 길어져서 결국 포기했던 메서드명들이 몇개 있다.. 이거 그냥 한 번 읽고 이해하기 쉽도록 변경해야 겠다. 

 

 

 

함수 인수 p.50

함수에서 이상적인 인수 개수는 0개 (무항) 이다. 다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)은 가능한 피하는 편이 좋다!!! 
코드를 읽는 사람에게는 inlcudeSetupPageInfo(new PageContent) 보다 includeSetupPage()가 이해하기 더 쉽다. 

테스트 관점에서 보면 인수는 더 어렵다. 갖가지 인수 조합으로 함수를 검증하는 테스트 케이스를 작성한다고 상상해보라! 인수가 없다면 간단하다. 인수가 하나라도 괜찮다. 인수가 2개면 조금 복잡해진다. 

최선은 입력 인수가 없는 경우이며, 차선은 입력 인수가 1개뿐인 경우다. 

많이 쓰는 단항 형식 
함수에 인수 1개를 넘기는 이유는 가장 흔한 경우는 두 가지다. 하나는 인수에 질문을 던지는 경우, boolean fileExists("MyFile") 이 좋은 예다. 다른 하나는 인수를 뭔가로 변환해 결과를 반환하는 경우다. 
InputStream fileOpen("MyFile") 은 String 형의 파일 이름을 InputStream 으로 변환한다. 이들 두 경우는 독자가 당연하게 받아들인다. 함수 이름을 지을 때는 두 경우를 분명히 구분해야 한다. 

그리고 다소 드물게 사용하지만 단항 함수 형식으로 이벤트가 있다. 이벤트 함수는 입력 인수만 있고 출력 인수는 없다. 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다. passwordAttempFailedNtimes(int attemps) 가 좋은 예다. 이벤트 함수는 조심해서 사용하고, 이벤트라는 사실이 코드에 명확히 드러나야 한다. 

플래그 인수
플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 왜냐고? 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이기 때문이다. 플래그 참이면 이걸하고 거짓이면 저걸 한다는 말이니까 ! 

이항 함수 
인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다. writeField(name)과 writeField(outputStream, name) 둘 다 쉽게 읽히기는 하지만 전자가 더 쉽게 읽히고 더 빨리 이해가 된다. 

물론 이항 함수가 더 적절한 경우도 있다. Point p = new Point(0,0); 이 좋은 예이다. 

이항 함수가 무조건 나쁘다는 소리는 아니다. 프로그램을 짜다보면 불가피한 경우도 생긴다. 하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다. 예를 들어 writeField 메서드를 outputStream 클래스 구성원으로 만들어 OutputStream.wirteFiled(name)으로 호출한다. 아니면 outputStream을 현재 클래스 구성원 변수로 만들어 인수로 넘기지 않는다. 아니면 FieldWriter라는 새 클래스를 만들어 구성자에서 outputStream을 받고 write 메서드를 구현한다. 


삼항 함수 
인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 순서, 주춤, 무시로 야기되는 문제가 두 배 이상 늘어난다. 그래서 삼항 함수를 만들 때는 신중히 고려하라 권고한다. 

인수 객체 
인수가 2~3개 필요하다면 일부로 독자적인 클래스 변수로 선언할 가능성을 짚어본다. 
Circle makeCircle(double x, double y, double radius); 
-> Circle makeCircle(Point center, double radius); 

동사와 키워드 
함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 
단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. 예를 들어 writeField(name)는 name이 Field라는 사실이 분명히 드러난다. 

마지막 예제는 함수 이름에 키워드를 추가하는 형식이다. 즉, 함수 이름에 인수 이름을 넣는 것이다. 예를 들어 assertEquals보다 assertExpectedEqualsAcutal(expected, actual)이 더 좋다. 그렇다면 인수 순서를 기억할 필요가 없어진다. 

👩‍💻 예전에 다른 분이 매개변수 너무 많이 만들지말라고 하는 걸 들은 적이 있는데 이 내용을 보고 바로 떠올랐다...! 

그래서 요즘은 최대한 줄여서 사용하고 있는데 인수가 0개 ?!! 이거 어떻게 해야 하나..! 불가피하다면 1개라니.... 

스프링에서 이거 가능한가요... ? 궁금하다... 이런 예시를 한번도 못봐서... 아무튼... 줄일 수 있다면 줄여보기로 하고,,, 당장 플래그 함수는 없애도록 하자. 

 

 

 

부수 효과를 일으키지 마라! p.54

부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까. 때로는 예상치 못하게 클래스 변수를 수정한다. 때로는 함수로 넘어온 인수나 시스템 전역 변수를 수정한다. 어느쪽이든 교활하고 해로운 거짓말이다. 

 

 

 

명령과 조회를 분리하라 ! p.56

함수는 뭔가를 수행하거나 뭔가에 답을 하거나 둘 중 하나만 해야 한다. 둘 다 하면 안된다. 
객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다. 둘다 하면 혼란을 준다. 

public boolean set(String attribute, String value); 
-> 이 함수는 이름이 attribute인 속성 값을 찾아 value로 값을 설정한 후 성공하면 true를 반환하고 실패하면 false로 반환한다. 
if (set ("username", "unclebbb"))  .. 
-> 독자 입장에서 이 코드를 보면 "username"이 "unclebbb"로 설정되어 있는지 확인하는 코드인지 아니면 "username"을 "uncelbbb"로 설정하는 코드인지 의미가 모호해 헷갈린다. 

"set" 이라는 단어가 동사인지 형용사인지 분간하기 어려운 탓이다. 
함수를 구현한 개발자는 동사로 의도했지만 if문에 넣고 나니 형용사로 느껴진다. 
따라서 진짜 해결책은 
if(attributeExists("username")) {
   setAttribute("username", "unclebob");
   ...
} 이처럼 명령과 조회를 분리해 혼란을 애초에 뿌리 뽑는 방법이다. 

 

 

 

오류 코드보다 예외를 사용하라 ! p.57 

try {
  deletePage(page);
  registry.deleteReference(page.name);
  configKey.deleteKey(page.name.makeKey());
} catch(Exception e) {
   logger.log(e.getMessage);
}

-> 여기서 try/Catch 블록 뽑아내자. 
try/catch 블록은 원래 추하다. 코드 구조에 혼란을 일으키며 정상 동작과 오류 처리 동작을 뒤섞는다. 
try/catch 블록도 별도 함수로 뽑아내는 편이 좋다. 

public void delete(Page page) {
  try { 
    deletePageAndAllReference(page);
 } catch(Exception e) 
    logError(e);
} 

public void deletePageAndAllReferences(Page page) throws Exception {
///
} 

public void logError(Exception e)  { 
  logger.log(e.getMessage());
}

-> delete 메서드가 모든 오류를 처리한다. 그래서 코드를 이해하기 쉽다. 그리고 여기서 오류 처리도 한 가지 작업이기 때문에 오류를 처리하는 함수는 오류만 처리해야 마땅하다. 함수에 키워드가 try가 있다면 함수는 try 문으로 시작해서 catch/finally문으로 끝나야 한다. 

 

 

 

 반복하지 마라! p.60 

중복은 문제다. 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 네 곳이나 손봐야 하니까..!! 게다가 어느 한 곳이라도 빠뜨리는 바람에 오류가 발생할 확률도 4배나 높다. 

객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다. 

 

 

 

함수를 어떻게 짜죠?  p.61

소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다. 논문이나 기사를 작성할 때는 먼저 생각을 기록한 후 읽기 좋게 다듬는다. 초안은 대개 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다. 

함수를 짤 때도 마찬가지다. 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다. 이름이 즉흥적이고 코드는 중복된다. 하지만  그  서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다. 그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다. 와중에도 코드는 항상 단위 테스트를 통과한다. 

👩‍💻 3장 함수를 읽고 되게 느낀 점은 되게 막막하다.. 였는데 왜냐하면 내가 짠 거 다 수정해야 하는 수준일 것 같아서.... 

하지만 처음부터 누가 다 잘 짜겠는가!!!! 나는 지금 첫 단계로 처음에는 길고 복잡하게 짠 거라고 생각하고 이제, 코드를 다듬는 단계라고 생각하자. 함수로 쪼개고, 이름을 변경해주고, 중복을 제거하자!! 그리고 메서드를 줄이고 순서를 바꾸자!! 

이런식으로 해 나아가면 될 것이다... !!!