[Clean Code] 3장 함수

『Clean Code(클린 코드) 애자일 소프트웨어 장인 정신 - 로버트 C. 마틴』 을 읽고 요약한 내용입니다.

함수를 잘 만드는 법

작게 만들어라!
- 블록과 들여쓰기중첩구조가 생길만큼 함수가 커져서는 안 된다.
- if문 else문 while문 등에 들어가는 블록은 한 줄이어야 한다는 의미다. 대개 거기서 함수를 호출한다. 그러면 바깥을 감싸는 함수(enclosing function)가 작아질 뿐 아니라, 블록안의 함수명이 적절하다면 코드 이해가 쉬워진다.
한 가지만 해라!
- 함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
- 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.
- 단순히 다른 표현이 아니라 의미있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다.
- 함수 내 섹션
- 한 가지 작업만 하는 함수는 자연스럽게 섹션으로 나누기 어렵다.
함수 당 추상화 수준은 하나로!
- 함수가 확실히 ‘한 가지’ 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다
- 위에서 아래로 코드읽기 : 내려가기 규칙
- 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다.
Switch문
- 본질적으로 switch문은 N가지를 처리한다. 완전히 피할 방법은 없으므로 각 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다. 다형성(polymorphism)을 사용한다.

// switch문은 추상 팩토리에 숨긴다.
public interface EmployeeFactory {
	public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}

// 팩토리는 switch문을 사용해 적절한 Employee파생 클래스의 인스턴스를 생성한다
public class EmployeeFactoryImp implements EmployeeFactory {

	public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
	
		switch(r.type) {
			case COMMISSIONED:
				return new ComissionEmployee(r);
			case HOURLY:
				return new HourlyEmployee(r);
			case SALARIED:
				return new SalariedEmployee(r);
			default:
				throw new InvaildEmployeeType(r.type);
		}
	}
}
// calcutatePay() , isPayday()와 같은 함수는 Employee인터페이스를 거쳐 호출된다

서술적인 이름을 사용하라!
- 이름이 길어도 괜찮다. 겁먹을 필요없다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.(p.49)
- 서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다
함수 인수
- 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상(다항)은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다.
- 인수는 개념을 이해하기 어렵게 만든다.
- 테스트 케이스를 생각해보라. 인수가 많을수록 조합을 찾아 테스트하기 매우 까다롭다.
  - 많이 쓰는 단항 형식
    - 가장 흔한 경우
      1. 인수에 질문을 던지는 경우 boolean fileExists(“MyFile”)
      2. 인수를 뭔가로 변환해 결과를 반환하는 경우 InputStream fileOpen(“MyFile”)
      3. 이벤트 함수. 입력인수만 있다. 출력인수는 없다. 함수 호출을 이벤트로 인식해 입력인수로 시스템 상태를 바꾼다.
    - 이러한 경우가 아니라면 단항함수는 가급적 피하자.
  - 플래그 인수
    - 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까!
  - 이항 함수
    - 인수가 2개면 1개보다 이해하기 어렵다. 그리고 무시하는 인수라고 깨닫고 무시하면 문제가 발생하기 쉽다.
    - assertEquals(expected, actual)도 문제가 있다. expected인수에 actual를 넣는 경우가 얼마나 많은가?
  - 삼항 함수
    - 순서,주춤,무시로 야기되는 문제가 2배이상 늘어난다.
  - 인수 객체
    - 객체로 인수를 줄이는 방법은 개념을 표현하게 된다.
    - Circle makeCircle(double x, double y,double radius);
    - Circle makeCircle(Point center, double radius);
  - 인수 목록
    - 때로는 인수 개수가 가변적인 함수도 필요하다.
    - String.format()
  - 동사와 키워드
    - 함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
    - write(name) → writeField(name)
    - 함수 이름에 키워드를 추가하자.
    - assertEquals → assertExpectedEqualsActual(expexted, actual)
부수 효과를 일으키지 마라!
- 때로는 예상치 못하게 클래스 변수를 수정, 함수로 넘어온 인수나 시스템 전역변수를 수정한다.예) checkePassword()함수에서 암호를 확인하고 session.initialize()를 호출하여 세션을 초기화시키는 경우. 이 함수는 세션을 초기화해도 괜찮은 경우에만 호출 가능해진다.→ 시간적인 결합을 초래한다. 즉, 특정 상황에서만 호출이 가능하다.
- 많은 경우 시간적인 결합temporal coupling, 순서 종속성order dependency을 초래한다.
- 부수 효과는 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 것도 하니 거짓말이다.
명령과 조회를 분리하라!
- 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘 다 하면 안 된다. 객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다. 둘 다 하면 혼란을 초래한다.
오류 코드보다 예외를 사용하라!
- 명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 if문에서 명령을 표현식으로 사용하기 쉬운 탓이다.
- if(deletePage(page) == E_OK)
Try/Catch 블록 뽑아내기
- try/catch 블록은 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 try/catch 불록을 별도 함수로 뽑아내는 편이 좋다.
- 오류 처리도 한 가지 작업이다
- 함수는 ‘한 가지’작업만 해야 한다.
Error.java 의존성 자석
- 오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.
- 의존성 자석 : 다른 클래스에서 Error enum을 import해 사용해야 하므로 변경이있으면 클래스를 다시 컴파일해 배치해야 한다.
반복하지 마라!
- 객체지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다. 구조적 프로그래밍, AOP Aspect Oriented Programming, COP Component Oriented Programming 모두 어떤 면에서 중복 제거 전략이다.
구조적 프로그래밍
- 데이크스트라 : 모든 함수와 함수 내 모든 블록에 입구entry 와 출구exit가 하나만 존재해야 한다
- 즉, return문이 하나여야 한다. 루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로 안된다.
- 함수가 작다면 간혹 return,break,continue를 여러차례 사용하는 것이 의도를 표현하기 쉬울때도 있다.
함수를 어떻게 짜죠?
- 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다. 이름은 즉흥적이고 코드는 중복된다. 하지만 그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
- 그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다. 그와중에도 코드는 항상 단위테스트를 통과한다.
결론
- 대가 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이야기로 여긴다. 프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.
- 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다.
- 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다는 사실을 명심하자.

리팩토링을 통해 함수는 한가지 역할만 하도록 하면서도 테스트코드에 통과하도록 해야된다. 이것이 3장의 포인트라는 생각이 든다. 사실 실무에 처음 투입되었을때, 내가 일했던 프로젝트들이 테스트코드를 필수로 요하지않아 테스트코드 작성에 소홀했었다. 그래서 테스트코드가 중요하지 않은줄 알았다. 내 눈과 머리로 확인하면서, 디버그 모드로 값을 확인했었다. 내가했었던 그 과정들이 불편한지도, 내 머리를 믿어서는 안된다는 사실을 망각했었다.

함수는 한가지 역할만 하면서도 테스트코드에 통과하도록 작성하도록 해야한다.

티스토리툴바