📕 목차

1. 작게 만들어라!
    • 블록과 들여쓰기
2. 한 가지만 해라!
    • 함수 내 섹션
3. 함수 당 추상화 수준은 하나로!
    • 위에서 아래로 코드 읽기: 내려가기 규칙
4. Switch 문
5. 서술적인 이름을 사용하라!
6. 함수 인수
    • 많이 쓰는 단항 형식
    • 플래그 인수
    • 이항 함수
    • 삼항 함수
    • 인수 객체
    • 인수 목록
    • 동사와 키워드
7. 부수 효과를 일으키지 마라!
    • 출력 인수
8. 명령과 조회를 분리하라!
9. 오류 코드보다 예외를 사용하라!
    • Try/Catch 블록 뽑아내기
    • 오류 처리도 한 가지 작업이다.
    • Error.java 의존성 자석
10. 반복하지 마라!
11. 구조적 프로그래밍
12. 함수를 어떻게 짜죠?

1. 작게 만들어라!

 

더보기

아래 코드를 3분 동안 살펴보라.

public class HtmlUtil {
    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");
            }
        }
        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();
    }
}

코드를 이해할 수 있는가? 아마 아닐 것이다.

추상화 수준도 너무 다양하고, 너무 길다.

두 겹으로 중첩된 if 문은 이상한 플래그를 확인하고, 이상한 문자열을 사용하며, 이상한 함수를 호출한다.

 

이 코드를 단 9줄로 축약할 수 있다.

public class HtmlUtil {
    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);
        }
        return pageData.getHtml();
    }
}

FitNesse에 익숙하지 않다면 100% 이해하지 못하더라도, 해당 함수가 설정(setup) 페이지와 해제(teardown) 페이지를 테스트 페이지에 넣은 후, 테스트 페이지를 HTML로 렌더링한다는 사실은 짐작할 수 있다.

어째서 이러한 차이가 발생하는 걸까?

  • 함수를 만드는 첫째 규칙이 '작게!'고, 둘째 규칙이 '더 작게!'다.
  • 얼마나 짧아야 하는지에 대한 규칙성은 없지만, 가로 150자 세로 100줄도 많다.
  • 위에 접은 글의 리팩토링한 함수보다도 짧아야 한다. 해당 코드는 아래처럼 줄어야 했어야 했다.
// 3-3
public class HtmlUtil {
    public static String renderPageWithSetupsAndTeardowns(
            PageData pageData, boolean isSuite) throws Exception {
        if (isTestPage(pageData))
            includeSetupAndTeardownPages(pageData, isSuite);
        return pageData.getHtml();
    }
}

 

📌 블록과 들여쓰기
  • if/else/while 문 들에 들어가는 블록은 한 줄이어야 한다. 들여써봐야 1단, 2단을 넘어서면 안 된다.
  • 중첩 구조가 생길만큼 함수가 커져서는 안 된다.

 

2. 한 가지만 해라!

 

💡 함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
  • '한 가지'는 지정된 함수 이름 아래에서 추상화 수준이 하나를 의미한다.
  • 목록 3-3을 더 이상 줄이기란 불가능 하다. if 문을 함수화하면 똑같은 내용을 다르게 표현할 뿐 추상화 수준은 바뀌지 않는다.
  • '한 가지'를 판단하는 다른 방법은 의미 있는 이름으로 다른 함수를 추출할 수 있다면, 그 함수는 여러 작업을 하고 있는 것이다.

 

📌 함수 내 섹션
  • 한 함수에서 여러 섹션으로 나뉜다는 것은 여러 작업을 한다는 증거다.
  • 한 가지 작업만 함수는 자연스럽게 섹션으로 나누기 어렵다.

 

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

 

  • 함수 내 추상화 수준을 일치시켜라
    • getHtml()은 추상화 수준이 아주 높다.
    • String pagePathName = PathParser.render(pagepath); 는 추상화 수준이 중간이다.
    • .append("\n")은 추상화 수준이 아주 낮다.
  • 추상화 수준이 섞이면, 즉 근본 개념과 세부 사항이 뒤섞이면, 사람들이 함수에 세부사항을 점점 더 추가한다.

 

📌 위에서 아래로 코드 읽기: 내려가기 규칙
TO 설정 페이지와 해제 페이지를 포함하려면, 설정 페이지를 포함하고, 테스트 페이지 내용을 포함하고, 해제 페이지를 포함한다.
   TO 설정 페이지를 포함하려면, 슈트이면 슈트 설정 페이지를 포함한 후 일반 설정 페이지를 포함한다.
      TO 슈트 설정 페이지를 포함하려면, 부모 계층에서 "SuiteSetUp" 페이지를 찾아 include문과 페이지 경로를 추가한다.
          TO 부모 계층을 검색하려면, .....
  • 코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
  • 한 함수 다음에는 추상화 수준이 한 단계씩 낮아진다.
  • 핵심은 짧으면서도 '한 가지'만 하는 함수다.

 

4. Switch 문

 

  • 각 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법이 있다. (다형성 이용)

아래 코드 문제점을 분석해보자.

public class Payroll {
    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)를 위반한다. → 새 직원 유형을 추가할 때마다 코드를 변경하기 때문
  • 위 함수와 구조가 동일한 함수가 무한정 존재한다.
    • isPayday(Employee e, Date date); 나 deliverPay(Employee e, Money pay); 도 가능하다.

 

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);
        }
    }
}
  • 추상 팩토리에 switch문을 숨기고 있다.
  • 팩터리는 switch문을 사용해 적절한 Employee 파생 클래스 인스턴스를 생성한다.
  • caclulatePay, isPayday, deliverPay 등과 같은 함수는 Employee 인터페이스를 거쳐 호출된다.

 

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

 

  • 한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 "코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 실행"할 것이다.
  • 길고 서술적인 이름이 짤고 어려운 이름보다, 길고 서술적인 주석보다 좋다.
  • 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.
  • 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용해 일관성을 지켜라
    • includeSetupAndTeardownPages
    • includeSetupPages
    • includeSuiteSetupPage
    • includeSetupPage

 

6. 함수 인수

 

  • 0개(무항)이 이상적이고, 다음이 1개(단항), 다음이 2개(이항)이다.
  • 3개(삼항)는 피하는 편이 좋고, 4개(다항)이상은 특별한 이유가 필요하다. (있어도 사용하지 마라)
  • 함수 이름과 인수 사이에 추상화 수준이 달라서 독자가 이해하기 힘들다.
  • 테스트 관점에서 봐도 인수가 3개를 넘어가면, 인수마다 유효값으로 모든 조합을 구성해야 한다.
  • 출력 인수는 사용자를 혼란에 빠지게 만든다.

 

📌 많이 쓰는 다항 형식
  • 인수에 질문을 던지는 경우
    • boolean fileExists("MyFile")
  • 인수를 뭔가로 변환해 결과를 반환하는 경우
    • InputStream fileOpen("MyFile")
  • 이벤트 함수일 경우
    • 이벤트라는 사실이 코드에 명확히 드러나야 한다.
    • passwordAttemptFailedNtimes(int attempts)

이 경우가 아니라면 단항 함수는 피하는 것이 좋다.

✒️ 출력 인수보다 반환값을 써라

StringBuffer transform(StringBuffer in)이 void transform(StringBuffer out)보다 좋다.
설령 전자가 입력 인수를 그대로 돌려주는 함수라 할지라도 변환 함수 형식을 따르는 편이 좋다.
변환 함수에서 출력 인수를 사용하면 혼란을 일으킨다.

 

📌 플래그 인수
  • 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이다.
  • 추하다. 쓰지마라.

 

📌 이항 함수
  • 단항 함수보다 이해하기 어렵다.
  • Point 클래스 처럼 2개 인수 간의 자연적 순서가 있는 경우에는 적절하다. (Point p = new Point(x,y))
  • assertEquals(expected, actual)처럼 expected 인수에 actual 값을 집어넣는 실수가 얼마나 많은지 짐작할 수 없는, 자연스럽지 않고 인위적으로 순서를 기억해야 하는 이항 연산은 나쁘다.
  • 이항 함수가 무조건 나쁘다는 건 아니지만 바꾸도록 애써야 한다.

 

📌 삼항 함수
  • 순서, 주춤, 무시로 야기되는 문제가 두 배 이상 늘어난다.
  • 사용할 가치가 충분하다면 사용해도 좋지만, 그럼에도 사용자들이 주춤거리는 것은 어쩔 수 없다.
    • assertEquals(message, expected, actual) → assertEquals(1.0, amount, .001)
    • 위 예씨는 쓸만한 가치가 충분하다.

 

📌 인수 객체
  • 인수가 2-3개 필요하다면 일부를 독자적 클래릇 변수로 선언할 가능성을 짚어봐라.
  • makeCircle(double x, double y, double radius) → makeCircle(Point center, double radius)

 

📌 인수 목록
String.format("%s worked %.2f hours.", name, hours);
  • String.format 같은 함수들처럼 가변 인수가 들어가는 경우가 있다.
public String format(String format, Object... args)
  • String.format은 사실상 이항 함수가 된다.

 

📌 동사와 키워드
  • 단항 함수 : 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
    • write(name)은 누구나 곧바로 이해한다.
    • writeField(name)이 좀 더 나은 이름이다.
  • 함수 이름에 키워드를 추가하는 방식
    • assertEquals보다 assertExpectedEqualsActual(expected, actual)가 좋다.
    • 인수 순서를 기억할 필요가 없어진다.

 

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

 

💡 부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까
  • 예상치 못하게 클래스 변수를 수정하고, 함수로 넘어온 인수나 시스템 전역 변수를 수정한다.
  • 시간적인 결합(temporal coupling)이나 순서 종속성(order dependency)을 초래한다.

 

아래 코드에서 부수 효과를 일으키는 부분을 찾아보라.

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; 
	}
}
  • Session.initialize()는 cehckPassword 함수에서는 드러나지 않는 세션 초기화 동작을 수행한다.
  • 사용자는 함수 이름만 보고 호출했다가, 사용자 인증을 하면서 기존 세션 정보를 지워버리게 된다.
  • checkPassword 함수는 세션을 초기화해도 괜찮은 경우(특정한 상황)에만 호출이 가능한 시간적인 결합을 초래한다.
  • 시간적 결합이 꼭 필요하다면 checkPasswordAndInitializeSession이라는 이름이 훨씬 좋다. 

 

📌 출력 인수
  • 일반적으로 인수를 함수 입력으로 해석한다. 출력 인수는 되도록 피해라
  • 함수 선언부를 찾아보는 행위는 코드를 보다 주춤하는 행위와 동급으로, 인지적으로 거슬린다는 뜻이다.
  • 객체 지향 언어에서 출력 인수로 사용하라고 설계한 변수가 바로 this다
    • appendFooter(s) 보다는 report.appendFooter()로 호출하는 방식이 좋다.
  • 함수에서 상태를 변경해야 한다면, 함수가 속한 객체 상태를 변경하는 방식을 택하라.

 

8. 명령과 조회를 분리하라!

 

  • 함수는 뭔가를 수행하거나, 뭔가에 답하거나 둘 중 하나만 해야 한다.
public boolean set(String attribute, String value);

... if (set("username", "unclebob")) ...
  • set 기능의 구분이 모호한 이유는 set이라는 단어가 동사인지 형용사인지 분간하기 어려운 탓이다.
  • if 문에 넣고 보면 형용사로 느껴진다.
  • 진짜 해결책은 이름 변경이 아닌, 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법이다.
if (attributeExists("username")) {
    setAttribute("username", "unclebob");
    ...
}

 

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

 

  • 명령 함수에서 오류 코드 반환 방식은 명령/조회 분리 규칙을 미묘하게 위배한다.
  • 자칫하면 if문에서 명령을 표현식으로 사용하기 쉬운 탓이다.
if (deletePage(page) == E_OK)
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 블록 뽑아내기
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());
}
  • try/catch 블록은 원래 추하다.
    • 코드 구조에 혼란을 일으킨다.
    • 정상 동작과 오류 처리 동작을 뒤섞는다.
  • 그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.

 

📌 오류 처리도 한 가지 작업이다.
  • try 키워드가 있다면, 함수는 try문으로 시작해 catch/finally 문으로 끝나야 한다.

 

📌 Error.java 의존석 자석
public enum Error { 
	OK,
	INVALID,
	NO_SUCH,
	LOCKED,
	OUT_OF_RESOURCES, 	
	WAITING_FOR_EVENT;
}
  • 오류 코드를 반환한다는 이야기는 어디선가 오류 코드를 정의한다는 뜻이다.
  • 의존성 자석에 해당하는 클래스를 수정하면 기존 클래스를 전부 컴파일하고 다시 배치해야 한다.
  • 오류 코드 대신 예외를 사용하면, 새 예외는 Exception 클래스에서 파생되므로 컴파일/재배치가 필요 없다.

 

10. 반복하지 마라!

 

  • 중복은 모든 소프트웨어에서 악의 근원이므로, 늘 제거하도록 노력해야 한다.

 

11. 구조적 프로그래밍

 

  • 다익스트라의 구조적 프로그래밍 원칙이란?
    • 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다.
    • 즉, 함수는 return 문이 하나여야 하며, 루프 안에서 break나 continue를 사용해서는 안 된다.
    • goto는 절대로, 절대로 안 된다.
  • 함수가 작다면 위 규칙은 별 이익을 제공하지 못한다. 함수가 아주 클 때만 지켜도 무방하다.
  • 함수가 작다면 return, break, continue를 여러 차례 사용해도 괜찮다.
  • 때로는 단일 입/출구 규칙보다 의도를 표현하기 쉬워진다.

 

12. 함수를 어떻게 짜죠?

 

  1. 처음에는 길고 복잡하고, 들여쓰기 단계도 많고 중복된 루프토 많은 채로 작성하라.
  2. 그 서투른 코드를 빠집없이 테스트 하는 단위 테스트 케이스도 만들어라.
  3. 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거하라. 메서드를 줄이고 순서를 바꾸고 클래스를 쪼개라.
  4. 그 와중에도 코드는 항상 단위 테스트를 통과해야 한다.

처음부터 이 장에서 설명한 규칙을 따르는 함수를 얻을 수 있는 사람은 존재하지 않는다.

저작자표시 비영리

티스토리툴바