Study / ETC13 minutes read (About 1928 words)

<클린 코드> 좋았던 내용 기록하기(1-3장)


< Clean Code > 도서의 내용을 공부하며 요약 정리하였습니다.

1장. 깨끗한 코드

시간에 쫓겨서 급하게 나쁜 코드를 짠 적이 있을 것이다. 나중에 다시 짜야지라는 생각으로 급하게 코드를 짜고는 하지만 나중은 오지 않는다.

깨끗한 코드를 짜기 위해서는 코드 감각이 필요하다. 깨끗한 코드란 그 정의도 다양하지만 대충의 의견은 다음과 같다.

  1. 논리가 간단해서 버그가 숨어들지 한다. 한 가지를 제대로 한다.
  2. 잘 쓴 문장처럼 읽힌다.
  3. 작성자가 아닌 사람도 읽기 쉽고 고치기 쉽다.
  4. 테스트 코드가 없는 코드는 깨끗한 코드가 아니다.
  5. 중복을 피해야 한다.

정리 : 중복을 피하라. 한 기능만 수행해라. 제대로 표현하라. 작게 추상화하라

2장. 의미있는 이름

의도를 분명하게 밝혀라

  • Int d; ⇒ int daysSincedCreation;
  • List ⇒ group, bunch

의미 있게 구분하라

  • 차이를 알도록 이름을 지어야 한다.
    • 나쁜 예시 : GetActiveAccount(), GetActiveAccounts(), GetActiveAccountInfo()
    • 나쁜 예시2 : CustomerInfo/customer, accountdata/account
  • 문자 하나만 사용하는 변수 이름은 문제가 있다.
    • 루프에서 반복 횟수를 세는 i,j,k는 괜찮다(l은 절대 안됨). 단, 루프 범위가 아주 작고 다른 이름과 충돌하지 않을 때만 괜찮다.

해법 영역에서 가져온 이름을 사용하라

코드를 읽는 사람도 프로그래머이다. 그러므로 전산용어, 알고리즘 이름 등을 사용해도 괜찮다. 모든 명칭을 문제 영역에서 가져올 것이 아니라, 기술 개념에는 기술 이름을 가져오는 것이 가장 적합한 선택이다. 적합한 프로그래머 용어가 없을 때, 문제 영역에서 이름을 가져온다.

** 문제 영역이란, 코드를 짜려는 프로젝트에 쓰이는 명칭 들을 말하는 것으로 보임. 예를 들면, 금리 관련 프로젝트에서는 정액제, 만기 등을 사용하는 것.

의미있는 맥락을 추가하라

예를 들어, firstName, city, street, houseNumber, state, zipcode라는 변수가 있다. 변수를 전체적으로 보면 주소라는 사실을 알 수 있지만 state변수 하나만으로는 쉽게 알아채기 어렵다. 이럴 때는 addr이라는 접두어를 추가해 addrFirstName, addrLastName, addrState라 쓰면 맥락이 좀 더 분명해진다.

3장. 함수

작게 만들어라!

함수를 만드는 첫째 규칙은 ‘작게!’다. 둘 째 규칙은 ‘더 작게!’이다. 함수는 100줄을 넘어서는 안된다. 20줄도 길다…

다시 말해, if문/else문/while문 등에 들어가는 블록은 한 줄이어야 한다는 의미이다. 대개 거기서 함수를 호출한다.

한 가지만 해라!

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

이 충고의 문제는 한 가지가 무엇인지 알기가 어렵다는 점이다.

3-3을 보자.

1
2
3
4
5
6
7
//3-3
public static String renderPageWithSetupsAndTeardowns(PageData PageData,
boolean isSuite) throws Exception{
	if(isTestPage(pageData))
		includeSetupAndTeardownPages(pageData, isSuite);
	return pageData.getHtml()
}

목록 3-3은 한가지만 하는가? 세가지를 한다고 주장할 수도 있다.

  1. 페이지가 테스트페이지인지 판단한다.
  2. 그렇다면 설정 페이지와 해제 페이지를 넣는다.
  3. 페이지를 HTML로 렌더링한다.

위에서 언급하는 세 단계는 지정된 함수 이름 아래에서 추상화 수준이 하나다. 함수는 간단한 TO문단으로 기술할 수 있다.

** TO : LOGO 언어에서 사용하는 함수 선언 방식으로, 파이썬이나 루비의 def와 같다.

1
2
3
TO RenderPageWithSetupAndTeardowns, 
페이지가 테스트 페이지인지 확인한 후 테스트 페이지라면 설정 페이지와 해제 페이지를 넣는다.
테스트 페이지든 아니든 페이지를 HTML로 렌더링한다.

정리하면, 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한가지 작업만 한다고 볼 수 있다. 또 다른 방법은, 단순히 다른 표현이 아니라 의미있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러작업을 하는 셈이다.

함수 당 추상화 수준은 하나로!⭐

함수가 확실히 한 가지 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야한다. 함수 호출 getHtml() 은 추상화 수준이 높다. 그리고 모듈을 사용한 변수 선언(?) String pagePathName = PathParser.render(pagepath);는 추상화 수준이 중간이다. 그리고.append(“\n”)와 같은 코드는 추상화 수준이 낮다.

한 함수내의 추상화 수준을 섞으면. 코드를 읽는 사람이 헷갈린다.

내려가기 규칙

코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면서 추상화 수준이 한 단계씩 낮아지는 것이다.

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

함수 이름은 함수 내용이 짐작 가능할 수 있어야 한다. 함수 이름이 길어도 괜찮다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다. 이름을 정하느라 시간을 들여도 괜찮다.

함수 인수

함수에서 이상적인 인수 개수는 0개이다. 4개이상은 사용하지 않는게 좋다.

  1. 인수가 1개인 경우
  • 인수에 질문을 던지는 경우
    • Boolean fileExists(“MyFile”)
  • 인수를 뭔가로 변환해 결과를 반환하는 경우
    • InputStream fileOpen(“MyFile”)
  • 이벤트 발생 ⇒ 출력 인수 없이 시스템 상태를 바꾼다.
  1. 플래그 인수

플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까…!

  1. 인수가 2개인 함수
  • 2개가 적절한 경우도 있지만(예, 좌표를 찍는 함수 x축,y축) 단항 함수로 바꾸도록 애써야 한다.
  1. 인수가 3개인 함수
  • 이해하기 어렵다. 신중히 고려하라..

인수 객체가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어보자.

1
2
Circle makeCircle(double x, double y, double radius)
Circle makeCircle(Point center, double radius)

명령과 조회를 분리해라!

함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중하나만 해야한다. 아래 코드는 명령과 조회를 함께한다.

1
if(set("username", "unclebob"))

명령과 조회를 분리해 혼란을 없애야 한다.

1
2
3
if(attributeExists("username")){
	setAttribute("username", "unclebob");
}

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

1
if(deletePage(page) == E_OK)

위 코드는 여러 단계로 중첩되는 코드를 야기한다. 오류 코드를 반환하면 호출자는 오류 코드를 바로 처리해야 한다. 반면 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

#

Comments

×