[CLEAN CODE] 함수

작게 만들어라!

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

블록과 들여쓰기

if문, else문, while문에 들어가는 블록은 한 줄이어야 한다.
조건문에서 함수를 호출하면 Enclosing Function이 작아지고, 호출 함수의 이름을 적절히 짓는다면 코드 이해도 쉬워진다.
함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.

한 가지만 해라!

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

함수 이름에 명시된 한 가지 추상화 수준을 수행한다면 그 함수는 한 가지 작업만 한다고 볼 수 있다.
우리가 함수를 만드는 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서이다.

함수 내 섹션

한 가지 작업만 하는 함수는 섹션으로 나눠지지 않는다.

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

한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.
특정 표현이 근본 개념인지, 세부사항인지 구분하기 어려워진다.

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

코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 단계씩 낮아져야 한다.

Switch문

다형성(Polymorphism)을 이용하여 swith문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법이 있다.

더 알아보기
단일 책임 원칙, SRP(Single Responsibility Principle)
개방-폐쇄 원칙, OCP(Open Closed Principle)

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

길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
서술적인 이름을 사용하면 개발자 머릿속에도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.

이름을 붙일 때는 일관성이 있어야 한다.
모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용하면 문체가 비슷하여 이야기를 순차적으로 풀어가기도 쉬워진다.

함수 인수

함수에서 이상적인 인수 개수는 무항(0)이고, 다음은 단항(1)이고, 다음은 이항(2)이다.
삼항(3) 이상은 가능한 피하는 편이 좋고, 다항(N)은 특별한 이유가 필요하다.

테스트 관점에서 보면 인수는 더 어렵다.
출력 인수는 입력 인수보다 이해하기 더 어렵다.

많이 쓰는 단항 형식

• 인수를 1개 넘기는 이유

  1. 인수에 질문을 던지는 경우
     • 좋은 예시) boolean fileExists("MyFile")
  2. 인수를 뭔가로 변환해 결과를 반환하는 경우
     • 좋은 예시) InputStream fileOpen("MyFile")

• 이벤트 함수

  • 출력 인수는 없고, 입력 인수만 있다.
    • 좋은 예시) passwrodAttemptFailedNtimes(int attempts)

• 변환 함수

  • 입력 인수를 그대로 돌려주더라도 변환 함수 형식을 따르는 편이 좋다.

플래그 인수

플래그 함수는 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 것과 다를 바 없다. 사용을 멀리하자.

이항 함수

인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
프로그램을 짜다보면 불가피한 경우도 생기지만, 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다.

삼항 함수

인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다.
인수의 순서, 주춤하고 무시하는 등의 문제가 두 배 이상으로 늘어난다.

인수 객체

인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.
Cicle makeCircle(double x, double y, double radius);
=> Cicle makeCircle(Point center, double radius);

인수 목록

때로는 인수 개수가 가변적인 함수도 필요하다.
String format("%s worked %.2f hours.", name, hours);
public static String format(String format, Object... args);

동사와 키워드

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

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

부수 효과 = 거짓말
함수에서 한 가지를 하겠다고 약속하고선 다른 짓도 한다.

많은 경우 시간적인 결합(Temporal Coupling)이나 순서 종속성(Order Dependency)을 초래한다.
시간적인 결합이 필요하다면 함수 이름에 분명히 명시하자.

출력 인수

우리는 인수를 함수 입력으로 해석한다.

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

명령과 조회를 분리하라!

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

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

오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

Try/Catch 블록 뽑아내기

Try/Catch 블록은 정상 동작과 오류 처리 동작을 뒤섞으므로 별도 함수로 뽑아내는 편이 좋다.

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

함수는 한 가지 작업만 해야 하므로 오류를 처리하는 함수도 오류만 처리해야 마땅하다.

Error.jaa 의존성 자석

오류 코드를 반환한다는 이야기는 어디선가 오류 코드를 정의한다는 뜻이며, 여러 클래스에서 오류 코드를 정의한 클래스를 사용하므로 다시 컴파일하고 다시 배치해야 한다. 그러므로 해당 클래스는 의존성 자석이다.

반복하지 마라!

중복을 없애면 모듈 가독성이 크게 높아진다.

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

구조적 프로그래밍

모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다.
즉, 함수는 return 문이 하나여야 한다는 말이다.
루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로 안 된다.

그러나 함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다. 때로는 단일 입/출구 규칙(Single Entry-Exit Rule)보다 의도를 표현하기 쉬워진다.

함수를 어떻게 짜죠?

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

그런 다음 코드름 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거하고, 메서드를 줄이고, 순서를 바꾼다. 때로는 클래스를 쪼개기도 한다.

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

결론

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

프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어가야 한다.