[배우기] - 함수

김주형·2022년 11월 14일

자라기

목록 보기

7/22

🙇🏻‍♂️Reference

Clean Code

작게 만들어라

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

그렇다면 얼마나 짧아야 좋을까?

함수가 읽기 쉽고 이해하기 쉬운 이유가 있다면, 무엇일까?
의도를 분명히 표현하는 함수를 어떻게 구현할 수 있을까?
함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까?

public static String renderPageWithSetupsAndTeardonws{
	PageData pageData, boolean isSuite{ throws Exception {
    boolean is TestPage = pageData.hasAttribute("Test");
    if (isTestPage) {
    
    // 핵심 로직
      ...
      ...
      ...
      ...
    }
    return pageData.getHtml();
}

"중첩 구조가 생길만큼 함수가 커져서는 안 된다."

if문 /else문 /whihe 문 등에 들어가는 블록은 한 줄이어야 한다.

대개 거기서 함수를 호출한다.

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

함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다. 그래야 함수는 읽고 이해하기 쉬워진다.

한 가지만 해라!

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

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

여러 가지를 처리하느라 아주 바쁜 함수x, 한 가지만 처리하는 함수 o

지정된 함수 이름 아래에서 추상화 수준이 하나인 것을 의미한다.

지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.
함수의 존재 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위함이기 때문
의미를 유지하면서 더 이상 줄이는 것이 불가능할 때까지 추상화 수준을 분리하라
함수가 '한 가지'만 하는지 판단하는 법 : 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈

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

함수가 확실히 '한 가지' 작업만 하려면 모든 문장의 추상화 수준이 동일해야 한다.
한 함수 내에 추상화 수준으 ㄹ섞으면 코드를 읽는 사람이 헷갈린다.
- 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓
- 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 누군가가 함수에 세부사항을 점점 더 추가한다.

내려가기 규칙

위에서 아래로 코드 읽기

코드는 위에서 아래로 이야기처럼 읽혀야 좋다.

한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.

위에서 아래로 프로그램을 익으면 함수 추상화 수준이 한 번에 한 단계식 낮아진다.

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

Switch문

본질적으로 switch 문은 n가지를 처리한다.
불행하게도 switch 문을 완전히 피할 방법은 없다고 한다.
하지만 각 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다.

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

문제점

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

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

SRP 위반 : 코드를 변경할 이유가 여럿이기 때문

OCP 위반 : 새 직원 유형을 추가할 때마다 코드를 변경하기 때문

구조가 동일한 함수가 무한정 존재한다.

해결하기 : 추상 팩토리

switch 문을 abstract factory에 꽁꽁 숨긴다. 아무에게도 보여주지 않는다. 팩토리는 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 Invalid EmployeeType {
    
    switch (r.type) {
        	case COMMISSIONED:
            	return new CommisionedEmployee(r);
            case HOUTLY:
                return calculateHourlyPay(e);
            case SALARIED:
            	return new SalariedEmployee(r);
            default :
            	throw new InvalidEmplyeeType(r.type); 
    }
}

상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다.

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

함수가 하는 일을 좀 더 잘 표현하기 위해
좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않다.
- 개인적으로 간추리고 요약하는 것은 내부적인 해결 방법을 더 명확하고 훤하게 드러내기 때문이 아닐까라고 생각한다.
"코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다."
이름이 길어도 괜찮다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.
이름을 붙일 때는 일관성이 있어야 한다.
모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다. 문제가 비슷하면 이야기를 순차적으로 풀어가기도 쉬워진다.

함수 인수

함수에서 이상적인 인수 개수는 무항(0개)이다. 다음은 단항(1개), 이항(2개).. 3개는 가능한 피하는 편이 좋고 4개 이상은 특별한 이유가 있어도 사용하면 안 된다.
인수는 개념을 이해하기 어렵게 만들기 때문이다. 코드를 읽는 사람이 인수를 발견할 때마다 의미를 해석해야 하기 때문이다.
- includeSetupPageInto(new PageContent) 보다
  includeSetupPage()가 이해하기 더 쉽다.

includeSetupPageInto(new PageContent)는 함수 이름과 인수 사이에 추상화 수준이 다르다.
게다가 코드를 읽는 사람이 현 시점에서 별로 중요하지 않은 세부사항을 알아야 한다.
테스트 관점에서 보면 더 어렵다. 갖가지 인수 조합으로 함수를 검증하는 테스트 케이스를 작성한다고 작성해보라..

인수가 없다면 간단하다.

출력 인수는 입력 인수보다 이해하기 어렵다.
흔히 우리는 함수에다 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙하다.
대개 함수에서 인수로 결과를 받으리라 기대하지 않는다.
그래서 출력 인수는 독자가 허둥지둥 코드를 재차 확인하게 만든다.

많이 쓰는 단항 형식

인수에 질문을 던지는 경우, 인수를 뭔가로 변환해 결과를 반환하는 경우
함수 이름을 지을 때는 두 경우를 분명히 구분하고 도한 언제나 일관적인 방식으로 두 형식을 사용한다.

그래도 아주 융용한 단항 함수 형식이 이벤트이다.

입력 인수만 있고, 출력 인수는 없음
이벤트라는 사실이 코드에 명확히 드러나야 한다. 이름과 문맥을 주의해서 선택한다.

플래그 인수

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

이항 함수

인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
이항 함수가 무조건 나쁘다는 소리가 아니라 프로그램을 짜다보면 불가피한 경우도 있지만, 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다.

삼항 함수

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

인수 객체

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

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

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

인수 목록

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

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

가변 인수 전부를 동등하게 취급하면 List 형 인수 하나로 취급할 수 있다.
이런 논리로 따져보면 String.format은 사실상 이항 함수다.
가변 인수를 취하는 모든 함수에 같은 원리가 적용된다. 단항, 이항, 삼항 함수로 취급할 수 있다.
하지만 이를 넘어서는 인수를 사용할 경우에는 문제가 있다.

동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.
단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
- write(name)은 누구나 이해한다. 좀 더 나은 이름은 writeField(name)
함수 이름에 키워드를 추가하는 형식 : 함수 이름에 인수 이름을 넣는다.
- assertEquals보다 assertExpectedEqualsActual(expected, actual)이 더 좋다.

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

부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까.
많은 경우 시간적인 결합이나 순서 종속성을 초래한다.
- 때로는 예상치 못하게 클래스 변수를 수정
- 때로는 함수로 넘어온 인수나 시스템 전역 변수를 수정
- 어느 쪽이든 교활하고 해로운 거짓말이다.

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

함수가 일으키는 부수 효과는 Session.initialize() 호출
이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다.
함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다.
- 시간적인 결합 초래 -> 혼란
- 부수 효과로 숨겨진 경우에는 혼란이 커진다.
세션을 초기화해도 괜찮은 경우에만 호출이 가능하다. 잘못하면 의도하지 않게 세션 정보가 날아간다.

만약 시간적인 결합이 필요하다면 함수 이름에 분명히 명시한다.

출력 인수

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

appendFooter(s);

인수 s는 입력일까 출력일까?

public void appendFooter(StringBuffer report)

함수 선언부를 찾아보고 나서야 알 수 있다.
함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다.
인지적으로 거슬린다는 뜻이므로 피해야 한다.

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

report.appendFooter()

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

명령과 조회를 분리하라!

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

public boolean set(String attribute, String value);

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

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

독자 입장에서 설정을 확인하는지, 성정하는 코드인지 함수를 호출하는 코드만 봐서는 의미가 모호하다.
함수를 구현한 개발자는 'set'을 동사로 의도 했지만 if 문에 넣고 보면 형용사로 느껴진다.
그래서 if문은 username 속성이 unclebob으로 설정되어 있다면..으로 읽힌다.
username 을 unclebob으로 설정하는데 성공했다면..으로 읽히지 않는다.

set이라는 함수 이름을 바꾸는 것보다 if 문에 넣지 않고 명령과 조회를 분리해 혼란을 뿌리뽑는다면 근본적으로 해결할 수 있다.

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

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

명령 함수에서 오류 코드를 반환하는 방식은 명령 / 조회 분리 규칙을 미묘하게 위반한다.
- 자칫 if문에서 명령을 표현식으로 사용하기 쉬운 탓
```
if (deletePage(page) == E_OK) {
	if (configKeys.deleteKey(page.name.makeKey()) == E_OK) {
  	logger.log("page deleted");
 } else {
 ...
```
  동사 / 형용사 혼란을 일으키지 않는 대신 여러 단계로 중첩되는 코드를 야기한다.
  오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪친다.
반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

try {
	delePage(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 문으로 끝나야 한다는 말이다.

오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.

의존성 자석

public enum Error {
	OK,
    INVALID,
    NO_SUCH,
    LOCKED,
    OUT_OF_RESOURCES,
    WATTING_FOR_EVENT;
}

다른 클래스에서 Error enum을 import해 사용해야 한다.
- Error enum이 변한다면 Error enum을 사용하는 클래스 전부를 다시 컴파일하고 다시 배치해야 한다.
- 그렇게 되면 Error 클래스 변경이 어려워진다.
새 오류 코드를 추가하는 대신 기존 오류 코드를 재사용한다.
오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다.
재컴파일/재배치 없이 새 예외 클래스를 추가할 수 있다.

반복하지 마라!

중복은 문제다.
코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 모든 곳을 손봐야 한디.
게다가 어느 한곳이라도 빠뜨리는 바람에 오류가 발생할 확률도 몇배 높다.
중복을 없애면 모듈 가독성이 크게 높아진다.

어쩌면 '중복'은 소프트웨어에서 모든 악의 근원이다.

많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 탄생

관계형 데이터베이스 정규 형식, 객체지향에서 코드를 부모로 몰아 중복 제거, 구조적 프로그래밍, AOP, COP.. 모두 어떤 면에서 중복 제거 전략

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

구조적 프로그래밍

모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다.
- return 문이 하나여야 한다.
- 루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로!! 안 된다..
목표와 규율은 공감하지만 함수가 작다면 별 이익을 제공 못한다. 함수가 아주 클 때만 상당한 이익을 제공한다.
함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다.
오히려 때로는 단일 입/출구 규칙보다 의도를 표현하기 쉬워지는 반면 goto 문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야만 한다.

함수를 어떻게 짜죠?
여느 글짓기와 비슷하게 먼저 생각을 기록한 후 읽기 좋게 다듬는다.
서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다.
메서드를 줄이고 순서를 바꾼다.
때로는 전체 클래스를 쪼개기도 한다.
이 와중에도 코드는 항상 단위 테스트를 통과한다.

최종적으로 여태 설명한 규칙을 따르는 함수가 얻어진다.

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

결론
모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한 도메인 특화 언어(DSL, Domain Specific Language)로 만들어진다.
함수는 그 언어에서 동사, 클래스는 명사
프로그래밍의 기술은 언제나 언어 설계의 기술이다.
대가 프로그래머는 시스템을 구현할 프로그램이 아니라 풀어갈 이야기로 여긴다.
프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.

" 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라.
하지만 진짜 목표는 시스템이라는 이야기를 풀어가는데 있다는 사실을 명심하기 바란다. 여러분이 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다는 사실을 기억하기 바란다."

김주형

왔을때보다좋은곳으로

이전 포스트

[자라기] - 책임 주도 설계를 따르는 방법

다음 포스트