Switch 문
switch문은 작게 만들기 어렵다. switch문을 완전히 피할 방법은 없다.
하지만 각 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다. 이는 다형성을 이용한 방법이다.
아래의 예시 함수를 보자.
// Payroll.java
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);
}
}해당 함수에는 몇 가지 문제가 있다.
-
함수가 길다.
새 직원 유형을 추가하면 더 길어진다. -
'한 가지' 작업만 수행하지 않는다.
-
SRP과 OCP를 위반한다.
코드를 변경할 이유가 여럿이며, 새 직원 유형을 추가할 때마다 코드를 변경한다.SRP : 단일 책임 원칙
어떤 클래스를 변경해야 하는 이유는 오직 하나 뿐이어야 한다.OCP : 개방 폐쇄 원칙
클래스, 모듈, 함수 등은 확장에 대해서는 열려 있어야 하지만
변경에 대해서는 닫혀 있어야 한다.
위의 문제를 해결한 코드는 아래와 같다.
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문을 사용하는 것을 허용하고 있다.
서술적인 이름을 사용하라!
코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.
이름은 길어도 괜찮다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
또한, 이름을 붙일 때는 일관성이 있어야 한다.
모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.
includeSetupAndTeardownPages,includeSetupPages,includeSuiteSetupPage등이 좋은 예시다.
함수 인수
함수의 인수는 적을수록 좋으며,
3개 이상은 가능한 피하는 편이 좋다.
4개 이상부터는 특별한 이유가 필요하다.
인수는 개념을 이해하기 어렵게 만든다.
코드를 읽는 사람이 인수를 발견할 때마다 의미를 해석해야한다.
public class SetupTeardownIncluder {
private PageData pageData;
private boolean isSuite;
private WikiPage testPage;
private StringBuffer newPageContent;
private PageCrawler pageCrawler;
// ...
}StringBuffer를 인스턴스 변수가 아닌 함수 인수로 넘긴다면,
코드를 읽는 사람은 StringBuffer를 발견할 때마다 의미를 해석해야 한다.
includeSetupPageInfo(newPageContent) 보다 includeSetupPageInfo()가 이해하기 더 쉽다. 이는 함수 이름과 인수 사이에 추상화 수준이 다른 것이 그 이유이기도 하다.
테스트 관점에서 보면 더 어려워진다.
테스트할 함수의 인수가 여러가지가 된다면 유효한 값으로 모든 조합을 구성해 테스트하기가 상당히 부담스러워진다.
많이 쓰는 단항 형식
함수에 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지다.
-
인수에 질문을 던지는 경우
-
인수를 뭔가로 변환해 결과를 반환하는 경우
다소 드물게 사용하지만 아주 유용한 단항 함수 형식이 이벤트(Event)이다.
이벤트 함수는 입력 인수만 있으며 출력 인수는 없다.
플래그(flag) 인수
플래그 인수는 추하다. 함수로 bool 값을 넘기는 관례는 정말 끔찍하다.
함수가 한꺼번에 여러 가지를 처리한다고 대놓고 알리는 셈이다.
이항 함수
인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
writeField(name)는 writeField(outputStream, name)보다 이해하기 쉽다.
후자의 경우, 첫 인수를 무시해야 한다는 사실을 깨닫는 시간이 필요하다. 그리고 그 사실이 결국은 문제를 일으킨다. 어떤 코드든 절대로 무시하면 안되니까. 무시한 코드에 오류가 숨어드니까.
이항 함수가 무조건 나쁘다는 소리는 아니다. 하지만 그만큼 위험이 따르며 가능하면 단항 함수로 바꾸도록 애써야 한다.
삼항 함수
인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 순서, 주춤, 무시로 야기되는 문제가 배가 된다. 삼항 함수를 만들 때는 신중히 고려하자.
인수 객체
인수가 2~3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다. 두 함수를 살펴보자.
Circle makeCircle(double x, double y, double radius);
Circle makeCircle(Point center, double radius);객체를 생성해 인수를 줄이는 방법은 눈속임으로 보일 수 있지만 그렇지 않다.
x와 y를 묶었듯이 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.
인수 목록
때로는 인수 개수가 가변적인 함수도 필요하다. String.format이 좋은 예다.
가변 인수 전부를 동등하게 취급하면 List형 인수 하나로 취급할 수 있다. 이런 논리로 따져보면 String.format은 사실상 이항 함수다. 실제 선언부를 살펴보면 이항 함수이다.
public String format(String format, Object... args)가변 인수를 취하는 모든 함수에 같은 원리가 적용된다. 가변 인수를 취하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있다. 하지만 이를 넘어서는 인수를 사용할 경우에는 문제가 있다.
동사와 키워드
함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.
부수 효과를 일으키지 마라!
부수 효과는 거짓말이다.
함수에서 한 가지를 하곘다고 약속하고선 남몰래 다른 짓도 한다. 때로는 예상치 못하게 클래스 변수를 수정한다. 때로는 함수로 넘어온 인수나 시스템 전역 변수를 수정한다.
아래의 함수를 보자.
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.getPhraseEncodedByPassword();
String phrase = cryptographer.decrypt(codedPhrase, password);
if ("Valid Password".equals(phrase)){
Session.initialize();
return true;
}
}
return false;
}
}함수는 표준 알고리즘을 사용해 userName과 password를 확인하여 두 인수가 올바르면 true를 반환하고 아니면 false를 반환한다. 하지만 함수는 부수 효과를 일으킨다.
함수가 일으키는 부수 효과는 Session.initialize() 호출이다.
함수 이름만 보고 함수를 호출하는 사용자는 사용자 인증을 하면서 기존의 세션 정보를 지워버릴 수도 있는 것이다.
이런 부수 효과가 시간적인 결함을 초래한다. 세션을 초기화해도 괜찮은 경우에만 호출이 가능하다. 특히 부수 효과로 숨겨진 경우에는 더더욱 혼란이 커진다.
명령과 조회를 분리하라!
함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 둘 다 하면 안된다.
객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.
public boolean set(String attribute, String value);위의 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true, 실패하면 false를 반환한다. 그래서 아래와 같이 괴상한 코드가 발생한다.
if( set("username", "unclebob") )...이를 보았을 때, 코드의 의미를 해석하기 어렵다. 진짜 해결책은 명령과 조회를 분리하여 혼란을 없애는 방법.
if (attributeExists("username")) {
setAttribute("username", "unclebob");
...
}