[개발서적] Clean Code 3. 함수

[작게 만들어라!]

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

함수가 얼마나 짧아야 하느냐고? 다음 예제를 살펴보자.

 

목록 3-3 HtmlUtil.java

public static String renderPageWithSetupAndTeardowns(
	PageData pagaData, boolean isSuite) throws Exception {
	 if (isTestPage(pageData)) {
		 includeSetupAndTeardownPages(pageData, isSuite);
	 }
		
	 return pagaData.getHtml();
 }

 

처음에 100줄 가까이 되던 코드가 단 10줄 이내로 표현이 된다!

 

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

그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기가 쉬워진다.

 

이 말은 중첩 구조가 생길만큼 함수가 커져서는 안 된다는 뜻이다.

 

[한 가지만 해라!]

목록 3-3은 한 가지만 처리한다. 설정 페이지와 해제 페이지를 테스트 페이지에 넣는다.

다음은 지난 30여년 동안 여러 가지 다양한 표현으로 프로그래머들에게 주어진 충고다.

 

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

 

이 충고에서 문제라면 그 ‘한 가지’가 무엇인지 알기가 어렵다는 점이다. 목록 3-3은 한 가지만 하는가? 세 가지를 한다고 주장할 수도 있다.

1. 페이지가 테스트 페이지인지 판단한다.
2. 그렇다면 설정 페이지와 해제 페이지를 넣는다.
3. 페이지를 HTML로 렌더링한다.

위에서 언급하는 세 단계는 지정된 함수 이름 아래에서 추상화 수준이 하나다.

 

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

함수가 ‘한 가지’만 하는지 판단하는 방법이 하나 더 있다.

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

 

하나 더 예제를 살펴보자.

 

목록 4-7 GeneratePrimes.java

import java.util.*;

public class GeneratePrimes {
	public static int[] generatePrimes(int maxValue) {
     if (maxValue >= 2) {
        // 선언
        int s = maxValue + 1;
        boolean[] f = new boolean[s];
        int i;

        // 배열을 참으로 초기화
        for (i = 0; i < s; i++) {
            f[i] = true;
        }

        // 소수가 아닌 알려진 숫자를 제거
        f[0] = f[1] = false;

        // 체
        int j;

        ...

     }
  }
}

 

generatePrimes 함수는 declarations, initializations, sieve 라는 세 섹션으로 나눠진다.

 

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

 

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

함수가 확실히 ‘한 가지’ 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다. 목록 3-1은 이 규칙을 확실히 위반한다.

 

getHtml()은 추상화 수준이 아주 높다. 반면, String pagePathName = PathParser.render(pagepath); 는 추상화 수준이 중간이다. 그리고 .append(”\n”) 와 같은 코드는 추상화 수준이 아주 낮다.

 

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

 

근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.

 

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

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

 

즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. 이것이 바로 내려가기 규칙이다.

하지만 추상화 수준이 하나인 함수를 구현하기란 쉽지 않다. 그렇지만 매우 중요한 규칙이다. 핵심은 짧으면서도 ‘한 가지’만 하는 함수다.

 

[Switch 문]

swtich문은 작게 만들기 어렵다. 본질적으로 swtich 문은 N가지를 처리한다.

만약 다형성을 이용한다면 각 swtich 문을 저차원 클래스에 숨기고, 절대로 반복하지 않게 할 수 있다.

 

목록 3-4를 살펴보자. 직원 유형에 따라 다른 값을 계산해 반환하는 함수다.

 

목록 3-4 Payroll.java

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

 

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

• 함수가 길다.
  • 새 직원 유형을 추가하면 더 길어진다.
• ‘한 가지’ 작업만 수행하지 않는다.
• SRP를 위반한다.
  • 코드를 변경할 이유가 여럿이기 때문이다.
• OCP를 위반한다.
  • 새 직원 유형을 추가할 때마다 코드를 변경하기 때문이다.

 

하지만 가장 심각한 문제라면 위 함수와 구조가 동일한 함수가 무한정 존재한다는 사실이다!

• isPayday(Employee e, Date data);
• deliverPay(Employee e, Money pay);

가능성은 무한하다. 그리고 모두가 똑같이 유해한 구조다.

 

그럼 다음 예제를 보자.

 

목록 3-5 Employee and Factory

public abstract class Employee {
	public abstract boolean isPayDay();
	public abstract Money calculatePay();
	public void deleverPay(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 SalariedEmployee(r);
		default:
			throw new IvalidEmployeeType(r.type);
		}
	}
}

 

목록 3-5는 switch 문을 추상 팩토리 ABSTRACT FACTORY 에 꽁꽁 숨긴다. 아무에게도 보여주지 않는다.

 

팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다.

calculatePay, isPayDay, deleverPay 등과 같은 함수는 Employee 인터페이스를 거쳐 호출된다.

그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.

 

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

목록 3-7에서 나는 예제 함수 이름을 testableHtml 에서 SetupTeardownIncluder.render로 변경했다.

함수가 하는 일을 좀 더 잘 표현하므로 훨씬 좋은 이름이다.

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

 

서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.

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

 

다음 예가 내가 말한 좋은 예다.

• includeSetupAndTeardownPages
• includeSetupPages
• includeSuiteSetupPages
• includeSetupPage

 

[함수 인수]

함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상부터는 피하는 것이 좋다.

 

인수는 어렵다. 인수는 개념을 어렵게 만든다. 함수에 인수가 있다면 코드를 읽는 사람이 계속해서 그 인수가 나올 때마다 의미를 해석해야 한다.

 

테스트 관점에서 보면 인수는 더 어렵다. 갖가지 인수 조합으로 함수를 집중하는 테스트 케이스를 작성한다고 상상해보라! 인수가 없다면 간단하다.

 

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

 

많이 쓰는 단항 형식

함수에 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지다.

• 인수에 질문을 던지는 경우다.
  • boolean fileExists(”MyFile”) 이 좋은 예다.
• 인수를 뭔가로 변환해 결과를 반환하는 경우다.
  • InputStream fildOpen(”MyFile”)은 String 형의 파일 이름을 InputStream으로 변환한다.

다소 드물게 사용하지만 그래도 아주 유용한 단항 함수 형식이 이벤트다. 이벤트 함수는 입력 인수만 있고 출력 인수는 없다. passwordAttemptFailedNtimes(int attempts)가 좋은 예다.

지금까지 설명한 경우가 아니라면 단항 함수는 가급적 피한다.

 

플래그 인수

플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다.

 

이항 함수

인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.

예를 들어, writeField(name)는 writeField(outputStream, name)보다 이해하기 쉽다.

둘 다 의미는 명백하지만, 전자가 더 쉽게 읽히고 더 빨리 이해된다.

 

물론 이항 함수가 적절한 경우다 있다.

Point p = new Point(0, 0)가 좋은 예다.

직교 좌표계 점은 일반적으로 인수 2개를 취한다. 또한 두 요소는 자연적인 순서도 있다(x 좌표계, y 좌표계)

 

이항 함수가 무조건 나쁘다는 소리는 아니다. 프로그램을 짜다보면 불가피한 경우도 생긴다.

 

하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다. 예를 들어 outputStream 클래스 구성원으로 만들어 outputStream.writeField(name)으로 호출한다.

 

삼함 항수

인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 순서, 주춤, 무시로 야기되는 문제가 두 배 이상 늘어난다.

예를 들어, assertEquals(message, expected, actual)이란느 함수를 살펴보자. 첫 인수가 expected라고 예상하지 않았는가?

 

나는 수없이 멈칫하고 주춤했다.

 

인수 객체

인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.

 

다음 예제를 살펴보자.

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

 

객체를 생성해 인수를 줄이는 방법이 눈속임이라 여겨질지 모르지만 그렇지 않다.

위 예제에서 x와 y를 묶었듯이 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.

 

동사와 키워드

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

단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. 예를 들어 write(name)은 누구나 이해한다.

좀 더 나은 이름은 writeField(name)이다.

 

마지막 예제는 함수 이름에 키워드를 추가하는 형식이다. 즉, 함수 이름에 인수 이름을 넣는다.

예를 들어, assertEquals 보다는 assertExpectedEqualsActual(expected, actual)이 더 좋다.

그러면 인수 순서를 기억할 필요가 없어진다.

 

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

부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까.

 

예를 들어

• 예상치 못하게 클래스 변수를 수정
• 함수로 넘어온 인수나 시스템 변수를 수정

 

어느쪽이든 교활하고 해로운 거짓말이다. 많은 경우 시간적인 결합이나 순서 종속성을 초래한다.

 

목록 3-6을 살펴보자.

 

목록 3-6 UserValidator.java

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 = crypthgrapher.decrypt(codedPhrase, password);
			
			if ("Valid Password".equals(phrase)) {
				Session.initialize();
				
				return true;
			}
		}
		return false;
	}
}

 

여기서, 함수가 일으키는 부수 효과는 Session.initialize() 호출이다. checkPassword 함수는 이름 그대로 암호를 확인한다.

이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다!

 

그래서 함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다.

 

이런 부수 효과가 시간적인 결합을 초래한다. 즉, checkPassword 함수는 특정 상황에서만 호출이 가능하다. 다시 말해, 세션을 초기화해도 괜찮은 경우에만 호출이 가능하다.

 

따라서 목록 3-6은 checkPasswordAndInitializeSession 이라는 이름이 훨씬 좋다. 물론 함수가 ‘한 가지’만 한다는 규칙을 위반하지만…

 

출력 인수

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

어느 정도 프로그래밍 경력이 쌓였다면 인수를 출력으로 사용하는 함수에 어색함을 느끼리라. 예를 들어

 

appendFooter(s);

 

 

인수 s는 입력일까 출력일까? 함수 선언부를 찾아보면 분명해진다.

public void appendFooter(StringBuffer report)

 

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

 

객체 지향 프로그래밍이 나오기 전에는 출력 인수가 불가피한 경우도 있었다.

하지만 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다.

출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다. 따라서 다음과 같이 호출해주는 방식이 더 좋다.

report.appendFooter();

 

일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

 

[명령과 조회를 분리하라!]

함수가 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘 다 하면 안 된다.

객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.

 

둘 다 하면 혼란을 초래한다. 다음 함수를 살펴보자.

public boolean set(String attribute, String value)

 

이 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후, 성공하면 true를, 실패하면 false를 반환한다. 그래서 다음과 같은 괴상한 코드가 나올 수 있다.

if (set("username","unclebob"))...

 

독자 입장에서 코드를 읽어보자. 무슨 뜻일까?

‘username’이 ‘unclebob’으로 설정되어 있는지 확인하는 코드인가? 아니면 “username”을 ‘unclebob’으로 설정하는 코드인가?

 

함수를 호출하는 코드만 봐서는 의미가 모호하다.

 

그래서 다음과 같이 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법이 있다.

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

 

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.

 

자칫하면 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) {
			...
		}
	}
}

 

반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

 

try {
	deletePage(page);
	registry.deleteReference(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);
	}
}

---

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

 

위에서 delete 함수는 모든 오류를 처리한다. 그래서 코드를 이해하기 쉽다.

 

실제로 페이지를 제거하는 함수는 deletePageAndAllReferences다.

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

 

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

함수는 ‘한 가지’ 작업만 해야 한다. 오류 처리도 ‘한 가지’ 작업에 속한다.

그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다.

 

따라서 함수에 키워드 try가 있다면 함수는 try 문으로 시작해 catch/finally 문으로 끝나야 한다는 말이다.

 

[반복하지 마라!]

어쩌면 중복은 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다. 예를 들어,

• E.F. 커드는 자료에서 중복을 제거할 목적으로 관계형 데이터베이스에 정규 형식을 만들었다.
• 객체지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다.
• 구조적 프로그래밍, AOP 모두 어떤 면에서 중복 제거 전략이다.

하위 루틴을 발명한 이래로 소프트웨어 개발에서 지금까지 일어난 혁신은 소스 코드에서 중복을 제거하려는 지속적인 노력으로 보인다.

 

[구조적 프로그래밍]

어떤 프로그래머는 에츠허르 데이크스트라의 구조적 프로그래밍 원칙을 따른다.

데이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구는 하나만 존재해야 한다고 말했다.

즉, 함수는 return 문이 하나여야 한다는 말이다. 루프 안에서 break 나 continue 를 사용해선 안 되며, goto는 절대로 안 된다.

 

사실, 함수가 작다면 위 규칙은 별 이익을 제공하지 못한다. 함수가 아주 클 때만 상당한 이익을 제공한다.

 

[함수를 어떻게 짜죠?]

소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다. 논문이나 기사를 작성할 때는 먼저 생각을 기록한 후 읽기 좋게 다듬는다.

 

함수를 짜는 행위도 마찬가지다. 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다.

이름은 즉흥적이고, 코드는 중복된다. 하지만 나는 그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.

 

그런 다음 나는 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다.

때로는 전체 클래스를 쪼개기도 한다. 이 와중에도 코드는 항상 단위 테스트를 통과한다.

 

[결론]

프로그래밍의 기술은 언제나 언어 설계의 기술이다. 예전에도 그랬고, 지금도 마찬가지다.

대가 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이야기로 여긴다. 시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 바로 그 언어에 속한다.

 

여기서 나온 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라. 하지만 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하길 바란다.