클린 코드 3장 함수

 

// 3-1. HtmlUtil.java (FitNesse 20070619)
public static String testableHtml {
	PageData pageData,
	boolean includeSuiteSetup
} throws Exception {
	Wikipage wikiPage = pageData.getWikiPage();
	StringBuffer buffer = new StringBuffer();
	if (pageData.hasAttribute("Test")) {
		if (includeSuiteSetup) {
			WikiPage suiteSetup = 
				PageCrawlerImpl.getInheritedPage(
						SuiteResponder.SUITE_SETUP_NAME, wikiPage
				);
			if (suiteSetup != null) {
				WikiPagePath pagePath =
					suiteSetup.getPageCrawler().getFullPath(suiteSetup);
				String pagePathName = PathParser.render(pagePath);
				buffer.append("!include -setup .")
							.append(pagePathName)
							.append("\\n");
			}
		}
		WikiPage setup =
			PageCrawlerImpl.getInheritedPage("SetUp", wikiPage);
		if (setup != null) {
			WikiPagePath setupPath =
				wikiPage.getPageCrawler().getFullPath(setup);
			String setupPathName = PathParser.render(setupPath);
			buffer.append("!include -setup .")
						.append(setupPathName)
						.append("\\n");
		}
	}
	buffer.append(pageData.getContent());
	if (pageData.hasAttribute("Test")) {
			WikiPage teardown = 
				PageCrawlerImpl.getInheritedPage("TearDown", wikiPage);
			if (teardown != null) {
				WikiPagePath teardownPath =
					suiteSetup.getPageCrawler().getFullPath(teardown);
				String teardownPathName = PathParser.render(teardownPath);
				buffer.append("!include -teardown .")
							.append(pagePathName)
							.append("\\n");
			}
			if (includeSuiteSetup) {
				WikiPage suiteTeardown = 
				PageCrawlerImpl.getInheritedPage(
						SuiteResponder.SUITE_TEARDOWN_NAME,
						wikiPage
				);
			if (suiteTeardown != null) {
				WikiPagePath pagePath =
					suiteSetup.getPageCrawler().getFullPath(suiteTeardown);
				String pagePathName = PathParser.render(pagePath);
				buffer.append("!include -teardown .")
							.append(pagePathName)
							.append("\\n");
			}
		}
	}
	pageData.setContent(buffer.toString());
	return pageData.getHtml();
}

 

// 3-2. 리펙터링 버전
public static String renderPageWithSetupsAndTeardowns(
	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());
		includeTeardownPages(testPage, newPageContent, isSuite);
		pageData.setContent(newPageContent.toString());
	}
	return pageData.getHtml();
}

3-2 함수가 읽기 쉽고 이해하기 쉬운 이유는 무엇일까? 의도를 분명히 표현하는 함수를 어떻게 구현할 수 있을까? 함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까?

 

작게 만들어라!

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

3-2 함수도 길다.

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

블록과 들여 쓰기, if 문/else 문/while 문 등에 들어가는 블록은 한 줄이어야 한다.

 

한 가지만 해라!

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

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

3-3을 더 이상 줄이기란 불가능 하다.
if 문을 includeSetupsAndTeardownsIfTestPate라는 함수로 만든다면 똑같은 내용을 다르게 표현할 뿐 추상화 수준은 바뀌지 않는다.

+ 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

 

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

함수 내 모든 문장의 추상화 수준이 동일해야 한다.

3-1에서
getHtml() - 추상화 수준 아주 높음
String PagePathName = PathParser.render(pagepath); - 추상화 수준 중간
.append("\n") - 추상화 수준이 아주 낮음

추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다. 하지만 문제는 이 정도로 그치지 않는다. 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.

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

코드는 위에서 아래로 이야기처럼 읽혀야 좋다.

 

Switch 문

switch 문은 작게 만들기 어렵다. 본질적으로 N가지를 처리한다. 불행하게도 switch 문을 완전히 피할 방법은 없다. 하지만 각 switch 문을 저 차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다. 물론 다형성을 이용한다.

// 3-4
public Money calculatePay(Employee e)
throws InvalidEmployeeType {
	switch (e.type) {
		case COMMISSIONED:

		case HOURLY:
	}
}

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

1. 길다.
2. 한 가지만 하지 않는다.
3. SRP를 위반한다. 코드를 변경할 이유가 여럿
4. OCP를 위반한다. 새 직원 유형을 추가할 때마다 코드를 변경하기 때문
5. 가장 심각한 문제는 위 함수와 구조가 동일한 함수가 무한정 존재

이를 해결하기 위해 switch 문을 추상 팩토리에 꽁꽁 숨긴다. 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다. 일반적으로 나는 switch 문을 단 한 번만 참아준다. 다형적 객체를 생성하는 코드 안에서다. 이렇게 상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다.

구체적인 구현 부분을 숨겨야 한다는 부분에 공감했다. 특히 switch 같은 경우 케이스 하나가 추가될 때마다 모든 switch를 다 찾아다니며 바꿔야 하니... 유지보수 비용이 너무 커진다! 그러니 switch를 직접 구현하는 부분은 한 곳에만 사용하고 다른 곳에서는 추상화된 코드를 호출만 하면 좋겠다

public abstract class Employee {
	public abstract boolean isPayday();
    public abstract Money caculatePay();
    public abstract void deliverPay(Money pay);
}
-----------
public interface EmployeeFactory {
	public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}
-----------
public class EmployeeImpl: 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);
        }
    }
}

 

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

좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않다.

이름이 길어도 괜찮다. 겁먹을 필요없다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 서술적인 주석보다 좋다.

함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다. 좋은 이름을 고른 후 코드를 더 좋게 재구성하는 사례도 없지 않다.

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

includeSetupAndTeardownPages, includeSuiteSetupPage, includeSetupPage,

등이 좋은 예다.

includeTeardownPages, includeSuiteTeardownPage, includeTeardownPage 도 당연히 있다. '짐작하는 대로' 다.

 

함수 인수

이상적인 인수 개수는 0개다.

1개는 괜찮다. 2개면 조금 복잡해진다. 3개는 가능한 피하는 편이 좋다. 4개 이상은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다.

# 많이 쓰는 단항 형식

인수 1개를 넘기는 가장 흔한 경우는 두 가지.

1. 인수에 질문을 던지는 경우. boolean fileExist("MyFile")
2. 인수를 뭔가로 변환해 결과를 반환하는 경우. InputStream fileOpen("MyFile")
   
   (다소 드물게 사용) 이벤트 형식. 입력 인수만 있고 출력 인수는 없다. 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다. passwordAttemptFailedNtimes(int attemps)
   • 이벤트 형식: 사이트 이펙트, 상태 변화를 일으키는 형식

이 경우들이 아니라면 단항 함수는 가급적 피한다. 예를 들어,

void includeSetupPageInto(StringBuffer pageText)는 가급적 피한다. 변환 함수에서 출력 인수를 사용하면 혼란을 일으킨다.

입력 인수를 변환하는 함수라면 변환 결과는 반환값으로 돌려준다.
StringBuffer transform(StringBuffer in) 이
void transform(StringBuffer out) 보다 좋다.

# 플래그 인수

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

# 이항 함수

일반적으로 단항 함수보다 이해하기 어렵다.
적절한 경우도 있다. 예를 들어, Point p = new Point(0, 0)가 좋은 예다. 인수 2개는 한 값을 표현하는 요소 두 요소에는 자연적인 순서도 있다.

아주 당연하게 여겨지는 이항 함수에도 문제가 있다.

# 삼항 함수

최소화하자. 클래스를 따로 만드는 걸 고려해보자.

 

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

사이드 이펙트 노노!!

public class UserValidator {
	private Cryptographer cryptographer;
    
    public boolean checkPassword(String userName, String password) {
    	User user = UserGateway.findByName(userName);
        if (user != User.NULL) {
        	String codedPhrase = user.getPhraseEncodedByPassword();
            String phrase = cryptographer.decrypt(codedPhrase, password);
            if ("Valid Password".equals(phrase)) {
            	Session.initialize(); // ⚠️
                return true;
            }
        }
        return false;
    }
}

안에서 initailize를 해버리니 밖에서는 파악이 안 된다.
checkPassword는 세션을 초기화해도 괜찮은 경우에만 호출이 가능하다.

필요하다면 함수 이름에 분명히 명시한다. checkPasswordAndInitializeSession 이라는 이름이 훨씬 좋다.

물론 함수가 '한 가지'만 한다는 규칙을 위반하지만.

 

명령과 조회를 분리하라!

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

public boolean set(String attribute, String value);

이 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true를 반환하고 실패하면 false를 반환한다.

명령과 조회를 분리해 혼란을 애초에 뿌리 뽑자.

if (attributeExists("username") {
	setAttribute("username", "unclebob");
    ...
}

 

반복하지 마라!

당연 또 당연. 입구와 출구가 하나만 존재해야 한다는, 함수에 return은 하나만 있어야 한다는 구조적 프로그래밍의 목표와 규율은 좋지만 애초에 함수가 작다면 별 이익을 제공하지 못한다.

함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다!

 

함수를 어떻게 짜죠?

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

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

일단 막 짜고. 테스트를 만들고. 리팩터링(고민 & 다듬기)한다.
의식적으로 연습 또 연습 🔥 체화시키자.

 

---

 

피가 되고 살이 되는 내용들이었다. 하나하나 곱씹으며 체화시키자.