[Clean Code] 3. 함수

이 글은 Clean code 책 내용을 정리한 글입니다.

저작권 관련 문제가 있다면 "meme91322367@gmail.com"으로 메일 보내주시면, 바로 삭제하도록 하겠습니다.

작게 만들어라

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

public static String renderPageWithSetupsAndTearDowns (PageData pageData, boolean isSuite) throws Exception {

if (isTestPage(pageData))

includeSetupAndTearDownPages(pageData, isSuite);

return pageData.getHtml();

}

if문/else문/while문 등에 들어가는 블록은 한 줄이어야 한다. 함수의 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다. 그래야 함수는 읽고 이해하기 쉬워진다.

한가지만 해라

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

• 한 가지 작업만 하는지 판단하는 방법
  • 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.
  • 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.

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

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

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

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

Switch 문

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

• 위 예제의 문제점
  • 함수가 길다.
  • 한 가지 작업만 수행하지 않는다.
  • SRP(Simgle Responsibility Principle)를 위반한다.
  • OCP(Open Closed Principle)를 위반한다.
  • 가장 심각한 문제는 위 함수와 구조가 동일한 함수가 무한정 존재한다(isPayday, deliverPay,,)

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문은 다형적 객체를 생성하는 코드 안에서만 사용하자.
switch문을 추상 팩토리(Abstract Factory)에 숨기고, 팩토리는 switch문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다. isPayday,deliverPay,calculatePay 등과 같은 함수는 Employee 인터페이스를 거쳐 호출된다.

서술적인 이름을 사용해라

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

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

함수 인수

함수에서 이상적인 인수 개수는 0개다. 다음은 1개고, 다음은 2개다. 3개는 가능한 피하는게 좋다. 4개 이상은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다.

• 단항 형식

  • 인수에 질문을 던지는 경우
    • boolean fileExists("MyFile")
    • InputStream fileOpen("MyFile")은 인수를 뭔가로 변환해 결과를 반환한다.
  • 이벤트 함수는 이벤트라는 사실이 코드에 명확히 나타나야 한다.
    • passwordAttemptFailedNtimes(int attempts)

• 플래그 인수 (bool)

  • 플래그 인수는 추하다. 대놓고 여러 가지를 처리하는 함수라고 공표하는 셈이니까! 이럴땐 함수를 나눠야 마땅하다.

• 이항 함수

  • 인수가 1개인 함수보다 이해하기 어렵다.
  • 2개의 인수가 한 값을 표현하는 두 요소는 괜찮다.
    • Point p = new Point(0,0)
  • 인수 간의 자연적인 순서가 있지 않으면 인위적으로 기억해야 한다.
    • assertEquals(expected, actual)

• 삼항 함수

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

• 인수 객체

  • 인수가 2~3개가 필요하다면 클레스 변수로 선언할 가능성을 집어본다.
  • Circle makeCircle(Point center, double radius)

• 인수 목록 (가변 인수)

  • 가변 인수도 의미에 따라 단항, 이항, 삼항으로 취급할 수 있다. 하지만 이를 넘어서는 인수를 사용할 경우에는 문제가 있다.

• 동사와 키워드

  • 함수의 의도와 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.
    • write(name) : 이름이 무엇이든 쓴다.
    • writeField(name) : name이 Field라는 사실을 알 수 있다.
    • assertExpectedEqualsActual(expected, actual) : 인수의 순서를 기억할 필요가 없어진다.

부수 효과를 일으키지 마라

부수 효과는 거짓말이다. 한 가지만 하겠다고 약속해놓고 다른 짓도 하니까. 많은 경우 시간적인 결합(temporal coupling)이나 순서 종속성(order dependency)을 초래한다.

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

출력 인수

객체 지향 언어에서 출력 인수로 사용하라고 설계한 변수가 this이다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

명령과 조회를 분리하라

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

public boolean set(String attribute, String value);

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

위 코드의 if 문은 username이 unclebob으로 설정되어 있다면... 으로 읽힌다. username을 unclebob으로 설정하는데 성공하면...으로 읽히지 않는다. 아래와 같이 명령과 조회를 분리하는게 애초에 뿌리뽑는 방법이다.

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

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 if 문에서 명령을 표현식으로 사용하기 쉬운 탓이다.

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

위 코드는 여러 단계로 중첩되는 코드를 야기한다. 오류 코드를 반환하면 호출자는 오류 코드를 바로 처리해야 하지만, 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다. try/catch불록은 코드 구조에 혼란을 일으키며 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.

try {
    deletePage(page);
    registry.deleteReference(page.name);        configKeys.deleteKey(page.name.makeKey());
} catch (Exception e) {
    logger.log(e.getMessage());
}

보다는

public void delete(Page page) {
    try {
        deletePageAndAllReferences(page);
    } catch (Exception e) {
        logError(e);
    }
}

private void deletePageAndAllReferences(Page page) throws Eception { 
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}

private void logError(Exception e) { 
    logger.log(e.getMessage());
}

이런 식으로 사용하자.

오류 처리도 한 가지 작업이다. 그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다. 즉, try가 있다면 catch/finally 문으로 끝나야 한다.

새 오류 코드를 추가하는 대신 기존 오류 코드를 재사용한다.

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

반복하지 마라!

중복 코드를 제거하라.
RDB에서는 정규화, OOP에서는 부모 클래스로 중복을 제거한다. 구조적 프로그래밍, AOP, COP 모두 중복 제거 전략이다.

구조적 프로그래밍

모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다 (Single Entry-Exit Rule). 즉 return 문이 하나여야 하고, loop 안에서 break나 continue를 사용해서는 안된다.

함수가 클 때는 이 말이 맞지만, 함수를 작게 만들면 return, break, continue를 여러 차례 사용해도 괜찮다.

함수를 어떻게 짜죠?

소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다.
글쓰기를 할때에는 먼저 생각을 기록한 후 읽기 좋게 다듬는다.

코드도 마찬가지다. 처음에는 길고 복잡하게, 들여쓰기도 여러 단계, 중복된 루프도 많고, 인수 목록도 아주 길다. 하지만 그 코드를 빠짐없이 테스트하는 케이스도 만든다. 그런 다음 코드를 가다듬고, 함수를 추출하고, 이름을 바꾸고, 순서도 바꾼다. 클래스를 쪼개기도 한다. 그 와중에도 항상 단위 테스트를 통과한다.