계속 수정됩니다.
어떤 프로그램이든 가장 기본적인 단위가 함수다.
FitNesse: 오픈 소스 테스트 도구
이해하기 어려운 코드
- 추상화 수준이 다양하다.
- 코드가 너무 길다.
- 두 겹으로 중첩된 if 문은 이상한 플래그를 확인한다.
- 이상한 문자열을 사용한다.
- 이상한 함수를 호출한다.
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();
includesteupPages(testPage, newPageContent, isSuite);
newPageContent.append(pageData.getContent());
includeTeardownPages(testPage, newPageContent, isSuite);
pageData.setContent(newPageContent.toString());
}
return pageData.getHtml();
}FitNesse에 익숙하지 않으면 100% 이해하기는 어렵지만,
그래도 함수가 설정(setup) 페이지와 해제(teardown) 페이지를 테스트 페이지에 넣은 후 해당 테스트 페이지를 HTML로 렌더링한다는 사실은 짐작할 수 있다.
JUnit: 오픈 소스 단위 테스트 도구
작게 만들어라!
함수를 만드는 규칙
1. '작게!' 만들어라
2. '더 작게!' 만들어라
함수는 작을 수록 좋다.
위의 코드를 다음과 같이 줄여야 마땅하다.
public static String renderPageWithSetupsAndTeardowns(
PageData pageData, boolean isSuite) throws Exception {
if (isTestPage(pageData))
includeSetupAndTeardownPages(pageData, isSuite);
return pageData.getHtml();
}블록과 들여쓰기
if 문/else 문/while 문 등에 들어가는 블록은 한 줄이어야 한다. 대개 거기서 함수를 호출한다.
바깥을 감싸는 함수(enclosing function)가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면 코드를 이해하기 쉬워진다.
중첩 구조가 생길만큼 함수가 커져서는 안 된다는 뜻이다.
함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.
한 가지만 해라!
함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
TO: LOGO 언어에서 사용하는 키워드 'TO'는 루비나 파이썬에서 사용하는 'def'와 똑같다. LOGO에서 모든 함수는 키워드 'to'로 시작한다. 이는 함수를 설계하는 방식에 흥미로운 영향을 미쳤다.
지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.
함수가 '한 가지'만 하는지 판단하는 방법이 하나 더 있다.
단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.
함수 당 추상화 수준은 하나로!
함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
getHtml()위와 같은 코드는 추상화 수준이 아주 높다.
String pagePathName = PathParser.render(pagepath);반면, 위와 같은 코드는 추상화 수준이 중간이다.
.append("\n")그리고, 위와 같은 코드는 추상화 수준이 아주 낮다.
한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.
특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다.
위에서 아래로 코드 읽기: 내려가기 규칙
코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.
이것을 내려가기 규칙이라 부른다.
다르게 표현하면, 일련의 TO 문단을 읽듯이 프로그램이 읽혀야 한다는 의미다.
TO 문단: LOGO 키워드인 TO는 영어로 '~하려면'의 의미도 된다.
TO 설정 페이지와 해제 페이지를 포함하려면, 설정 페이지를 포함하고, 테스트 페이지 내용을 포함하고, 해제 페이지를 포함한다.
TO 설정 페이지를 포함하려면, 슈트이면 슈트 설정 페이지를 포함한 후 일반 설정 페이지를 포함한다.
TO 슈트 설정 페이지를 포함하려면, 부모 계층에서 "SuiteSetUp" 페이지를 찾아 include 문과 페이지 경로를 추가한다.
TO 부모 계층을 검색하려면, …
핵심은 짧으면서도 '한 가지'만 하는 함수다.
위에서 아래로 TO 문단을 읽어내려 가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기가 쉬워진다.
Switch 문
switch 문은 작게 만들기 어렵다. (if/else가 여럿 이어지는 구문도 포함)
코드가 길어지고, '한 가지' 작업만 하는 switch 문을 만들기 어렵다.
다형성을 이용하여 각 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 말자.
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);
}
}위 함수의 문제
1. 함수가 길다. 새 직원 유형을 추가하면 더 길어진다.
2. '한 가지' 작업만 수행하지 않는다.
3. SRP(Single Responsibility Principle)를 위반한다. 코드를 변경할 이유가 여럿이기 때문이다.
4. OCP(Open Closed Principle)를 위반한다. 새 직원 유형을 추가할 때마다 코드를 변경하기 때문이다.
다음과 같이 위와 구조가 동일한 함수가 무한정 존재할 수 있다.
isPayday(Employee e, Date date);혹은
deliverPay(Employee e, Money pay);이 문제를 해결하려면 switch 문을 추상 팩토리(ABSTRACT FACTORY)에 꽁꽁 숨기는 것이다.
팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다.
calculatePay, isPayday, deliverPay 등과 같은 함수는 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 COMMISIONED:
return new CommissionedEmployee(r);
case HOURLY:
return new HourlyEmployee(r);
case SALARIED:
return new SalariedEmployee(r);
default:
throw new InvalidEmployeeType(r.type);
}
}
}switch 문을 단 한 번만 참아주자.
다형적 객체를 생성하는 코드 안에서다.
이렇게 상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다.
서술적인 이름을 사용하라!
워드가 말했던 원칙
"코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다."
한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 절반은 달성했다고 할 수 있다.
- 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
- 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
이름을 정하느라 시간을 들여도 괜찮다!
서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.
이름을 붙일 때는 일관성이 있어야 한다.
모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.
includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage, includeSetupPage 등이 좋은 예다.
문체가 비슷하면 이야기를 순차적으로 풀어가기도 쉬워진다.
함수 인수
함수에서 이상적인 인수 개수는 0개(무항)다.
다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다.
4개 이상(다항)은 특별한 이유가 필요하다.
특별한 이유가 있어도 사용하면 안 된다.
includeSetupPageInto(new PageContent) 보다 includeSetupPage()가 이해하기 더 쉽다.
전자는 함수 이름과 인수 사이에 추상화 수준이 다르다.
게다가 코드를 읽는 사람이 현 시점에서 별로 중요하지 않은 세부사항, 즉 StringBuffer를 알아야 한다.
테스트 관점에서 보면 인수는 더 어렵다.
갖가지 인수 조합으로 함수를 검ㅁ증하는 테스트 케이스를 작성한다고 하면 인수가 없을 때 간단하다.
출력 인수는 입력 인수보다 이해하기 어렵다.
최선은 입력 인수가 없는 경우이며, 차선은 입력 인수가 1개뿐인 경우다.
SetupTeardownIncluder.render(pageData)는 이해하기 아주 쉽다.
pageData 객체 내용을 렌더링하겠다는 뜻이다.
많이 쓰는 단항 형식
함수에 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지다.
- 인수에 질문을 던지는 경우
boolean fileExists("MyFile")이 좋은 예다. - 인수를 뭔가로 변환해 결과를 반환하는 경우
InputStream fileOpen("MyFile")은 String 형의 파일 이름을 InputStream으로 변환한다.
함수 이름을 지을 때는 두 경우를 분명히 구분한다.
또한 언제나 일관적인 방식으로 두 형식을 사용한다.
다소 드물게 사용하지만 그래도 아주 유용한 단항 함수 형식이 이벤트다.
이벤트 함수는 출력 인수가 없고 입력 인수만 있다.
프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다.
passwordAttemptFailedNtimes(int attempts)가 좋은 예다.
이벤트라는 사실이 코드에 명확히 드러나야 한다.
플래그 인수
플래그 인수는 추하다.
함수로 부울 값을 넘기는 관례는 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이다.
render(boolean isSuite)보다 renderForSuite()와 renderForSingleTest()라는 함수로 나누는 것이 낫다.
이항 함수
인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
예를 들어, writeField(name)는 writeField(outputStream, name)보다 이해하기 쉽다.
이항 함수가 적절한 경우도 있다. Point p = new Point(0, 0)가 좋은 예다.
직교 좌표계 점은 일반적으로 인수 2개를 취한다. 여기서 인수 2개는 한 값을 표현하는 두 요소다.
두 요소에는 자연적인 순서도 있다.
가능하면 단항 함수로 바꾸도록 애쓰자.
예를 들어, writeField 메서드를 outputStream 클래스 구성원으로 만들어 outputStream.writeField(name)으로 호출한다.
아니면 outputStream을 현재 클래스 구성원 변수로 만들어 인수로 넘기지 않는다.
아니면 FieldWriter라는 새 클래스를 만들어 구성자에서 outputStream을 받고 write 메서드를 구현한다.
삼항 함수
인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다.
반면 assertEquals(1.0, amount, .001)은 그리 음험하지 않은 삼항 함수다.
여전히 주춤하게 되지만 그만한 가치가 충분하다.
부동소수점 비교가 상대적이라는 사실은 언제든 주지할 중요한 사항이다.
인수 객체
인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어보자.
Circle makeCircle(double x, double y, double radius);
Circle makeCircle(Point center, double radius);객체를 생성해 인수를 줄이는 방법이 눈속임이라 여겨질 수 있지만 그렇지 않다.
위 예제에서 x와 y를 묶었듯이 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.
인수 목록
때로는 인수 개수가 가변적인 함수도 필요하다.
String.format 메서드가 좋은 예다.
가변 인수 전부를 동등하게 취급하면 List 형 인수 하나로 취급할 수 있다.
이런 논리로 따져보면 String.format은 사실상 이항 함수다.
동사와 키워드
함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.
단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
예를 들어, write(name)은 누구나 곧바로 이해한다.
좀 더 나은 이름은 writeField(name)이다. 그러면 name이 field라는 사실이 분명히 드러난다.
함수 이름에 키워드를 추가하는 형식도 있다.
함수 이름에 인수 이름을 넣는다. 예를 들어 assertEquals보다 assertExpectedEqualsActual(expected, actual)이 더 좋다.
그러면 인수 순서를 기억할 필요가 없어진다.
부수 효과를 일으키지 마라!
부수 효과는 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓을 한다.
많은 경우 시간적인 결합(temporal coupling)이나 순서 종속성(order dependency)을 초래한다.
부수 효과는 시간적인 결합을 초래한다. 시간적인 결합은 혼란을 초래한다.
부수적인 효과가 필요하다면 함수 이름에 명시하자.
출력 인수
일반적으로 우리는 인수를 함수 입력으로 해석한다.
appendFooter(s);
이 함수는 무언가에 s를 바닥글로 첨부할까?
아니면 s에 바닥글을 첨부할까?
인수 s는 입력일까 출력일까?
함수 선언부를 찾아보면 분명해진다.
public void appendFooter(StringBuffer report)함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다.
인지적으로 거슬린다는 뜻이므로 피해야 한다.
객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다.
출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다.
다시 말해, appendFooter는 report.appendFooter() 와 같이 호출하는 방식이 좋다.
일반적으로 출력 인수는 피해야 한다.
함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
명령과 조회를 분리하라!
함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다.
객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.
public boolean set(String attribute, String value);이 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true를 반환하고 실패하면 false를 반환한다.
그래서 다음과 같이 괴상한 코드가 나온다.
if (set("username", "unclebob"))..."username"이 "unclebob"으로 설정되어 있는지 확인하는 코드인가?
"username"을 "unclebob"으로 설정하는 코드인가?
의미가 모호한다.
setAndCheckIfExists라고 함수 이름을 바꾸는 방법도 있지만
if 문에 넣고 보면 여전히 어색하다.
진짜 해결책은 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법이다.
if (attributeExists("username")) {
setATtribute("username", "unclebob");
...
}오류 코드보다 예외를 사용하라!
명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.
자칫하면 if 문에서 명령을 표현식으로 사용하기 쉬운 탓이다.
if (DeletePage(page) == E_OK)위 코드는 여러 단계로 중첩되는 코드를 야기한다.
오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.
반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.
try {
deletePage(page);
registry.delteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
}
catch (Exception e) {
logger.log(e.getMessage());
}Try/Catch 블록 뽑아내기
try/catch 블록은 원래 추하다.
그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.
public void delete(Page page) {
try {
deletePageAndAllReferences(page);
}
catch (Exception e) {
logError(e);
}
}실제로 페이지를 제거하는 함수는 deletePageAndAllReferences다.
이 함수는 예외를 처리하지 않는다.
이렇게 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.
오류 처리도 한 가지 작업이다.
함수는 '한 가지' 작업만 해야 한다.
오류 처리도 '한 가지' 작업이다.
그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다.
함수에 키워드 try가 있다면 함수는 try 문으로 시작해 catch/finally 문으로 끝나야 한다는 말이다.
Error.java 의존성 자석
오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.
public enum Error {
OK,
LOCKED,
WAITING_FOR_EVENT
}위와 같은 클래스는 의존성 자석이다.
다른 클래스에서 Error enum을 import해 사용해야 하므로,
Error enum이 변한다면 이를 사용하는 클래스 전부를 재컴파일, 재배치해야 한다.
그래서 Error 클래스 변경이 어려워진다.
오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다.
따라서 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다.
OCP를 보여주는 예다.
OCP: 기존의 코드를 변경하지 않으면서 기능을 추가할 수 있도록 설계가 되어야 한다.
반복하지 마라!
중복은 문제다.
코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 네 곳이나 손봐야 한다.
게다가 어느 한곳이라도 빠뜨린다면 오류가 발생할 확률이 네 배나 높다.
include 방법으로 중복을 없앨 수 있다.
AOP(Aspect Oriented Programming): 어떤 로직을 기준으로 핵심적인 관점, 부가적인 관점으로 나누어서 보고 그 관점을 기준으로 각각 모듈화하자.
COP(Component Oriented Programming): 기존의 시스템이나 소프트웨어를 구성하는 컴포넌트를 조립해서 하나의 새로운 응용 프로그램을 만드는 소프트웨어 개발방법론
구조적 프로그래밍
에츠허르 데이크스트라Edsger Dijkstra 는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다.
즉, 함수는 return 문이 하나여야 한다는 말이다.
루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로, 절대로 안 된다.
구조적 프로그래밍의 목표와 규율은 좋지만, 함수가 작다면 위 규칙은 별 이익을 제공하지 못한다.
함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다.
오히려 때로는 단일 입/출구 규칙single entry-exit rule 보다 의도를 표현하기 쉬워진다.
반면, goto 문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야만 한다.
함수를 어떻게 짜죠?
처음에는 길고 복잡한다.
들여쓰기 단계도 많고 중복된 루프도 많다.
인수 목록도 아주 길다.
이름은 즉흥적이고 코드는 중복된다.
하지만 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다.
메서드를 줄이고 순서를 바꾼다.
때로는 전체 클래스를 쪼개기도 한다.
이 와중에도 코드는 항상 단위 테스트를 통과한다.
최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다.
처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없을거다.
결론
모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한 도메인 특화 언어 Domain Specific Language, DSL 로 만들어진다.
Master 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이야기로 여긴다.
프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.
시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 바로 그 언어에 속한다.
각 동작은 바로 그 도메인에 트고하된 언어를 사용해 자신만의 이야기를 풀어간다.
여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라.
하지만 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다.
내가 작성한 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다는 사실을 명심하자.
참고 문헌
[KP78]: Kernighan and Plaugher, The Elements of Programming Style, 2d, ed., McGraw-Hill, 1978.
[PPP02]: Agile Software Devlopment: Principles, Patterns, and Practices, Robert C. Martin, Prentice Hall, 2002. 『소프트웨어 개발의 지혜: 원칙, 디자인패턴, 실천방법』(2004 야스미디어, 이용원 옮김)
[GOF]: Design Patterns: Elements of Reusable Object Oriented Software, Gammaet al.,Addison-Wesley, 1996. 『GOF의 디자인 패턴(개정판)』(2007 피어슨에듀케이션코리아, 김정아 옮김)
[PRAG]: The Pragmatic Programmer, Andrew Hunt, Dave Thomas, Addison-Wesley, 2000. 『실용주의 프로그래머』(2006 인사이트, 김창준 정지호 옮김)
[SP72]: Structured Programming, O.-J. Dahl, E. W. Eijkstra, C. A. R. Hoare, Academic Press, London, 1972.
