[Clean Code] 3. 함수

 

작게 만들어라!

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

 

<블록과 들여쓰기>

if문, while문 등에 들어가는 블록은 한 줄이어야 한다. 대개 여기서 함수를 호출한다.

블록 안에서 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.

그러므로 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.

 

한 가지만 해라!

함수는 한 가지만을 해야 한다. 여기서 그 '한 가지'는 어떻게 알 수 있을까?

지정된 함수 이름 아래 추상화 수준이 하나이면 된다. 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

 

<함수 내 섹션>

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

 

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

한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지 세부사항인지 구분하기 어려운 탓이다.

근본 개념과 세부사항을 뒤섞기 시작하면, 함수에 세부사항이 점점 더 추가된다.

 

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

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

핵심은 짧으면서도 '한 가지'만 하는 함수다. 위에서 아래로 읽어내려 가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기가 쉬워진다.

 

Switch 문

switch 문은 작게 만들기 어렵다. 또한 '한 가지' 작업만 하는 switch 문도 만들기 어렵다. 본질적으로 switch 문은 N가지를 처리한다.

하지만 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다. 물론 다형성을 이용한다.

다음은 직원 유형에 따라 다른 값을 계산해 반환하는 함수다.

public Money caculate(Employee e) throws InvalidEmployeeType {
	switch(e.type) {
    	case COMMISSIONED:
        	return caculateCommissionedPay(e);
        case HOURLY:
        	return caculateHourlyPay(e);
        case SALARIED:
        	return caculateSalariedPay(e);
        default:
        	thorw new InvalidEmployeeType(e.type);
    }
}

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

첫째, 함수가 길다. 새 직원 유형을 추가하면 더 길어진다.

둘째, '한 가지' 작업만 수행하지 않는다.

셋째, SRP를 위반한다. 코드를 변경할 이유가 여럿이다.

넷째, OCP를 위반한다. 새 직원을 추가할 때마다 코드를 변경하기 때문이다.

하지만 아마 가장 심각한 문제라면 위 함수와 구조가 동일한 함수가 무한정 존재한다는 사실이다. 예를 들어, 다음과 같은 함수가 가능하다.

isPayday(Employee e, Date date); 혹은 deliveryPay(Employee e, Money pay); 이 있다.

그리고 모두가 똑같이 유해한 구조다. 이 문제를 해결한 코드를 보자.

public abstract class Employee {
	public abstract boolean isPayday();
	public abstract Money caculatePay();
	public abstract void deliveryPay(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 파생 클래스의 인스턴스를 생성한다.

caculatePay, isPayday, deliveryPay 등과 같은 함수는 Employee 추상 클래스를 거쳐 호출된다. 그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.

 

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

워드 - '코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.'

한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 달성함에 있어 이미 절반은 성공했다.

이름이 길어도 괜찮다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.

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

 

함수 인수

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

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

출력 인수는 입력 인수보다 이해하기 어렵다. 흔히 우리는 함수에다 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙하다. 대개 함수에서 인수로 결과를 받으리라 기대하지 않는다.

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

 

<많이 쓰는 단항 형식>

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

하나는 인수에 질문을 던지는 경우다. boolean fileExists("MyFile")이 좋은 예다.

다른 하나는 인수를 뭔가로 변환해 결과를 반환하는 경우다. InputStream fileOpen("MyFile")은 String 형의 파일 이름을 InputStream으로 변환한다.

다소 드물게 사용하지만 이벤트 함수에서 단항 형식을 사용한다. 이벤트 함수는 입력 인수만 있고 출력 인수는 없다. 프로그램은 입력 인수로 시스템 상태를 바꾼다. passwordAttemptFailedNtimes(int attemps)가 좋은 예다.

특히, 입력 인수를 변환하는 함수라면 변환 결과는 반환값으로 돌려준다. StringBuffer transform(StringBuffer in)이 void transform(StringBuffer out)보다 좋다. 입력 인수를 그대로 돌려준다 할지라도 변환 함수 형식을 따르는 편이 좋다.

 

<플래그 인수>

플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 왜냐고? 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까! 플래그가 참이면 이걸 하고 거짓이면 저걸 한다는 말이니까!

render(boolean isSuite)보다는 renderForSuite()와 renderForSingleTest()로 나눠야 마땅하다.

 

<이항 함수>

이항 함수는 단항 함수보다 이해하기 어렵다. writeField(name)은 writeField(outputStream, name)보다 이해하기 쉽다.

이항 함수가 적절한 경우도 있다. Point p = new Point(0, 0)가 좋은 예다. 하지만 인수 2개는 한 값을 표현하는 두 요소다. outputStream과 name은 한 값을 표현하지 않는다.

심지어 assertEquals(expected, actual)에도 문제가 있다. expected에 actual 값을 집어넣는 실수가 얼마나 많던가? 두 인수는 자연적인 순서가 없다. 인위적으로 기억해야 한다.

이항 함수가 무조건 나쁘다는건 아니다. 그러나 단항 함수로 바꾸도록 애써야 한다. writeField 메서드를 outputStream 클래스 구성원으로 만들어 outputStream.writeField(name)으로 호출한다. 아니면 outputStream을 현재 클래스 구성원 변수로 만들어 인수로 넘기지 않는다.

 

<삼항 함수>

삼항 함수는 이항 함수보다 훨씬 더 이해하기 어렵다.

assertEquals(message, expected, actual)이라는 함수는 매번 볼 때마다 주춤한다.

 

<인수 객체>

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

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

 

<인수 목록>

때로는 인수 개수가 가변적인 함수도 필요하다. String.format 메서드가 좋은 예다.

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

위 예제처럼 가변 인수 전부를 동등하게 취급하면 List 형 인수 하나로 취급할 수 있다. 그래서 String.format은 사실상 이항 함수다.

 

<동사와 키워드>

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

단항 함수는 인수가 동사/명사 쌍을 이뤄야 한다. write(name)은 누구나 곧바로 이해한다. '이름'을 '쓴다'는 뜻이다.

좀 더 나은 이름은 writeField(name)이다. 그러면 '이름'이 '필드'라는 사실이 분명히 드러난다.

다음은 함수 이름에 키워드를 추가하는 형식이다. 즉, 함수 이름에 인수 이름을 넣는다. 

assertEquals보다 assertExpectedEqualsActual(expected, actual)이 더 좋다. 그러면 인수 순서를 기억할 필요가 없어진다.

 

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

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

아래 코드를 살펴보자. 함수는 userName과 password를 확인한다. 두 인수가 올바르면 true를 반환하고 아니면 false를 반환한다.

하지만 함수는 부수 효과를 일으킨다. 보이는가?

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() 호출이다. checkPassword 함수는 이름 그대로 암호를 확인한다. 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다. 그래서 함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다. 즉, checkPassword 함수는 세션을 초기화해도 괜찮은 경우에만 호출이 가능하다. 필요하다면 함수 이름을 checkPasswordAndInitializeSession이라고 하는 것이 훨씬 좋다. 물론 함수가 '한 가지'만 한다는 규칙을 위반하지만.

 

<출력 인수>

일반적으로 우리는 인수를 함수 입력으로 해석한다. 그러나 다음 함수를 보자.

appendFooter(s);

이 함수는 무언가에 s를 바닥글로 첨부할까? 아니면 s에 바닥글을 첨부할까? 인수 s는 입력일까 출력일까? 함수 선언부를 찾아보자.

public void appendFooter(StringBuffer report);

이제 인수 s가 출력 인수라는 사실이 분명해졌다. report의 바닥글을 첨부하는 것이다. 하지만 함수의 선언부를 찾아보고 나서야 알았다. 함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다.

객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다. 출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다. appendFooter는 다음과 같이 호출하는 방식이 좋다.

report.appendFooter();

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

 

명령과 조회를 분리하라!

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

public boolean set(String attribute, String value);

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

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

무슨 뜻일까? "username"이 "unclebob"으로 설정되어 있는지 확인하는 코드인가? 아니면 "username"을 "unclebob"으로 설정하는 코드인가? 의미가 모호하다.

set이라는 함수 이름을 setAndCheckIfExists라고 바꾸는 방법도 있지만 if문에 넣고 보면 여전히 어색하다. 진짜 해결책은 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법이다.

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

 

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

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

if (deletePage(page) == 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());
}

delete 함수는 모든 오류를 처리한다. 실제로 페이지를 제거하는 함수는 deletePageAllReferences다.

 

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

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

위 예제처럼 함수에 키워드 try가 있다면 catch/finally 문으로 끝나야 한다는 말이다.

 

<Error.java 의존성 자석>

오류 코드를 반환한다는 이야기는, 어디선가 오류 코드를 정의한다는 뜻이다.

public enum Error {
    OK,
    INVALID,
    NO_SUCH,
    LOCKED,
    OUT_OF_RESOURCES,
    WAITING_FOR_EVENT
}

위와 같은 클래스는 의존성 자석이다. 다른 클래스에서 Error enum을 import하므로, Error enum이 변환다면 이를 사용하는 클래스 전부를 다시 컴파일해야 한다.

오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다. 따라서 재컴파일 없이도 새 예외 클래스를 추가할 수 있다.

 

반복하지 마라!

중복은 소프트웨어에서 모든 악의 근원이다. 소프트웨어 개발에서 지금까지 일어난 혁신은 소스 코드 중복을 제거하려는 지속적인 노력이다.

 

구조적 프로그래밍

데이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다. 즉, 함수는 return 문이 하나여야 하고 루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로 안 된다.

구조적 프로그래밍의 목표와 규율은 공감하지만 함수가 작다면 위 규칙은 별 이익을 제공하지 못한다. 그러므로 함수를 작게 만든다면 return, break, continue를 여러 차례 사용해도 괜찮다. 단, goto는 피하자.

 

함수를 어떻게 짜죠?

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

그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 이 와중에도 코드는 항상 단위 테스트를 통과한다.

이처럼 처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.

 

결론

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

우리가 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어나가기 쉬워진다는 사실을 기억하자.