[Clean Code] 3장 | 함수

PADO·2020년 12월 28일
CLEAN CODE
0

Clean Code

목록 보기
4/15
post-thumbnail
post-custom-banner

🧷 3장 | 함수

📘 작게 만들어라

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

각 함수가 너무나도 명백하게 이야기 하나를 표현하고, 다음 무대를 준비 해야 한다.

블록과 들여쓰기

  • if문, else문, while문 등에 들어가는 블록은 한 줄 이어야 한다. ⇒ 여기서 함수 호출
  • 중첩 구조가 생길만큼 함수가 커져서는 안 된다.
  • 함수에서 들여쓰는 수준은 1단이나 2단을 넘어서면 안 된다.

: 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름이 적절하면, 가독성도 좋아진다.

📘 한 가지만 해라

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

  • 함수는 추상화 수준이 하나인 단계만 수행해야 한다.
  • 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.
public static String renderPageWithSetupsAndTeardowns(
	PageData pageData, boolean isSute) throws Exception {
	if(isTestPage(pageData)
		includeSetupAndTeardownPages(pageData, isSuite);
	return pageData.getHtml();
}

: 한 가지 작업만 하는 함수는 자연스럽게 섹션으로 나누기 어렵다.

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

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

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

: 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다.

  • Switch문

: 본질적으로 switch문은 N가지를 처리하지만, 각 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법이 있다. 다형성(polymorphism)을 이용한 방법이다.

public Money calculatePay(Employee e) thorws InvalidEmployeeType {
	switch(e.type) {
		case COMMISIONED:
			return calculateCommissionedPay(e);
		case HOURLY:
			return calculateHourlyPay(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문을 숨기고, 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다. calculatePay, isPayday, deliverPay등과 같은 함수는 Employee 인터페이스를 거쳐 호출 된다. 그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행 된다.

public abstract class Employee {
	public abstract boolean isPayday();
	public abstract Money calculatePay();
	public abstract void deliverPay(Money pay);
}
-----
public interface EmployeeFactory {
	public Employee make Employee(EmployeeRecord r) throws InvalidEmployeeType;
}
-----
public class EmployeeFactoryImpl implements EmployeeFactory {
	public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
		switch(r.type) {
			case COMMISIONED:
				return new CommissionedEmployee(r);
			case HOURLY:
				return new HourlyEmployee(r);
			case SALARIED:
				return new SalariedEmployee(r);
			default:
				throw new InvalidEmployeeType(r.type); 
		}
	}
}

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

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

한 가지만 하는 작은 함수에 이런저런 이름을 시도한 후 최대한 서술적인 이름을 골라라.

  • 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.

ex) includeSetupAndTeardownPages, includeSetupPages, includeTeardownPages

📘 함수 인수

"함수에서 이상적인 인수 개수는 0개다. 다음은 1개고, 다음은 2개다. 3개는 가능한 피하는 편이 좋다. 4개 이상은 특별한 이유가 필요하다."

  • 함수 이름과 인수 사이에 추상화 수준이 다르다.
  • 읽는 사람은 현 시점에서 중요하지 않은 세부사항까지 알아야 한다.
  • 인수 3개가 넘어가면 인수마다 유효한 값으로 모든 조합을 구성해 테스트하기가 부담스러워 진다.

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

단항 함수

  • 인수에게 질문을 던지는 경우
    boolean fileExists("MyFile")
  • 인수를 뭔가로 변환해 결과를 반환하는 경우
    InputStream fileOpen("MyFile")
  • 이벤트 (입력 인수로 시스템 상태를 바꾸는 경우)
    passwordAttemptFailedNtimes(int attempts)

위의 경우가 아니라면 단항 함수는 가급적 피한다.
나쁜 예) void includeSetupPageInto(StringBuffer pateText) 변환 함수에서 출력 인수를 사용

플래그 인수

함수로 boolean값을 넘기는 것은 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이다.

  • 각 플래그 값에 따라 별도의 함수를 작성하라.
    ex) render(boolean isSuite) → renderForSuite() & renderForSingleTest()

이항 함수

인수 2개가 한 값을 표현하는 두 요소이고, 그 순서가 자연적인 경우 이항 인수는 적절하다.

나쁜 예) writeFile(outputStream, name)

잠시 주춤하며 첫 인수를 무시해야 한다는 사실을 깨닫는다. 그리고 바로 그 사실이 결국 문제를 일으킨다.
왜냐고? 어떤 코드든 절대로 무시하면 안 된다. 무시한 코드에 오류가 숨어드니까.

해결 writeField 메서드를 outputStream 클래스 구성원으로 만들어 ouputstream.writeFiled(name)으로 호출한다. 아니면 outputStream을 현재 클래스 구성원 변수로 만들어 인수로 넘기지 않는다.

나쁜 예) assertEquals(expected, actual)
좋은 예) Point p = new Point(0,0);

삼항 함수

부동소수점 비교의 경우에 삼항 함수는 적절하다.

나쁜 예) assertEquals(message, expected, actual)
좋은 예) assertEquals(1.0, amount, .001)

인수 객체

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

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

동사와 키워드

  • 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
    ex) write(name)

  • 함수 이름에 인수에 관한 키워드를 추가하라.
    ex) write(name) → writeField(name),
    assertEquals() → assertExpectedEqualsActual(expected, actual)

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

  • 예상치 못한 부수 효과는 시간적인 결합, 순서 종속성을 초래하게 된다.
  • 함수는 한 가지 기능만 하도록 작성하라.

나쁜 예)

public class UserValidator {
	private Cryptographer crytoprahpher; 
	
	public boolean checkPassword(String userName, String password) {
		User user = UserGateway.findByName(userName);
		if (user != User.NULL) {
			String codedPrase = user.getPhraseEncoededByPassword();
			String phrase = crytoprahpher.decrypt(codedPhrase, password);
			if("Valid Password".equals(phrase)) {
				Session.initialize();
				return true;
			}
		}
		return false;
	}	
}

checkPassword는 이름 그대로 암호 확인만 해야한다. 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다. 함수가 일으키는 부수효과는 Session.initialize(); 호출이다. 그래서 함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다.

해결 checkPasswordAndInitializeSession 이라는 이름이 더 좋다. 함수가 두 가지 일을 하긴 하지만.

출력 인수

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

나쁜 예) appendFooter(s);
좋은 예) report.appendFooter();

📘 명령과 조회를 분리하라!

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

나쁜 예) public boolean set(String attribute, String value);
이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true, 실패 시 false를 반환하는 메서드
→ if(set(attribute, userName)으로 코드 사용 시 의미가 모호. "set"이 동사인지 형용사인지 모호.

좋은 예) 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 블록을 별도 함수로 뽑아내고, try문 안에서 실제 '작업' 메소드를 호출한다.
  • 실제 '작업'을 하는 코드에서는 thorws Exception하여 모든 예외 처리를 한 곳에서 처리한다.
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로 끝나야 한다.

  • 오류 코드를 반환하는 방식은 여러 단계로 중첩되는 코드를 야기한다.
  • 오류 코드를 반환하는 방식은 오류 코드를 곧바로 처리해야 한다는 문제가 발생한다.
  • 오류 코드를 정의하는 의존성 자석(magnet)은 재컴파일/재배치를 요구하기 때문에 번거로워진다.

[Error.java] 의존성 자석

오류 코드 대신 예외를 사용하면 새 오류 코드를 추가하는 대신 새 예외는 Exception 클래스에서 파생된다.

📘 반복하지 마라!

  • 코드 길이가 늘어난다.
  • 알고리즘이 변하면 모두 손봐야 한다.
  • 어느 한 곳이라도 빠뜨리면 오류가 발생할 확률이 높아진다.

📘 구조적 프로그래밍

  • 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다.
  • 함수가 아주 클 때 구조적 프로그래밍의 목표와 규율이 효과적이다.

📘 함수를 짜는 방법?

SW를 짜는 행위는 글짓기와 비슷하다.

  • 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
  • 코드를 다듬는다.
  • 함수를 만든다.
  • 이름을 바꾼다.
  • 중복을 제거한다.
  • 메서드를 줄이고 순서를 바꾼다.
  • 때로는 전체 클래스를 쪼개기도 한다.
profile
PADO
이전 포스트

[Clean Code] 2장 | 의미 있는 이름

다음 포스트

[Clean Code] 4장 | 주석

post-custom-banner

0개의 댓글