[Clean Code] 3. 함수
함수란 단위는 어떤 프로그램이든 가장 기본적인 단위다. 이 장에서는 함수를 잘 만드는 방법을 소개한다고 한다.
작게 만들어라
함수를 만드는 첫째 규칙은 작게, 가능하면 더 작게이다. if / else / while 과같은 문에 들어가는 블록 한줄로 함수를 호출하고 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.
한가지만 해라!
함수의 역할은 한가지만 한다. 그 한가지를 잘해야 한다. 그 한가지 만을 해야한다. 추상화 수준이 하나인 단계만 수행하도록 하자.
함수당 추상화 수준은 하나로!
한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 근본개념과 세부사항을 뒤섞기 시작하면 함수에 세부사항을 추가할때 점점 더 섞이기 시작한다.
위에서 아래로 코드 읽기: 내려가기 규칙
- 코드는 위에서 아래로 이야기 처럼 읽히면 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 오는 것이다.
추상화 수준이 하나인 함수를 구현하는 것은 쉽지 않지만 매우 중요하다.
Switch 문
switch문은 작게 만들기 어렵고, 한가지 작업만 하는 switch문을 만들기도 어렵다. 하지만 각 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다. (다형성을 이용)
public Money calculatePay(Employee e)
throws InvalidEmployeeType {
switch (e.type) {
case COMMISSIONED:
return caculateCommissionedPay(e);
case HOURLY:
return calculateHourlyPay(e);
case SALARIED:
return calculateSalariedPay(e);
default:
throw new InvalidEmployeeType(e.type);
}
}
위 함수의 문제점
- 함수가 길다.
- ‘한 가지’ 작업만 수행하지 않는다.
- SRP(단일 책임 원칙)을 위반한다.
- OCP(개방 폐쇄의 원칙)을 위반한다. - 새 직원 유형을 추가할 때 마다 코드를 변경해야 한다.
- 위 함수와 구조가 동일한 함수가 무한정 존재할 수 있다.
- 구조가 동일한 함수 예시: isPayDay(Employee e, Date date) or deliverPay(Employee e, Money pay)
- SRP(Single Responsibility Principle) : SOLID 5대 원칙중 S에 해당하며, 모든 클래스는 하나의 책임을 가지며 그 책임을 수행 하는데 집중되어 있어야한다 .
- OCP(Open Closed Principle) : SOLID 5대 원칙중 O에 해당하며, 확장에는 열려있으며, 변경에는 닫혀 있어야한다.
위 문제의 해결 방법 : 추상 팩토리 패턴(Abstract Factory Pattern)
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 SalariedEmployee(r);
default:
throw new InvalidEmployeeType(r.type);
}
}
- Switch문은 추상 팩토리(EmployeeFactoryImpl)에 꽁꽁 숨긴다.
- Factory는 적절한 Employee의 파생클래스(CommissionedEmployee, HourlyEmployee, SalariedEmployee) 와 같은 인스턴스를 생성한다.
- calculatePay, isPayday, deliverPay와 같은 함수는 Employee 인터페이스를 거쳐 호출한다.
- 그러면 다형성으로 인해 실제 파생클래스의 함수가 실행된다.
서술적인 이름을 사용하라!
길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 또한 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
함수 인수
이상적인 인수 개수는 0개(무항)다. 그다음은 1개, 2개이며 3개 이상은 가능한 피하는 편이 좋다. 테스트 관점에서 보아도 인수는 더 어렵다. 함수에다 인수를 넘기고 반환값으로 출력을 받는다는 개념에 익숙하다. 대개 함수에서 인수로 결과를 받으리라 기대하진 않는다.
많이 쓰는 단항 형식
함수에 인수를 넘기는 좋은 경우 두가지
- 인수에 질문을 던지는 경우
boolean fileExist("MyFile")
- 인수를 뭔가로 변환해 결과를 반환하는 경우
InputStream fileOpen("MyFile") //String 형의 파일이름을 InputStream으로 변환한다
또한 일관적 방식 으로 두 형식을 사용해라.
플래그 인수
- 플래그 인수는 함수가 한꺼번에 여러가지를 처라힌다라는걸 의미하므로 최대한 피하고 함수를 나누자
부수 효과를 일으키지 마라!
함수에서 한가지를 하겠다고 약속했다면, 한가지만 하도록 하자, 단 함수안에서 추가 기능이 있다면 메서드명에 표현해주자
출력 인수
- 우리는 인수를 입력 으로 보통 해석한다.
명령과 조회를 분리하라!
- 함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야한다.
오류코드보다 예외를 사용하라
명령함수에서 오류코드를 반환 할때는 명령/조회 분리 규칙을 미묘하게 위반한다. if문으로 처리하지 말고 try/catch로 처리하자. try/catch 블록을 뽑아낼때는 별도의 함수로 뽑아내자. 함수는 ‘한가지’ 작업만 해야한다. 오류를 처리하는 함수는 오류만 처리해야 마땅하다.
반복하지마라!
코드의 길이가 늘어날 뿐 아니라 알고리즘이 변할시 네 곳이나 손봐야 한다. 관계형 데이터베이스에서 정규 형식을 만든 이유는 중복을 없애거나 제어할 목적으로 만들었다. 객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다. AOP, COP 모두 어떤면에서는 중복 제거 전략이다.
구조적 프로그래밍
return문을 하나만 사용하자, 또한 loop 안에서 break나 continue 그리고 절때로 goto는 사용하지 말자. 함수를 작게 만든다면 간혹 return, break, continue를 여러차례 사용하기도 한다 (의도를 표현하기 쉽다고 판단될 때) 그러나 goto는 절때로 사용하지 말자
마치면서..
코드의 중복을 줄이기 위해, 기능들을 묶기만 했던 기억이 난다. 책에서 이야기한 방향이 아니라 단순 중복코드를 줄이기 위해서였다.
그러나 그 방법은 의존도만 키우면서, 좋지 못한방법이었고 추가기능을 넣거나 수정했을때 다른 코드에 전부 영향이 갔었다.
‘함수’ 장을 읽으면서 어떻게 짜야할지, 개발중인 시스템엔 어떻게 접목시킬지라는 막막한 생각이 들기도 하지만
계속 의문을 던지면 지금보다는 더 나은 코드가 나올수도 있지 않을까? 생각해본다.
Leave a comment