[3장] 함수
3장에서는 가장 기본적인 단위인 함수를 잘 만드는 법을 소개한다.
함수를 작게 만들어라
함수를 최대한 작게 만들자!
public static String renderPageWithSetupsAndTeardowns(PageData pageData, boolean isSuite) throws Exception {
boolean isTestPage = pageData.hasAttribute("Test");
if (isTestPage) {
WikiPage testPage = pageData.getWikiPage();
StringBuffer newPageContent = new StringBuffer();
includeSetupPages(testPage, newPageContent, isSuite);
newPageContent.append(pageData.getContent());
includeTeardownPages(testPage, newPageContent, isSuite);
pageData.setContent(newPageContent.toString());
}
return pageData.getHtml();
}
)
위 코드도 한번 리팩토링 한 버전인데 그래도 길다. 더 짧게 만들자.
public static String renderPageWithSetupsAndTeardowns(PageData pageData, boolean isSuite) throws Exception {
if (isTestPage(pageData))
includeSetupAndTeardownPages(pageData, isSuite);
return pageData.getHtml();
}
- if문 while 문 등에 들어가는 블록은 한 줄이어야 한다. -> 보통 거기서 함수를 호출
- 바깥을 감싸는 함수가 작아진다.
- 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드 이해도 쉬워진다.
- 중첩 구조가 생길 만큼 함수가 커져선 안된다.
- 들여쓰기 수준은 1단이나 2단을 넘어서면 가독성이 떨어진다.
한 가지만 해라!
함수는 한 가지를 해야하고 한 가지를 잘해야한다
- ‘한 가지’ 구분
- 추상화 수준에서 한 단계만 수행
- 의미 있는 이름으로 다른 함수를 추출할 수 있다면 한 가지X
- 한 함수에서 여러 섹션으로 나뉜다면 여러가지 작업을 하는 함수
함수 당 추상화 수준은 동일!
함수가 확실하게 한가지 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야한다. 특정표현이 근본개념인지 세부사항인지 구분해야한다.
내려가기 규칙
코드는 위에서 아래로 이야기처럼 읽여햐 좋다. 한 함수 다음에는 추상화 수준이 한단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아지는데 이것을 내려가기 규칙이라 부른다. 다르게 표현하면, 일련의 TO문단 (~하려면) 읽듯이 프로그램이 읽혀야 한다는 의미이다.
예시
To 설정 페이지와 해체 페이지를 포함하려면, 설정 페이지를 포함하고, 테스트 페이지 내용을 포함하고, 해제 페이지를 포함한다.
To 설정 페이지를 포함하려면, 슈트이면 슈트 설정 페이지를 포함한 후 일반 설정 페이지를 포함한다.
To 슈트 설정 페이지를 포함하려면, 부모 계층에서 "SuiteSetUp" 페이지를 찾아 include 문과 페이지 경로를 추가한다.
To 부모 계층을 검색하려면 ~~
함수 잘 만드는 법
swith 문은 작게 만들이 어렵다. 본질적으로 N가지를 처리하기 때문이다.
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);
}
}
위 함수의 문제점
- 함수가 길다 -> 직원 추가할때마다 길어짐
- 한가지 작업만 수행X
- SRP(Single Responsibility Principle,단일 책임 원칙) 위반
- OCP(Open Closed Principle,확장엔 열려있어야하고 수정에 닫혀 있어야한다.)위반
좋은 코드
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 SalariedEmploye(r);
default:
throw new InvalidEmployeeType(r.type);
}
}
}
- switch 문은 저차원 클래스에 숨기고 절대 반복하지 않는다 -> 다형성(Polymorohism) 사용
- switch 문을 추상팩토리에 숨겨서 다형적 객체를 생성하는 코드안에서만 switch 를 사용하도록 한다.
서술적인 이름을 사용하라
- 이름이 길어도 괜찮다. 일관적이고 서술적인 함수 이름으로 수행하는 기능이 무엇인지 그대로 짐작 가능하게 만들어야한다.
- 일관성있게 같은 문구, 명사 동사를 사용한다.
예시 includeSetUpandTearDownPages, includeSetUpPages, includeSuiteSetUpPage
함수 인수
인수 는 적을 수록 좋다.
- 입력 인수: 인수가 0개가 제일 좋고 차선으로 1개(단항)뿐인 경우
- 출력인수 : 코드를 재차 확인하는 번거로움 발생, 입력 인수가 없은 경우가 최선이다.
많이 쓰는 단항형식
- 인수에 질문을 던지는 경우 ex) boolean fileExists(“MyFile”)
- 인수를 뭔가로 반환해 결과를 반환 하는 경우 ex) InputStream fileOpen(“MyFile”); string형의 파일 이름을 InputStream으로 변환
- 이벤트 함수 인 경우 : 이벤트 함수는 입력 인수만 있고 출력 인수는 없다. ex) passwordAttemptsNTimes(int attempts);
위와 같은 경우가 아니라면 단항 함수는 가급적 피하는게 좋다.
플래그 인수
함수로 부울 값을 넘기는 플래그 인수는 끔찍하다. 함수가 한꺼번에 여러 가지를 처리한다고 공표하는 셈이기 때문이다.
이항 함수
인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
writeField(name) vs writeField(outputStream, name)
둘 다 의미는 명백하지만 전자가 더 쉽게 이해할 수 있다.
이항 함수가 적절한 경우도 있다. Point class 인 경우 오히려 인사가 1개면 더 놀란다
Point p = new Point(1, 1);
이항 함수가 무조건 나쁘다는 것은 아니다. 불가피한 경우도 있다. 하지만 가능하면 단항함수로 바꾸도록 애써야한다.
삼항 함수
인수가 3개인 함수는 훨씬 더 이해하기 어렵다. 삼항 함수를 만들 때는 더 신중히 고려하라 권고한다.
assertEquals(message, expected, actual); : 첫 인수가 expected 일 것이라고 예상하고 주춤하게 된다.
인수 객체
인수가 2~3개 필요하다면 일부를 독자적인 클래스 변수로 만들어 하나의 인수로 만드는 방법도 있다. 눈속임으로 여겨질 수도 있지만 인수도 줄일 수 있고 이름으로 개념을 표현할 수도 있다.
Circle makeCircle(double x, double y, double radius);
` Circle makeCircle(Point center, double radius);`
인수 목록
인수가 가변적인 함수가 필요할 때가 있다.
String.format("%s worked %.2f" hours.", name, hours);
public String format(String format, Object... args);
사실상 이항함수이다. 이와 같은 형식으로 단항, 이항, 삼항 함수로 취급할 수 있지만 이를 넘어서 인수를 사용하는 경우에는 문제가 있다.
동사와 키워드
단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
writeField(name); : 이름이 필드라는 사실을 알 수 있다.
아래는 함수 이름에 키워드를 추가하는 형식이다.
` assertEquals(expected, actual); -> assertExpectedEqualsActual(expected, actual);`
부수 효과를 일으키지 마라
함수에서 한 가지를 하겠다고 약속하고 남몰래 다른 짓을 하지 말아라는 말이다.
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를 확인하는 함수이다. 그런 함수에 세션 초기화를 호출한다. 함수의 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다. 차라리 위에 함수의 이름은
checkPasswordAndInitializeSession 이라는 이름이 훨씬 좋다. (함수가 한가지만 한다는 규칙은 위반)
출력 인수
- 일반적으로 프로그래머는 함수 인수를 입력 함수로 인지한다. 출력 인수는 피해야한다.
- 함수에서 상태를 변경해야한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
appendFooter(StringBuffer report) -> report.appendFooter()
명령과 조회를 분리하라
함수는 하나의 일만 해야한다.
- 뭔가를 수행한다. (객체 상태 변경) -> 명령
- 뭔가에 답한다.(객체 정보 반환) -> 조회
나쁜 예시 public boolean set(String attribute, String value);
이 함수는 이름이 attribute인 속성을 찾아 value를 설정한 후 성공하면 true, 실패하면 false를 반환한다. 다음은 이 함수를 쓰는 예시이다. if(set("username, "uncleBob")) 함수를 호출하는 코드만 봐선 의미가 모호하다.
개선
if (attributeExists("username")) {
setAttribute("username", "uncleBob");
...
}
명령과 조회를 분리해서 혼란을 방지한다.
오류 코드보다 예외를 사용하라
명령 함수에서 오류 코드를 반환 하는 방식의 문제점
- 오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야한다.
- 의존성 자석(dependency magnet): 아래와 같은 클래시를 의존성 자석이라 하는데 오류 코드를 반환하기 위해서는 다른 클래스에서도 error enum을 사용해야한다. 즉, Error enum이 변한다면 Error enum을 사용하는 클래스 전부를 다시 컴파일하고 배치해야한다.
나쁜 코드
public enum Error {
E_OK,
INVALID,
NO_SUCH,
LOCKED,
OUT_OF_RESOURCES,
WAITING_FOR_EVENT;
}
if (deletePage(page) == E_OK) {
if (registry.deleteReference(page.name) == E_OK) {
if (configKeys.deleteKey(page.name.makeKey()) == E_OK) {
logger.log("page deleted");
} else {
logger.log("configKey not deleted");
}
} else {
logger.log("deleteReference from registry failed");
}
} else {
logger.log("delete failed"); return E_ERROR;
}
개선방법 Try/Catch 를 사용해서 오류처리코드가 원래 코드와 분리되도록 해서 개선한다. 정삭동작과 오류 동작을 별도의 함수로 뽑아낸다.
좋은 코드
//오류 코드 대신 예외를 적용하여 오류 처리 코드가 원래 코드에서 분리되므로 깔끔해진다.
Good
try {
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
} catch (Exception e) {
logger.log(e.getMessage());
}
-->
//정상 동작과 오류 처리 동작을 try/catch 블록에서 별도의 '함수'로 뽑아낸다.
Excellent
public void delete(Page page) {
try {
deletePageAndAllReferences(page);
} catch (Exception e) {
logError(e);
}
}
//정상 동작
private void deletePageAndAllReferences(Page page) throws Exception {
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
}
//오류 처리 동작
private void logError(Exception e) {
logger.log(e.getMessage());
}
반복하지 마라!
중복은 소프트웨어에서 모든 악의 근원이다. 소스코드에서 중복을 제거하기 위해 지속적으로 노력하자.
구조적 프로그래밍
구조적 프로그래밍이란 구조화 프로그래밍으로도 불리며 프로그래밍 패러다임의 일종인 절차적 프로그래밍의 하위 개념으로 볼 수 있다. GOTO문을 없애거나 GOTO문에 대한 의존성을 줄여주는 것으로 가장 유명하다.
에츠허르 다익스트라(Edsger Dijkstra)는 구조적 프로그래밍 원칙을 따른다. 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야한다.
- 함수는 return 문이 하나여야한다.
- 루프 안에서 break, continue 를 사용해선 안된다.
- goto문은 절대로 사용해선 안된다.
위에서 말한 구조적 프로그래밍의 목표와 규율은 함수가 클때만 이익을 제공한다. 함수를 작게 만들었더라면 return, break, continue 를 여러차례 사용해도 괜찮다.
함수를 어떻게 짜죠?
끊임없이 고치고 문단을 정리하자.
- 들여쓰기 단계, 중복된 루프, 인수목록, 즉흥적인 이름, 중복 코드 -> 서투른 코드
- 서투른 코드로 단위 테스트 통과
- 리팩토링 : 코드 다듬기, 함수 만들기, 이름 바꾸기, 중복 제거, 메서드를 줄이고 순서 바꾸기, 클래스 쪼개기
- 단위 테스트 통과
Reference
- 클린코드 , 로버트C. 마틴
Leave a comment