[클린코드] 3장 - 함수

아이엠강욱·2023년 9월 11일
클린코드
0

클린코드

목록 보기
3/3

이 내용은 로버트 C. 마틴 저자님의 클린코드 책의 내용을 가져온 것입니다.

이번 포스팅에서는 함수에 대한 클린코드에 대해서 알아보도록 하자.

작게 만들어라!

함수를 만드는 첫 번째 규칙은 무조건 작게이다. 큰 함수를 작게 쪼개면서 적절한 이름을 붙여주면 코드를 이해하기 쉬워진다.

public static String renderPageWithSetupAndTeardowns(
  PageData pageData, boolean isSuite) throws Exception {
  if (isTestPage(pageData))
    includeSetupAndTeardownPages(pageData, isSuite);
  return pageData.getHtml();
}
  • if문, else문, while문 등에 들어가는 블록은 한 줄이어야 한다는 의미를 가진다.
  • 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서는 안된다.

위의 두 사항을 지켜야 함수를 읽고 이해하기 쉬워지게 코드를 작성할 수 있다.

한 가지만 해라!

  • 함수는 한 가지를 해야한다. 그 한 가지를 잘 해야한다. 그 한 가지만을 해야한다.
  • 함수가 여러가지 일을 한다면 각 기능을 적절한 함수이름을 붙여 추상화 한 후 여러 단계로 나누어 수행해야 한다.
  • 한 가지 작업만하는 함수는 섹션으로 나누기 어렵다. 따라서 섹션으로 나눌 수 있다면 각 섹션을 함수로 나눠야 한다.
TO RenderPageWithSetupsAndTeardowns, 페이지가 테스트 페이지인지 확인한 후 테스트 페이지라면 설정 페이지와 해제 페이지를 넣는다.
테스트 페이지든 아니든 페이지를 HTML로 렌더링한다.

(참고로 TO는 파이썬의 def와 같다고 생각하면 된다)

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

먼저 추상화 수준이라는 단어를 알아야 이해할 수 있다.

추상화 수준은 해당 코드를 읽으면서 파악할 수 있는 정보의 수준을 말한다. 다시 말해서 해당 코드로 더 자세한 정보를 알 수 있으면 추상화가 더 낮아진다고 할 수 있다.

  • 높은 추상화 수준: getHtml()이라는 함수는 HTML을 가져온다는 것은 알겠는데 어떤 것이랑 연관되어 있는지는 알 수 없기 때문에 추상화 수준이 높다고 할 수 있다.
  • 보통 추상화 수준: String pagePathName = PathParser.render(pagepath);는 PathParser 객체의 render함수를 이용해서 pagePathName을 가져올 수 있다는 정보를 유추할 수 있기 때문에 추상화 수준이 보통이라고 할 수 있다.
  • 낮은 추상화 수준: .append('\n')은 바로 어떤 의미인지 유추할 수 있기 때문에 추상화 수준이 낮다고 할 수 있다.

내려가기 규칙

코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 하나의 함수 다음에는 추상화 수준이 한 단계 더 낮은 함수가 와야한다. 다시 말해서, 위에서 아래로 코드를 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다고 생각하자.

한 가지 핵심은 짧으면서도 한 가지 기능만 하는 함수가 제일 좋다는 것이다.

Switch 문

Switch 문이나 if/else가 여러개 이어지는 구문은 작게 만들기 어렵다. 본질적으로 switch 문은 n가지를 처리하기 때문에 switch를 완전히 피할 방법은 없다.

하지만 각 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);
  }
}

위의 함수는 여러가지 문제점을 가지고 있다.

  • 함수의 내용이 길다. 만약에 새로운 직원 유형을 추가하게 되면 더 길어질 것이다.
  • type에 따라 다른 함수들을 호출하기 때문에 한 가지 작업만 수행하지 않는다. (SRP: 단일 책임 원칙 위반)
  • 새 직원 유형을 추가할 때마다 코드를 변경해야 하기 때문에 OCP(개방 폐쇄 원칙)을 위반한다.
  • 위 함수와 구조가 동일한 함수가 무한정 존재하게 된다. 예를 들어보자면 직원 유형에 따른 급여 지급 날짜 등이 있을 것 같다.

위의 문제들을 추상 팩토리 패턴을 이용해서 해결할 수 있다. 간단히 설명하자면 Employee를 상속하는 다양한 직원 유형을 만들고 Employee의 추상화 함수를 구현한 다양한 직원 유형에서 각 함수들을 호출하는 방법이다.

public abstract class Employee {
  public abstract boolean isPayday();
  public abstract boolean calculatePay();
  public abstract boolean deliverPay(Money pay);
}

// Employee를 상속받는 객체들을 생성할 수 있는 EmployeeFactory 인터페이스
public interface EmployeeFactory {
  public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}

// EmployeeFactory를 구현한 클래스
public class EmployeeFactoryImpl implements EmployeeFactory {
  public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
    case COMMISIONED :
        return new CommissionedEmployee(r);
      case HOURLY :
        return new HourlyEmployee(r);
      case SALARIED :
        return new SalariedEmployee(r);
      default :
        throw new InvalidEmployeeType(r.type);
  }
}

위와 같이 Employee를 구현한 다양한 직원 유형 객체를 생성해주면서 개선 전의 문제들을 해결할 수 있다. 하지만 새 직원 유형을 추가한다면 똑같이 함수가 길어지긴 한다.

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

좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않다. 길고 서술적인 이름이 짧고 어려운 이름보다 훨씬 좋다.

특히, 이름을 붙일 때에는 일관성이 있어야 한다. 예를 들어 includeA, includeB가 있다면 includeC도 있을 수 있다고 짐작할 수 있기 때문이다.

함수 인수

함수에서 가장 이상적인 인수의 개수는 0개(무항)이다. 인수의 개수가 늘어날 수록 함수를 이해하기 어렵게 만들기 때문에 4개 이상은 아무리 특별한 이유가 있어도 사용하지 않는게 좋다.

테스트 관점에서 보면 갖가지 인수 조합으로 함수를 검증하게 되는데 인수가 늘어날수록 조합이 복잡해진다.

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

많이 쓰는 단항 방식

함수에 인수 1개를 넘기는 가장 큰 이유는 다음과 같다.

  • 인수에 질문을 던지는 경우
    • ex) boolean fileExists("MyFile")
  • 인수를 변환해 결과를 반환하는 경우
    • ex) InputStream fileOpen("MyFile")

그리고 이벤트 함수도 단항 함수 형식으로 이루어져 있다. 하지만 이벤트 함수라는 것이 코드에 명확히 들어나야 한다.

따라서 위의 경우가 아닌 경우에는 단항 함수도 피한다.

플래그 인수

플래그 인수는 함수가 한꺼번에 여러가지를 처리하는 것을 유추할 수 있기 때문에 쓰지 않는 것이 좋다.

인수로 부울 값이 들어간다는 것은 내부 로직적으로 예측해보면 참이면 A기능, 거짓이면 B기능 과 같은 구조로 될 건데 이것은 좋지 않다.

이항 함수

인수가 2개인 함수는 단항 함수보다 이해하기 어렵고 헷갈린다. Point p = new Point(1, 2)와 같이 인수 2개가 한 값을 자연스럽게 표현하는 경우가 아니라면 불가피한 경우가 아닌 경우에는 사용을 지양하자.

삼항 함수

인수가 3개인 경우는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 따라서 삼항 함수를 만들 때에는 신중하게 고려해야 한다.

인수 객체

인수가 만약 2-3개가 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 살펴봐야 한다.

Circle makeCircle(double x, double y, double radius)를 Circle makeCircle(Point center, double radius)로 바꿀 수 있다.

즉, 객체를 생성해 인수를 줄이는 방법이 눈속임처럼 보일 수 있지만 x,y를 묶었듯이 변수를 넘기려면 이름을 붙여야 하기 때문에 결국에는 개념을 표현한다.

인수 목록

String.format 처럼 때로는 인수 개수가 가변적인 함수도 필요하다. 이 때 가변 인수들은 List형 인수 하나로 취급할 수 있다.

public String format(String format, Object ...args)

실제 위의 String.format의 구조를 보면 이항 함수라는 사실을 알 수 있다. 하지만 가변 인수를 포함해 인수 개수가 3개가 넘어가면 안된다.

동사와 키워드

좋은 함수 이름을 정할 때는 단항 함수라면 함수와 인수가 동사-명사 쌍을 이루는게 좋다.

write(name)과 같이 이해하기 쉬운 함수가 될 수 있다. 아니면 writeField(name) 처럼 name이 field라는 사실을 분명하게 드러내도 좋다.

추가로, assertEquals보다 assertExpectedEqualsActual(expected, actual)처럼 함수 이름에 키워드를 넣음으로써 인수 순서를 기억하지 않아도 되게 만드는 방법도 좋다.

부수 효과를 일으키지 말자!

함수 이름으로 명시된 한 가지 기능 외에 다른 기능이 포함되면 부수효과가 발생하는 경우를 조심해야 한다. (Side Effect)

함수가 한 가지 일을 하게 만드는 게 좋지만 어쩔 수 없다면 차라리 함수 이름에 다른 일에 대한 것을 분명히 명시하는 것이 중요한 것이다.

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

위의 함수에서 부수 효과를 일으키는 부분은 Session.initialize() 이다. 위의 함수는 사용자의 비밀번호를 확인하는 함수인데 세션을 초기화 한다?

함수의 이름만 보고서는 세션을 초기화하는 기능이 있는지 파악은 전혀 할 수 없다. 그래서 함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면 기존 세션 정보를 지워버릴 위험에 처한다.

그래서 이름을 checkPasswordAndInitializeSession 이라는 이름을 사용하면 더욱 좋을 것 같다. 물론 함수가 한 가지만 한다는 규칙은 위반한다.

출력 인수

일반적으로 인수를 함수의 입력, 반환값을 출력으로 생각하기 때문에 인수를 출력으로 사용하지 않게 조심해야 한다.

명령과 조회를 분리하자!

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

예시를 들어서 속성을 찾아 값을 value로 설정한 후 성공하면 true, 실패하면 false를 반환하는 함수가 있다고 가정한다. (public boolean set(String attribute, String value))

if (set("username", "unclebob")) 과 같은 경우는 username 속성이 unclebob으로 설정되어 있다면? 과 같이 오해할 수 있는 가능성이 있기 때문에 set이 설정과 체크 두 개의 일을 하는 것 보다 attributeExists, setAttribute로 일을 나누는 것이 훨씬 좋다.

다른 분의 생각

이거는 구글링으로 다른 개발자님의 생각을 봤는데 괜찮은 내용인 것 같아서 가져와봤다.

보통 데이터 update를 할 때 사용하는 update 함수들은 인자로 받은 값을 DB에서 update 후 성공 또는 실패를 확인할 수 있게 값을 반환해주는 경우가 있다.

저자의 말대로라면 update하고 다시 DB를 조회해서 값을 확인해야 한다. 이런 경우는 DB를 한 번 더 조회하는 것이 너무 비효율적이기 때문에 예외 케이스인 것 같다.

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

함수에서 오류 코드를 사용하게 되면 오류 코드에 관련된 처리를 추가적으로 해주어야 한다. 때문에 오류코드 대신 예외를 사용하면 오류 처리 코드가 분리되므로 코드가 더 깔끔해진다.

try/catch 블록 뽑아내기

try-catch 블록은 정상 동작과 오류 처리 동작이 섞이게 된다. 정상 동작 할 수도 있고 오류가 날 수도 있기 때문이다.

때문에 try-catch 블록을 아래와 같이 별도 함수로 분리하는 편이 좋다.

// try catch 블록을 포함하는 delete 함수
public void delete(Page page) {
    try {
        deletePageAndAllReferences(page);
    } catch (Exception e) {
        logError(e);
    }
}

// 실질 적인 로직을 모아 놓은 deletePageAndAllReferences 함수
private void deletePageAndAllReferences(Page page) throws Exception {
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}

// 로그를 보여주는 logError 함수
private void logError(Exception e) {
    logger.log(e.getMessage());
}

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

함수는 한 가지 기능만 해야하는데 오류 처리도 한 가지 기능(작업)에 속한다. 따라서 위의 예시와 같이 오류를 처리하는 함수는 오류만 처리해야 한다고 한다.

Error.java 의존성 자석

만약 Java에서 에러 코드를 위한 enum을 사용한다고 했을 때 다른 클래스에서도 에러 코드 enum을 사용해야 하기 때문에 만약에 enum이 수정된다면 다른 곳에서도 전부 수정을 해야하기 때문에 비효율적이다.

하지만 예외를 사용하게 된다면 재컴파일 및 재배치 없어도 새 예외 클래스를 추가해서 사용할 수 있기 때문에 예외를 권장한다.

반복하지 마라!

많은 원칙과 기법들이 중복을 없애거나 제어할 목적으로 나왔다. 중복이 발생한다면 코드 길이가 늘어날 뿐만 아니라 중복 코드가 변하면 중복된 부분 모두를 수정해야 하기 때문에 오류가 발생할 확률도 높아지게 된다.

구조적 프로그래밍, AOP(Aspect Oriented Programming), COP(Component Oriented Programming) 모두 어떤 면에서는 중복 제거 전략이다.

AOP(Aspect Oriented Programming): 관점 지향 프로그래밍이다. 어떤 로직을 기준으로 핵심적인 관점, 부가적인 관점으로 나누어서 보고 그 관점을 기준으로 각각 모듈화 하는 것을 의미한다.

COP(Component Oriented Programming): Vue, React, Angular 등에서 사용하는 컴포넌트 지향 프로그래밍이다. 프론트엔드에서 반복되는 요소들을 컴포넌트로 분리해서 애플리케이션을 보다 더 빠르게 구축할 수 있게 해주는 것이다.

구조적 프로그래밍

모든 함수와 함수 내 모든 블록에서는 입구와 출구가 하나만 존재햐아 한다고 한다. (입출구 규칙)
따라서 break, continue는 사용해서 안되고 goto문은 더더욱 안된다.

하지만 함수를 작게 만든다면 return, break, continue를 여러차례 사용해도 괜찮다고 한다. 오히려 때로는 단일 입출구 규칙보다 의도를 표현하기 쉬워지기 때문이다.

public boolean findNum(int target) {
	for(int num : nums) {
		if (num == target) {
			return true;	// 해당 숫자를 찾는다면, 함수를 종료하겠다는 의도를 확실히 표현
		}
	}

	return false;
}

함수를 어떻게 짜요?

프로그램을 만들 때 처음부터 함수를 분리하는 것은 아주 어렵다. 때문에 처음에는 길고 복잡하게 만들더라도 단위 테스트를 통해 코드를 다듬고 함수를 만들고 이름을 바꾸고 중복을 제거하는 과정이 필요하다고 한다.

느낀점

일단 단위 테스트의 필요성을 많이 느끼고 있다. 지금 하고 있는 프로젝트를 보면 고쳐야 할 부분이 굉장히 많은데 마지막에 언급했듯이 단위 테스트 과정을 거치면서 손댈 수 있는 부분은 고치는 것이 좋다고 생각한다.

따라서 시간을 어느정도 투자해서 리팩토링 하는 과정을 가져보려고 한다.

Reference

profile
아이엠강욱
블로그 이전했습니다!! https://dev-iamkanguk.tistory.com/ <<- 여기로 오세용!!
이전 포스트

[클린코드] 2장 - 의미있는 이름

0개의 댓글