[리뷰] 클린코드 Clean Code 3장 - 함수

책의 내용 - 함수

*작게 만들어라! 명백한 함수는 2줄 ~ 4줄이 적당하다.

각 함수가 명백하게 하나를 표현한다면 너무나도 멋진 다음 무대를 준비했다.

 - 블록과 들여쓰기

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

 

*한 가지만 해라

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

아래와 같은 코드가 있다고 해보자.

public static String renderPageWithWetupsAndTeardonws(
	PageData pageData, boolean isSuite
) throws Exception {
 boolean isTestPage = pageData.hasAttribute("Test");
 if (isTestPage) {
  WikiPage testPage = pageData.getWikiPage();
  StringBuffer NewPageContent = new StringBuffer();
  includeSetupPages(testPage, newPageContent, isSuite);
  newPageContent.append(pageDAta.getContent());
  includeTearDwonPages(testPage, newPageContent, isSuite);
  pageData.setCoontent(newPageContent.toString());
 }
 retrun pageData.getHtml();
}

 

명백한 함수는 2줄 ~ 4줄이 적당 위와 같은 함수는 아래와 같이 변경해줘야 된다.

public static String renderPageWithWetupsAndTeardonws(
	PageData pageData, boolean isSuite
) throws Exception {
 if (isTestPage(pageData)) {
  includeSetupPagesAndTearDonwPages(pageData, isSuite);
 }
 retrun pageData.getHtml();
}​

그렇다면 아래와 같이 어떻게 함수를 간단하게 변경해줄까? 저자는 말한다.

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

'의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.'

 

하지만 위에 소스코드는 한 가지만 하는가? 세 가지를 한다고 주장할 수도 있다.

1. 페이지가 테스트 페이지인지 판단한다.

2. 그렇다면 설정 페이지와 해제 페이지를 넣는다.

3. 페이지를 HTML로 렌더링 한다.

 

하지만 세 단계는 지정된 함수 이름 아래 추상화 수준이 하나이다.

여기서 글을 읽으면서 어려움을 겪었다. 

 

추상화 수준이 하나인 단계?? 무슨 말을 하는지 이해가 좀 되지 않았다.

 

함수의 추상화란?

예를 들면 PageData.getHtml(); 은 우리가 함수명만 보고 함수의 내부에는 어떤 로직이 동작하는지 알 수가 없다.

이는 함수의 추상화가 높은 단계라고 설명할 수 있다.

 

두 번째 예시로 PathParser.render(pagepath);는 추상화 수준이 중간이다. 이는 페이지의 경로를  넘기고 랜더링 해서 해당하는 값을 가져온다고 우리가 조금은 추측할 수 있으므로.

 

세 번째 예시로. append('/n')와 같은 코드는 수준이 아주 낮다. 이는 누가 봐도 태그를 붙인다고 설명할 수 있으니 말이다.

 

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

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

위에서 아래로 코드 읽기 : 내려가기 규칙

코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.

 

*Switch 문

switch 문은 작게 만들기 어렵다. 하지만 각 switch문을 저 차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다.

다형성을 이용한다.

public Money calculatePay(Employee e) thros InvalidEmployeeType {
	switch (e.type) {
    	case COMMISSIONED:
        	return calcuateCommissionedPay(e);
        case HOURLY:
        	return calculateHourlyPay(e);
        case SALARIED:
        	return calculateSalariedPay(e);
        default:
        	throw new InvalidEmployeeType(e.type);
    }
}

위 함수에는 몇 가지 문제가 있다.

첫째, 함수가 길다.

둘째, '한 가지' 작업만 수행하지 않는다.

셋째, 'SRP'를 위반한다. 단일 책임 원칙을 위반한다.

 - '클래스는 단 한 개의 책임을 가져야 한다. 클래스를 변경하는 이유는 단 한 개여야 한다.'

 - 코드를 변경할 이유가 여럿 있다.

넷째 OCP를 위반한다.

 - 새 직원을 추가할 때마다 코드를 변경해야 한다.

제일 심각한 문제 함수의 구조가 동일한 함수가 무한 정 존재한다는 사실이다.

 

public abstract class Employee {
    public abstract boolean isPayday();
    public abstract money calculatePay();
    public abstract void deleverPay(Money pay);
}

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

public class EmployeeFactoryImpp 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(e.type);
        }
    }
}

문제 해결 : 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한 후 , 필요한 함수를 Employee 인터페이스를 거쳐 호출한다.

저자는 말한다. '일반적으로 나는 switch 문을 단 한 번만 참아준다. 다형적 객체를 생성하는 코드 안에서이다.'

 

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

함수는 작고 단순할수록 서술적인 이름을 고르기 쉬워진다.

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

예를 들면 includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage, 등이 좋은 예이다.

 

*함수 인수

함수에서 이상적인 인수 개수는 0개 문항이다.

인수는 개념을 이해하기 어렵게 만든다.

코드를 읽는 사람에게는 includeSetupPageInto(new PageContent)보다 includSetupPage()가 이해하기 쉽다.

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

 

그렇다면 인수는 어떠한 시기일 때 사용해야 되는가?

 

1. 인수에 질문을 던지는 경우다. boolean fileExists("MyFile")

2. 인수를 뭔가로 변환해 결과를 반환하는 경우다. InputStream fileOepn("MyFile")

3. 단항 함수 형식 이벤트이다.

- passwordAttemptFailedNtimes(int attempts) 이벤트는 사실 코드에 명확하게 드러나야 한다. 그러므로 이름과 문맥을 주의해서 선택한다.

4. 입력 인수를 변환하는 함수라면 변환 결과는 반환 값으로 돌려준다.

 

*플래그 인수

플래그 인수는 추하다. 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까!

 

*이항 함수

이항 함수가 무조건 나쁘다는 소리는 아니다. 프로그램을 하다 보면 불가피한 경우도 생긴다. 하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하다면 단항 함수로 바꾸도록 애써야 한다. 

 

예를 들면 writeField(outputStream, name);이라는 함수가 있다고 가정해보자.

 

1. 해당하는 함수를 outputStream.writeField(name)으로 변경하는 방법

2. outputStream을 현재 클래스 구성원 변수로 만드는 방법

3. FieldWriter라는 새 클래스를 만들어 구성자에서 outputStream을 받고 write메서드를 구현하는 방법

위 예제처럼 최대한 인수를 줄이도록 하는 게 좋다. 

 

*동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.

1. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.

예를 들면 writeField(name)이다. 그러면 '이름'이 '필드'라는 사실이 분명히 드러난다.

2. 함수 이름에 키워드를 추가하는 형식이다. 함수 이름에 인수 이름을 넣는다.

예를 들면, assertEqulas보다 assertExpectedEqulasAcutal(expected, actual)이 더 좋다. 그러면 인수를 기억할 필요가 없어진다.

 

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

함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까.

아래 코드를 봐보자.

public class UserValidator {
	private Cryptographer cryptographer;
    
    public boolean checkPasswrod(String userName, String password) {
    	User user = UserGateway.findByName(userName);
        if (user != user.NULL) {
        	String codedPhrase = user.getPhraseEncodedByPassword();
            String phrase = cyptographer.decrypt(codedPhrase, password);
            if ("Valid password".equals()) {
            	Session.initalize(); //숨은 부수효과
                return true;
            }
        }
        return false;
    }
}

 

checkPass-word 함수는 이름 그대로 암호를 확인한다. 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다. 그래서 함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다.

 

*출력 인수

일반적으로 우리는 인수를 함수 입력으로 해석한다.

appendFooter(s);

이 함수는 무언가에 s를 바닥글로 첨부할까? 아니면 s에 바닥글을 첨부할까? 함수 선언부를 보면 분명해진다.

 

public void appendFooter(StringBuffer report)

인수 s가 출력 인수라는 사실은 분명하지만 함수 선언부를 찾아보고 나서야 알았다.

함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다. 

 

다음과 같이 바꿔주자!

report.appendFooter()

 

일반적으로 출력 인수는 피해야 한다.

함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

 

*명령과 조회를 분리하라!

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

아래 예제를 보자.

 

public boolean set(String attribute, String value)

이 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true 실패하면 false를 반환한다. 괴상한 코드이다. 아래처럼 변경해야 된다.

 

if (attributeExists("userNmae")) {

  setAttribute("userName", "unclebob")

  ...

}

 

*Try/Catch 블록 뽑아내기

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

아래 예제 코드를 보자

 

try {
    deletePage(page);
    registry.deleteReference(page.name);
    configkeys.deleteKey(page.name.makeKey());
} catch (Exception e) {
	logger.log(e.getMessage());
}
----------------------------------------------
//try/catch블록을 별도 함수로 뽑아내보자.
public void delete (Page page) {
    try{
    	deletePageAndAllReference(page);
    } catch (Exception e) {
    	logError(e);
    }
}

private void deletePageAndAllReference(Page page) throws Exception {
	deletePage(page);
    registry.deleteReference(page.name);
    configkeys.deleteKey(page.name.makeKey());
}

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

정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.

 

결론

오늘은 클린 코드 2장 함수에 대해 읽었다. 함수를 짜는 방식과, 함수를 잘못 짰을 때 위험성을 절실하게 느끼는 절이였다. 아무래도 현업에 있다 보면 일정에 쫓기는 경우가 많은데, 위와 같은 방식으로 깔끔하게 수정한다면, 문제가 발생했을 때 언제든지 대처할 수 있다고 생각되었다. 

 

저자는 마지막에 말한다.

'처음에 함수를 짤 때는 길고 복잡하다. 하지만 나는 그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다. 그런 다음 나는 코드를 다듬고, 함수를 만들고, 이름을 바꾸고 중복을 제거한다.' 메서드를 줄이고 순서를 바꾼다. 전체 클래스를 쪼개기도 한다. 이 와중에 코드는 항상 단위 테스트를 통과한다.'

 

항상 이 글을 머릿속에 놓지 않고, 계속 수정해서 깔끔한 코드를 만들 것이다.!