[Clean Code] 3장 함수

들어가기

3분의 시간동안 아래의 코드를 한번 이해해본다!

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 =
 wikiPage.getPageCrawler().getFullPath(teardown);
 String tearDownPathName = PathParser.render(tearDownPath);
 buffer.append("\n")
 .append("!include -teardown .")
 .append(tearDownPathName)
 .append("\n");
 }
 if (includeSuiteSetup) {
 WikiPage suiteTeardown =
 PageCrawlerImpl.getInheritedPage(
 SuiteResponder.SUITE_TEARDOWN_NAME,
 wikiPage
 );
 if (suiteTeardown != null) {
 WikiPagePath pagePath =
 suiteTeardown.getPageCrawler().getFullPath (suiteTeardown);
 String pagePathName = PathParser.render(pagePath);
 buffer.append("!include -teardown .")
 .append(pagePathName)
 .append("\n");
 }
 }
 }
 pageData.setContent(buffer.toString());
 return pageData.getHtml();
}

위의 코드는 추상화도 너무 다양하고 코드의 길이도 길뿐더러 정리도 되어 있지 않다.

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();
}

하지만 다음 아래의 코드는 비교적 위의 코드보다 이해하기 쉬울것이다.

---

작게 만들어라!

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

각 함수가 너무도 명백하고 각 함수가 이야기 하나를 표현해라. 이것이 답이다.

---

한 가지만 해라!

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

함수가 '한 가지'만 하는지 판단하는 방법이 하나 있다. 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

---

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

함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.

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

​

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

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

---

Switch 문

switch 문은 작게 만들기 어렵다. case 분기가 단 두개여도 코드가 길어지기 때문이다. 또한 '한 가지' 작업만 하는 switch문도 만들기 어렵다. 이유는 본질적으로 switch 문은 N가지를 처리하기 깨문이다.

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

위 함수에는 몇 가지 문제가 있다. 첫째, 함수가 길다. 둘째, '한 가지' 작업만 수행하지 않는다. 셋째, SRP(single responsibility principle)를 위반한다. 넷째, OCP(open closed principle)을 위반한다.

위를 해결하기 위해서는 switch문을 추상 팩토리에 숨긴다. 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다.그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.

public abstract class Employee {
 public abstract boolean isPayday();
 public abstract Money calculatePay();
 public abstract void deliverPay(Money pay);
}
-----------------
public interface EmployeeFactory {
 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개를 넘기는 이유로 가장 흔한 경우는 두 가지 이다.

1. 하나는 인수에 질문을 던지는 경우

2. 인수를 뭔가로 변환해 결과를 반환하는 경우

위의 두가지는 납득이 된다.

위의 두 경우가 아니라면 단항 함수는 가급적 피한다.

​

플래그 인수

플래그 인수는 추하다. 플래그가 참이면 이걸하고 플래그가 불이면 저걸 한다는건 이미 함수가 2가지 일을 한다는 의미이다.

​

이항 함수

인수가 2개인 함수는 1개인 함수보다 어렵다. 이항 함수가 적절한 경우도 있지만 그만큼 위험이 따른다.

즉 단항 함수로 바꾸도록 애써야 한다.

​

삼항 함수

인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 이해하기 힘들다.

​

인수 객체

인수가 2~3개이면 일부를 클래스 변수로 선언할 가능성이 있다.

Circle makeCircle(double x, double y, double radius);

Circle makeCircle(Point center, double radius);

객체를 생성해 인수를 줄이는 방법이 눈속임이라 여겨질지 모르지만 그렇지 않다. x 와 y를 묶었듯이 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.

​

인수 목록

때로는 인수 개수가 가변적인 함수도 필요하다.

String.format("%s worked %.2f" hours.", name, hours);

public String format(String format, Object... args);

​

void monad(Integer... args);

void dyad(String name, Integer... args);

void triad(String name, int count, Integer... args);

​

동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야한다.

write(name)

---

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

부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓을 하는것이다. 클래스 변수를 수정하거나 함수로 넘어온 인수, 시스템 전역 변수를 수정한다. 이는 시간적인 결합이나 순서 종속성을 초래한다.

​

출력 인수

일반적으로 우리는 인수를 함수 입력으로 해석한다. 하지만 인수를 출력으로 쓰이는 경우다 있다.

---

명령과 조회를 분리하라!

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

---

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 if 문에서 명령을 표현식으로 사용하기 쉬운 탓이다.

if (deletePage(page) == E_OK) {
 if (registry.deleteReference(page.name) == E_OK) {
 if (configKeys.deleteKey(page.name.makeKey()) == E_OK){
 logger.log("page deleted");
 } else {
 logger.log("configKey not deleted");
 }
 } else {
 logger.log("deleteReference 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 블록은 추잡하지만 이를 별도 함수로 뽑아내면 깔끔해진다.

​

오류 처리도 한 가지 작업이다

함수는 '한 가지' 작업만 해야 한다. 오류 처리도 작업에 속한다. 그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다.

---

반복하지 마라

중복은 문제다. 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 여러곳을 손봐야 한다. 게다가 어느 한곳이라도 빠뜨리게 되면 오류가 발생할 확률도 높아진다.

중복을 없애면 모듈 가독성이 크게 높아진다.

---

함수를 짜는 법!

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

내가 함수를 짤 때도 마찬가지다. 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다. 이름은 즉흥적이고 코드는 중복된다. 하지만 나는 그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.

그런 다음 나는 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다. 이 와중에도 단위 테스트는 통과한다.

최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다. 처음부터 탁짜내지 않는다. 그게 가능한 사람은 없으니까!

---

결론

모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한 도메인 특화 언어로 만들어진다. 함수는 그 언어에서 동사며, 클래스는 명사다. 요구사항 문서에 나오는 명사와 동사를 클래스 함수 후보로 고려한다는 끔찍한 옛 규칙으로 역행하자는 이야기가 아니다. 이것은 오히려 훨씬 더 오래된 진실이다. 프로그래밍의 기술은 언제나 언어 설계의 기술이다.

시스템을 프로그램이 아니라 이야기로 여긴다. 프로그래밍 언어라는 수단을 사용해 좀 더 풀부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다. 시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 바로 그 언어에 속한다. 재귀라는 기교로 각 동작은 바로 그 도메인에 특화된 언어를 사용해 자신만의 이야기를 풀어간다.