(클린코드) 3장. 함수

3장. 함수

어떤 프로그램이든 가장 기본적인 단위가 함수다. 이 장은 함수를 잘 만드는 법을 소개한다.

작게 만들어라!

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

20줄도 길다.

얼마나 짧아야 좋을까?

 

블록과 들여쓰기

if문/else문/while 문등에 들어가는 블록은 한 줄이어야 한다는 의미다. 이 말은 중첩 구조가 생길만큼 함수가 커져서는 안된다는 뜻이다. 그러므로 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다. 그래야 함수는 읽고 이해하기 쉬워진다.

한가지만 해라!

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

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

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

 

함수 내 섹션

한 가지만 작업하는 함수는 자연스럽게 여러 섹션으로 나뉘어질 수 없다. 즉 함수내에 섹션이 나뉜다는 것은 한 함수에서 여러 작업을 한다는 증거이다.

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

함수가 확실히 ‘한 가지’작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다. 한 함수 내에 추상화 수준을 섞으면 특정 표현이 근본 개념인지 아니면 세부사항인지구분하기 어려워진다.

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

 

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

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

ex)

추상화 1수준의 함수

추상화 2수준의 함수 1

추상화 2수준의 함수2

Switch문

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

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

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

위 함수에는 몇가지 문제가 있다. 1. 함수가 길다. 2. 한가지 작업만 수행하지 않는다. 3. SRP(Single Responsibility Principle)를 위배한다. 코드를 변경할 이유가 여럿이다. 4. OCP(Open Closed Principle)를 위반한다. 새 직원 유형을 추가할 때마다 코드를변경하게 된다. 5. 가장 심각한 문제는 위 함수와 구조가 동일한 함수가 무한정 존재한다는 사실이다.(ex, isPayday(Employee e, Date date), deliverPay(Employee e, Money pay)

이 문제를 해결하기 위한 코드 가 아래 있다. switch문을 추상 팩토리에 숨기고 아무에게도 보여주지 않는다. 팩토리는 switch문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다.

public abstract class Employee{
	public abstract boolean isPayday();
	public abstract Money calcaulatePay();
	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 calculateCommissionedPay(r);
			case HOURLY:
				return calculateHourelyPay(r);
			case SALARIED:
				return calculateSalariedPay(r);
			default:
				throw new InvalidEmployeeType(r.type);
		}

다형성 객체를 생성하는 코드안에서만 switch 문을 한번 참아준다! 이렇게 상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다.

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

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

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

이름이 길고 서술적인 이름은 짧고 어려운 이름보다 좋다. 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.

함수이름을 정할때는 여러단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

이름을 정하느라 시간을 들여도 괜찮다.

함수 인수

3개 이상의 인수는 피해야한다.

흔히 함수에다가 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙하다. 대개 함수에 인수로 결과를 받으리라는 기대는 하지 않는다. 그래서 출력 인수는 좋지 않다.

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

많이 쓰이는 단항 형식

1. 인수에 질문을 던지는 경우
   1. boolean fileExists(”MyFile”)
2. 인수를 뭔가로 변환해 결과를 반환하는 경우
   1. InputStream fileOpen(”MyFile”) 은 String형ㅇ의 파일이름을 InputStream으로 반환한다.
3. 다소 드물게 사용하지만, 아주 유용한 단항 함수 형식이 이벤트다.
   1. 이벤트 함수는 임력 인수만 있다.
   2. 이벤트로 해석해서 입력 인수로 시스템 상태를 바꾼다.
   3. passwordAttemptFailedNtimes(int attempts)

• 이 외의 경우가 아니라면 단항 함수는 가급적 피한다. 예를 들면 변환함수에서 출력 인수를 사용하면 혼란을 일으킨다.
  • void includeSetupPageInto(StringBuffer pageText) 는 피한다.
  • StringBuffer transform(StringBuffer in)이 void transform(StringBuffer out)보다 좋다. StringBuffer transform(StringBuffer in)이 입력 인수를 그대로 돌려주는 함수라 할지라도 변환 함수형식을 따르는 편이 좋다.

플래그 인수

플래그 인수는 추하다.

함수가 한번에 여러가지를 처리한다고 대놓고 공표하는 셈이다. 함수를 2개로 나눠라.

 

이항 인수

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

 

삼항 인수

삼항함수를 만들 때는 신중히 고려하라 권고한다.

인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다.

 

인수 객체

인수가 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 , hous);

 

동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.

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

부수효과를 일으키는것을 거짓말을 하는 것과 같다. 함수에서 한가지를 하겠다고 약속하고 남몰래 다른 짓도 하는 것이니깐.

함수로 넘어온 인수나 시스템 전역변수를 수정하는 것은 교활하고 해로운 거짓말이다. 많은 경우 시간적인 결합이나 순서 종속성을 초래한다.

명령과 조회를 분리하라!

찾아오는 것, set하는 것을 같이하려고 하면 안됨

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

Try/Catch 블록 뽑아내기

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

반복하지 마라!

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

구조적 프로그래밍

함수를 작게 만든다면 간혹 retrun, break, countinue를 여러차례 사용해도 괜찮다. 오히려 때로는 단일 입/출구 규칙보다 의도를 표현하기 쉬워진다.

반면, goto문은 큰 함수에서만 의미가 있으므로 작은 함수에서는 피해야한다.

함수를 어떻게 짜죠?

글짓기와 비슷하다. 초안은 어수선하므로 원하는 대로 읽힐 때 까지 다듬고 문장을 고치고 문단을 정리한다.

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

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

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

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

결론

모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설개한 도메인 특화 언어 (DSL: DomainSepecificLanguage)로 만들어 진다. 함수는 그 언어에서 동사며, 클래스는 명사다.

Master 프로그래머는 시스템을 구현할 프로그램이 아니라 풀어갈 이야기로 여긴다.

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

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