클린 코드(Clean Code) - 1장, 2장, 3장

신은 세세함에 깃들어 있다.

 

  책은 각각의 큰 주제에 대해서 17개의 장으로 구성되어 있다. 해당 글에서는 책의 모든 내용을 다루지는 않는다. 현재 나에게 필요한 내용이거나 다시 한번 상기해야 하는 점들만 다룰 것이므로 이 점에 대해서는 양해를 구한다.

 

1장. 깨끗한 코드 🌊

  워드 커닝햄(Ward Cunningham)은 '깨끗한 코드는 읽으면서 놀랄 일이 없어야 한다'라고 말한다. 읽으면서 짐작한 대로 돌아가는 코드가 깨끗한 코드다. 각 모듈은 다음 무대를 준비하고, 모듈을 읽으면서 다음에 벌어질 상황이 보여야 한다.

 

2장. 의미 있는 이름 🌼

• 좋은 이름을 지으려면 많은 시간이 걸리지만 좋은 이름으로 절약하는 시간이 훨씬 더 많다.
• 생성자를 중복정의할 때는 정적 팩토리 메서드를 사용한다.
• 추상적인 개념 하나에 단어 하나를 선택해 이를 고수한다.
    예를 들어, 똑같은 메서드를 클래스마다 fetch, retrieve, get으로 제각각 부르지 않는다.
    마찬가지로, 동일 코드 기반에 controller, manager, driver를 섞어 쓰면 혼란스럽다.
• 한 단어를 두 가지 목적으로 사용하지 마라.
    예를 들어, 지금까지 구현한 add 메서드는 모두가 기존 값 두 개를 더하거나 이어서 새로운 값을 만든다고 가정하자. 새로 작성한 메서드는 집합에 값 하나를 추가한다. 이런 경우 add가 아닌 insert나 append라는 이름이 적당하다. 
• 의미 있는 맥락을 추가하라
    firstName, lastName, street, houseNumber, city, state, zipcode라는 변수가 있을 때, 변수들은 주소라는 사실을 금방 알 수 있다. 하지만 어느 메서드가 state라는 변수 하나만 사용한다면 변수 state가 주소 일부라는 사실을 금방 알아채기 힘들다.
    addr라는 접두어를 추가해 addrFirstName, addrLastName, addrSate라 쓰면 맥락이 조금 더 분명해진다.
  
  

 

3장. 함수 🌱

• 함수를 만드는 첫 번째 규칙은 '작게!'다. 함수를 만드는 두 번째 규칙은 '더 작게!'다.
• 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서는 안 된다.
    중첩 구조가 생길 만큼 함수가 커져서는 안 된다. 'if 문 / else 문 / while 문' 등에 들어가는 블록은 한 줄이어야 한다.
• 함수는 한 가지를 해야 한다. 그 한 가지를 잘해야 한다. 그 한 가지만을 해야 한다. 
    지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다. 함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다. (추상화 수준이란 해당 코드를 읽으면서 파악할 수 있는 정보의 수준을 말한다. 해당 코드로 더 자세한 정보를 알 수 있으면 추상화 수준이 더 낮아진다고 할 수 있다.)
• 한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.
    특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다. 하지만 문제는 이 정도로 그치지 않는다. 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.
    이를 위해 내려가기 규칙이란 것이 있다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 오는 방법이다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. 
• 다형성(polymorphism)을 이용하여 switch 문을 작성하자

// 나쁜 코드
public Money calculatePay(Employee e) throws InvalidEmployeeType {
    switch (e.type) {
        case COMMISSIONED:
            return calculateCommissionedPay(e);
        case HOURLY:
            return calculateHourlyPae(e);
        case SALARIED:
            return calculateSalariedPay(e);
        default:
            throw new InvalidEmployeeType(e.type);
    }
}

// 좋은 코드
public abstract class Employee {
    public abstract boolean isPayday();
    public abstract Money calculatePay();
    public abstract void deliverPay(Money pay);
}

------------------------------------------------

public interface EmplyeeFactory {
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}

------------------------------------------------

public class EmployeeFactoryImpl implements EmployeeFactory {
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
        switch (r.type) {
            case COMMISSIONED:
                return new CommissionedEmployee(r);
            case HOURLY:
                return new HourlyEmployee(r);
            case SALARIED:
                return new SalariedEmployee(r);
            default:
                throw new InvalidEmployeeType(r.type);
        }
    }
}

 

• 함수에서 이상적인 인수 개수는 0개(무항)다.
    다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상(다항)은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다. 
• 단항 함수는 '인수에 질문을 던지는 경우'와 '인수를 무언가로 변환해 결과를 반환하는 경우에 사용한다.
    인수에 질문을 던지는 경우 - boolean fileExists("MyFile")
    인수를 무언가로 변환해 결과를 반환하는 경우 - InputStream fileOpen("MyFiile") // String 형의 파일 이름을 InpustStream으로 변환하는 것
• 플래그 인수를 쓰지 말자
    함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 이것은 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 것이다. (플래그가 참이면 A를 하고 거짓이면 B를 한다는 것)
• 함수는 무언가를 수행하거나 무언가를 답하거나 둘 중 하나만 해야 한다.
• 오류 코드보다 예외를 사용하라

// 오류 코드를 사용하는 경우
if (deletePage(page) == E_OK) {
    if (registry.deleteReference(page.name) == E_OK) {
        if (configKeys.deleteKey(page.name.makeKey()) == E_OK) {
            logger.log("page delted");
        } else {
            logger.log("configKey not deleted");
        }
    } else {
        logger.log("deletedReference from registry failed");
    }
} else {
    logger.log("delete failed");
    return E_ERROR;
}

 

// 예외를 사용한 경우
try {
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}
catch (Exception e) {
    logger.log(e.getMessage());
}

  try/catch 블록은 원래 지저분하다. 그러므로 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(Exceptioni e) {
    logger.log(e.getMessage());
}