[Clean Code] 3장 함수

[Clean Code] 3장 함수

생성일: 2024년 1월 17일 오후 4:42

추상화 수준

---

작게 만들어라!

---

💡 작은 함수가 좋다. (2~4줄) if, else, while 문 등에 들어가는 블록은 함수를 호출하는 한 줄이 좋다. **내려가기 규칙 ***추상화 수준이 한 단계 낮은 함수를 호출하기 ****

한 가지만 해라

---

💡 함수는 한 가지를 해야 한다. 한 가지를 잘 해야 한다. **한 가지만 하는 함수** 1. 추상화 수준이 하나인 단계만 수행한다. 2. 의미 있는 이름으로 다른 함수를 추출할 수 있다.

한 가지만 하려면 ? 함수 당 추상화 수준은 하나로!

---

💡 함수 내 모든 문장의 추상화 수준을 동일하게 한다. 한 함수 내에 추상화 수준을 섞으면 읽을 때 헷갈린다. 근본 개념인지 아니면 세부사항인지 구분하기 어렵기 때문이다. 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.

Switch 문

---

💡 switch 문은 작게 만들기 어렵다. 본질적으로 N가지를 처리한다. 다형성을 이욯해 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법이 있다.

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

---

💡 1장에서 워드가 말했던 원칙 “코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.” 이름이 길어도 괜찮다. 길고 서술적인 이름>길고 서술적인 주석

함수 인수

---

💡 인수는 개념을 이해하기 어렵게 한다. 적을 수록 좋다. **인수를 1개 넘기는 경우** 1. 인수에 질문을 던지는 경우 `boolean fileExists(”MyFile”)` 2.인수를 무언가로 변환해 결과를 반환하는 경우 `InputStream fileOpen(”Myfile”)` *입력인수를 변환하는 함수라면 변환결과는 반환값으로 돌려주기

인수 2개를 넘기는 경우

1. 두 인수에 자연적인 순서가 없을 때 헷갈린다.
   → 함수이름에 키워드를 추가할 수 있다.
   assertEquals(expected, actual) → assertExpectedEqualsActual(expected, actual)
2. 가능하면 단항함수로 바꾼다. (writeField를 outputStream 클래스의구성원으로 만들기)
   writeField(outputStream, name) →outputStream.writeField(name) 으로 호출하기

인수객체
인수를 독자적인 클래수 변수로 선언해 객체를 생성해 인수를 줄인다.
→ 개념을 표현하게 된다.
Circle makeCircle(double x, double y, double radius); Circle makeCircle(Point center, double radius);

todo: 함수 분석해보기

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

---

예를 들어 비밀번호를 암호화하는 함수에서 유저의 세션을 초기화하기

문제점

1. 시간적인 결합 초래
2. 잘못하면 세션 정보 날아갈 수 있음

명령과 조회를 분리하라!

---

//모호한 의미의 코드 : username이 unclebob으로 설정되어 있는지 확인하는 코드같음
if (set("username", "unclebob"))..

//→
if(attributeExists(”username”)){
    setAttributo(”username”,”unclebob”)
}

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

---

오류코드를 반환하면 if문에서 표현식으로 활용하기 쉽다.

if(deletePage(page)==E_OK)

문제

중첩되는 코드 야기 & 오류코드 바로 처리

Try/Catch도 정답은 아니다. 코드 구조에 혼한을 일으킨다.

어떻게?

정상 동작과 오류 처리 동작을 분리한다. 오류도 ‘한가지’ 작업에 속한다.

//모든 오류 처리
public void delete(Page page) {
    try {
        deletePageAndAllReferences(page);
    }
    catch (Exception e) {
        logError(e);
    }
}
//예외를 처리하지 않음
private void deletePageAndAllReferences(Page page) throws Exception { 
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}

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

반복하지 마라!

---

3-7처럼 중복을 없앨 수 있다.

   private void includeSetupAndTeardownPage() throws Exception {        
            includeSetupPage();        
            includePageContent();        
            includeTeardownPages();        
            updatePageContent();    
}

구조적 프로그래밍, AOP,COP등이 중복제거전략이다.

구조적 프로그래밍

---

모든 함수와 함수 내 모든 블록에 entry 와 exit가 하나만 존재해야 한다.

• break, continuem goto 안됨
  • 함수를 작게 만든다면 가능 (goto 뺴고)

함수를 어떻게 짜죠?

---

1. 코드를 다듬고
2. 함수를 만들고
3. 이름을 바꾸고
4. 중복을 제거하고
5. 메서드를 줄이고
6. 순서를 바꾼다.