Skip to content

Latest commit

 

History

History
301 lines (237 loc) · 12.6 KB

Chapter 03 - 함수.md

File metadata and controls

301 lines (237 loc) · 12.6 KB
Raw

목차

  • 작게 만들어라!
    • 블록과 들여쓰기
  • 한 가지만 해라!
    • 함수 내 섹션
  • 함수 당 추상화 수준은 하나로!
    • 위에서 아래로 코드 읽기 : 내려가기 규칙
  • Switch문
  • 서술적인 이름을 사용하라!
  • 함수 인수
    • 많이 쓰는 단항 형식
    • 플래그 인수
    • 이항 함수
    • 삼항 함수
    • 인수 객체
    • 인수 목록
    • 동사와 키워드
  • 부수 효과를 일으키지 마라!
    • 출력 인수
  • 명령과 조회를 분리하라!
  • 오류코드보다 예외를 사용하라!
    • Try/Catch 블록 뽑아내기
    • 오류 처리도 한 가지 직업이다
    • Error.java의 의존성 자석
  • 반복하지마라!
  • 구조적 프로그래밍
  • 함수를 어떻게 짜죠?

Intro

어떤 프로그램이든 기본적인 단위가 함수다.

길이가 길고, 중복된 코드에, 괴상한 문자열에, 낯설고 모호한 자료 유형의 코드로 이루어진 함수는 이해하기에 많은 어려움이 따른다. 그렇다면 읽시 쉽고 이해하기 쉬운 함수는 어떻게 작성해야하는가?

작게 만들어라!

함수를 만들 때 최대한 ‘작게!’ 만들어라.

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();
		includeSetupPages(testPage, newPageContent, isSuite);
		newPageContent.append(pageData.getContent());
		includeTeardownPages(testPage, newPageContent, isSuite);
		pageData.setContent(newPageContent.toString());
	}
	return pageData.getHtml();
}

위 코드도 길다. 되도록 한 함수당 3~5줄 이내로 줄이는 것을 권장한다

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

블록과 들여쓰기

중첩구조(if/else, while문 등)에 들어가는 블록은 한 줄이어야 한다. 각 함수 별 들여쓰기 수준이 2단을 넘어서지 않고, 각 함수가 명백하다면 함수는 더욱 읽고 이해하기 쉬워진다.

한 가지만 해라

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

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

함수가 한 가지 이상의 일을 하는지 확인할 수 있는 좋은 방법은, 했던 말을 거의 다시 되뇌이지 않는 단계로 더 추상화할 수 있는지 확인하는 것이다.

함수 내 섹션

함수를 여러 섹션으로 나눌 수 있다면 그 함수는 여러작업을 하는 셈이다.

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

함수가 ‘한가지’ 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 된다.

만약 한 함수 내에 추상화 수준이 섞이게 된다면 읽는 사람이 헷갈린다.

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

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

함수 추상화 부분이 한번에 한단계씩 낮아지는 것이 가장 이상적이다.(내려가기 규칙)

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

switch문은 작게 만들기 어렵지만(if/else의 연속 도 마찬가지!), 다형성을 이용하여 switch문을 abstract factory에 숨겨 다형적 객체를 생성하는 코드 안에서만 switch를 사용하도록 한다.

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 COMMISSIONED:
				return new CommissionedEmployee(r) ;
			case HOURLY:
				return new HourlyEmployee(r);
			case SALARIED:
				return new SalariedEmploye(r);
			default:
				throw new InvalidEmployeeType(r.type);
		} 
	}
}

하지만 switch문은 불가피하게 써야될 상황이 많으므로, 상황에 따라서는 사용 할 수도 있다.

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

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

작은 함수는 그 기능이 명확하므로 이름을 붙이기가 더 쉬우며, 일관성 있는 서술형 이름을 사용한다면 코드를 순차적으로 이해하기도 쉬워진다.

함수 인수

함수에서 이상적인 인수 개수는 0개(무항). 인수는 코드 이해에 방해가 되는 요소이므로 최선은 0개이고, 차선은 1개뿐인 경우이다. 출력인수(함수의 반환 값이 아닌 입력 인수로 결과를 받는 경우)는 이해하기 어려우므로 왠만하면 쓰지 않는 것이 좋겠다.

많이 쓰는 단항 형식

  • 인수에 질문을 던지는 경우
    boolean fileExists(“MyFile”);
  • 인수를 뭔가로 변환해 결과를 변환하는 경우
    InputStream fileOpen(“MyFile”);
  • 이벤트 함수일 경우 (이 경우에는 이벤트라는 사실이 코드에 명확하게 드러나야 한다.)

위의 3가지가 아니라면 단항 함수는 가급적 피하는 것이 좋다.

플래그 인수

플래그 인수는 추하다. 쓰지마라. bool 값을 넘기는 것 자체가 그 함수는 한꺼번에 여러가지 일을 처리한다고 공표하는 것과 마찬가지다.

이항 함수

단항 함수보다 이해하기가 어렵다.

다만 Point 클래스와 같은 두 인수간의 자연적인 순서가 있는 경우에는 이항 함수가 적절하다.

Point p = new Point(x,y);

무조건 나쁜 것은 아니지만, 인수가 2개이니 만큼 이해가 어렵고 위험이 따르므로 가능하면 단항으로 바꾸도록 한다.

삼항 함수

이항 함수보다 이해하기가 훨씬 어려우므로, 위험도 2배 이상 늘어난다. 삼항 함수를 만들 때는 신중히 고려하라.

인수 객체

인수가 많이 필요할 경우, 일부 인수를 독자적인 클래스 변수로 선언할 가능성을 살펴보자 x,y를 인자로 넘기는 것보다 Point를 넘기는 것이 더 낫다.

인수 목록

때로는 String.format같은 함수들처럼 인수 개수가 가변적인 함수도 필요하다. String.format의 인수는 List형 인수이기 때문에 이항함수라고 할 수 있다.

동사와 키워드

단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야한다.
writeField(name);
함수이름에 키워드(인수 이름)을 추가하면 인수 순서를 기억할 필요가 없어진다.
assertExpectedEqualsActual(expected, actual);

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

부수효과는 거짓말이다. 함수에서 한가지를 하겠다고 약속하고는 남몰래 다른 짓을 하는 것이므로, 한 함수에서는 딱 한가지만 수행할 것!

아래 코드에서 Session.initialize();는 함수명과는 맞지 않는 부수효과이다.

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

출력인수

일반적으로 출력 인수는 피해야 한다.

함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택하라.

명령과 조회를 분리하라

함수는 뭔가 객체 상태를 변경하거나, 객체 정보를 반환하거나 둘 중 하나다. 둘 다 수행해서는 안 된다.

public boolean set(String attribute, String value);같은 경우에는 속성 값 설정 성공 시 true를 반환하므로 괴상한 코드가 작성된다.

if(set(“username”, “unclebob”))... 그러므로 명령과 조회를 분리해 혼란을 주지 않도록 한다.

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

try/catch를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해 진다.

Try/Catch 블록 뽑아내기

if (deletePage(page) == E_OK) {
	if (registry.deleteReference(page.name) == E_OK) {
		if (configKeys.deleteKey(page.name.makeKey()) == E_OK) {
			logger.log("page deleted");
		} else {
			logger.log("configKey not deleted");
		}
	} else {
		logger.log("deleteReference from registry failed"); 
	} 
} else {
	logger.log("delete failed"); return E_ERROR;
}

정상 작동과 오류 처리 동작을 뒤섞는 추한 구조이므로 if/else와 마찬가지로 블록을 별도 함수로 뽑아내는 편이 좋다.

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

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

함수는 한 가지 일만 해야 한다. 에러처리도 한 가지 일이므로 에러처리를 하는 함수는 에러처리 외의 일을 해서는 안된다.

만약 함수에 try 키워드가 존재한다면, 이 키워드가 이 함수의 첫 키워드여야 하며 catch/finally 뒤에는 어떤 코드도 없어야 함을 의미한다.

Error.java 의존성 자석

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

오류를 처리하는 곳곳에서 오류코드를 사용한다면 enum class를 쓰게 되는데 이런 클래스는 의존성 자석이므로, 새 오류코드를 추가하거나 변경할 때 코스트가 많이 필요하다. 그러므로 예외를 사용하는 것이 더 안전하다.

반복하지 마라!

중복은 모든 소프트웨어에서 만악의 근원이다. 중복이 늘어날 수록 수정에 필요한 노력과 누락될 가능성이 커지므로, 늘 중복을 없애도록 노력해야한다.

Object Oriented Programming은 이를 base class로 모아 중복을 줄인다. Structured Programming, Aspect Oriented Programming, Aspect Oriented Programming등 많은 패러다임들 또한 중복을 줄이기 위한 전략 중 하나이다.

구조적 프로그래밍

다익스트라의 구조적 프로그래밍의 원칙을 따르자면 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나여야 된다. 즉, 함수는 return문이 하나여야 되며, 루프 안에서 break나 continue를 사용해선 안된며 goto는 절대로, 절대로 사용하지 말자. 함수가 클 경우에만 상당 이익을 제공하므로, 함수를 작게 만든다면 오히려 여러차례 사용하는 것이 함수의 의도를 표현하기 쉬워진다.

구조적 프로그래밍의 목표와 규율에는 공감하지만 함수가 작다면 위 규칙은 별 이익을 제공하지 못한다. 함수가 아주 클 때만 상당한 이익을 제공한다. 그러므로 함수를 작게 만든다면 간혹 return, break, continue를 사용해도 괜찮다. 오히려 때로는 단일 입/출구 규칙보다 의도를 표현하기 쉬워진다.

함수를 어떻게 짜죠?

우선은 길고, 복잡하고, 많은 들여쓰기와 중첩된 반복문을 쓴다. 인수 길이도 길게 작성한다. 네이밍은 알기 힘들며 중복도 많게 작성한다. 동시에 이 코드들을 빠짐없이 테스트하는 단위 테스트 케이스를 만든다.

그러고 나서야 코드를 다듬고, 함수를 나누고, 이름을 바꾸고, 중복을 제거한다. 메서드 크기를 줄이고 재정렬한다. 어떤때는 클래스 전체를 갈아 엎기도 한다. 그리고 이 모든 절차는 위에서 짠 테스트를 통과하도록 만든다.

처음부터 탁 짜지지는 않는다.