이전의 프로그래밍에서는 시스템이 루틴, 하위루틴, 혹은 포트란과 PL/1 시절에는 프로그램, 하위 프로그램, 함수로 나눴다.
결국 지금은 함수만 살아남았다. 어떤 프로그램이든 가장 기본적인 단위가 함수가 되었다.
이 장은 함수를 만드는 법을 소개한다.
이 책에서 보여주고있는 목록3-1 코드는, 길이가 길고, 중복된 코드에, 괴상한 문자열에, 낯설고 모호한 자료 유형과 API로 이루어져 있다.
이러한 코드를 3-2에서는 리팩토링하여서 보여주고 있다. 이로써 목록 3-1에서는 파악하기 어려웠던 정보가 목록 3-2에서는 쉽게 드러난다.
그렇다면 목록 3-2 함수가 읽기 쉽고 이해하기 쉬운 이유는 무엇일까? 의도를 분명히 표현하는 함수를 어떻게 구현할 수 있을까? 함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까?
작게 만들어라
함수를 작게 만드는 첫째 규칙은 '작게!'다. 함수를 만드는 둘째 규칙은 '더 작게!'다.
함수가 작을수록 더 좋다는 증거나 자료를 제시하기는 어렵다고 말한다. 하지만, 지난 40여년 동안 온갖 크기로 함수를 구현해보았다. 거의 3,000줄에 육박하는 끔찍한 함수도 짰다. 100줄에서 300줄에 달하는 함수도 많이 짰다. 20줄에서 30줄 정도인 함수도 짰다. 지금까지 경험을 바탕으로 그리고 오랜 시행착오를 바탕으로 나는 작은 함수가 좋다고 확신한다.
가로 150자를 넘어서는 안 된다. 함수는 100줄을 넘어서는 안 된다. 아니 20줄도 길다.
Sparkle이라는 프로그램은 모든 함수가 2,3,4줄 정도였다. 각 함수가 너무도 명백하고, 각 함수가 이야기 하나를 표현했다. 각 함수가 너무도 멋지게 다음 무대를 준비했다. 바로 이것이 답이다!
블록과 들여쓰기
다시 말해, if 문 / else 문 / while 문 등에 들어가는 블록은 한 줄 이어야 한다는 의미다. 대개 거기서 함수를 호출한다. 그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 코드를 이해하기도 쉬워진다.
이 말은 중첩 구조가 생길만큼 함수가 커져서는 안 된다는 뜻이다.
한 가지만 해라!
목록 3-1은 여러가지를 처리한다. 버퍼 생성, 페이지를 가져오고, 상속된 페이지를 검색하고, 경로를 렌더링하고, 불가사의한 문자열을 덧붙이고, HTML을 생성한다.
다음은 지난 30여년 동안 여러 가지 다양한 표현으로 프로그래머들에게 주어진 충고다.
함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
여기서 그 '한 가지'가 무엇인지 알기가 어렵다는 점이 중요하다.
지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다. 어쨋거나 우리가 함수를 만드는 이유는 큰 개념을 ( 다시 말해, 함수 이름을 ) 다음 추상화 수준에서 여러 단계로 나누어 수행하기 위해서가 아니던가.
함수 당 추상화 수준은 하나로!
함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다. 목록 3-1은 이 규칙을 확실히 위반한다.
getmHtml() 은 추상화 수준이 아주 높다. 반면, String pagePathName = PathParser.render(pagepath); 는 추상화 수준이 중간이다. 그리고 .append('\n') 와 같은 코드는 추상화 수준이 아주 낮다.
한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다. 하지만 문제는 이 정도로 그치지 않는다. 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.
위에서 아래로 코드 읽기 : 내려가기 규칙
코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. 나는 이것을 내려가기 규칙이라 부른다. 목록 3-7을 살펴보면, 각 함수는 다음 함수를 소개한다. 또한 각 함수는 일정한 추상화 수준을 유지한다.
Switch 문
switch 문은 작게 만들기 어렵다. case 분기가 단 두 개인 switch 문도 내 취향에는 너무 길며, 단일 블록이나 함수를 선호한다. 또한 '한 가지' 작업만 하는 switch 문도 만들기 어렵다. 본질적으로 switch 문은 N가지를 처리한다. 불행하게도 switch 문을 오나전히 피할 방법은 없다. 하지만, 각 switch 문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법은 있다. 물론 다형성(polymorphism)을 이용한다.
목록 3-4를 살펴보자. 직원 유형에 따라 다른 값을 계산해 반환하는 함수다.
public Money calculatePay(Employee e) throws InvalidEmployeeType {
switch (e.type) {
case COMMISSIONED:
return calculateCommissionedPay(e);
case HOURLY:
return calculteHourlyPay(e);
case SALARIED:
return calculateSalariedPay(e);
default:
throw new InvalidEmployeeType(e.type);
}
}위 함수에는 몇 가지 문제가 있다.
- 첫째, 함수가 길다 - 새 직원 유형을 추가하면 더 길어진다.
- '한 가지' 작업만 수행하지 않는다.
- SRP ( Single Responsibility Principle )를 위반한다. 코드를 변경할 이유가 여럿이기 때문이다.
- OCP ( Open Closed Principle )를 위반한다. 새 직원 유형을 추가할 때마다 코드를 변경하기 때문이다.
하지만, 가장 심각한 문제라면 위 함수와 구조가 동일한 함수가 무한정 존재한다는 사실이다. 예를 들어, 다음과 같은 함수가 가능하다.
isPayday(Employee e, Date date);
deliverPay(Employee e, Money pay);가능성은 무한하다. 그리고 모두가 똑같이 유해한 구조다.
이 문제를 해결한 코드가 아래의 목록 3-5다. 목록 3-5는 switch 문을 추상 팩토리 ABSTRACT FACTORY에 꽁꽁 숨긴다. 팩토리는 switch 문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다. calculatePay, isPayday, deliverPay 등과 같은 함수는 Employee 인터페이스를 거쳐 호출된다. 그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.
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 EmployeeFactor {
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문을 참아준다고 말한다.
서술적인 이름을 사용하라!
목록 3-7에서 나는 예제 함수 이름 testableHtml을 SetupTeardownIncluder.render로 변경했다. 함수가 하는 일을 좀 더 잘 표현함로 훨씬 좋은 이름이다. 그리고 나는 private 함수에도 isTestable, includesetupAndTeardownPages 등과 같이 서술적인 이름을 지었다. 좋은 이름이 주는 가치는 아무리 강조해도 지나치지 않다. "코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다." 는 워드의 원칙을 기억하라. 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.
이름이 길어도 괜찮다. 길고 서술적인 이름이 짧고 어려운 이름보다 좋다. 이름을 정하느라 시간을 들여도 괜찮다. 이런저런 이름을 넣어 코드를 읽어보면 더 좋다.
서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.
이름을 붙일 때는 일관성이 있어야 한다.
함수 인수
함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다.
최선은 입력 인수가 없는 경우이며, 차선은 입력 인수가 1개뿐인 경우다. SetupTeardownIncluder.render(pageDate)는 이해하기 아주 쉽다. pageData 객체 내용을 렌더링하겠다는 뜻이다.
많이 쓰는 단항 형식
함수에 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지다.
- 인수에 질문을 던지는 경우
- boolean fileExists("MyFile")
- 인수를 뭔가로 변환해 결과를 반환하는 경우다.
- InputStream fileOpen("MyFile") , String -> InputStream
다소 드물게 사용하지만 그래도 아주 유용한 단항 함수 형식이 이벤트다. 이벤트 함수는 입력 인수만 있다. 출력 인수는 없다. 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다. passwordAttemptFailedNtimes(int attempts)가 좋은 예다.
지금까지 설명한 경우가 아니라면 단항 함수는 가급적 피한다. 예를 들어, void includeSetupPageInfo(StringBuffer pageText)는 피한다. 변환 함수에서 출력 인수를 사용하면 혼란을 일으킨다. 입력 인수를 변환하는 함수라면 변환 결과는 반환값으로 돌려준다. StringBuffer transform(StringBuffer in)이 void transform(StringBuffer out)보다 좋다. StringBuffer transform(StringBuffeer in)이 입력 인수를 그대로 돌려주는 함수라 할지라도 변환 함수 형식을 따르는 편이 좋다. 적어도 변환 형태는 유지하기 때문이다.
플래그 인수
플래그 인수는 추하다. 왜냐고? 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까! 나누어라 함수를
이항 함수
인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다. 예를 들어, writeField(name)는 writeField(outputStream, name)보다 이해하기 쉽다. 둘다 의미는 명백하지만 전자가 더 쉽게 읽히고 더 빨리 이해된다. 물론 이항 함수가 적절한 경우도 있다. Point p = new Point(0,0)가 좋은 예다. 직교 좌표계 점은 읿낮거으로 인수 2개를 취한다. 코드가 new Point(0)라면 오히려 더 놀라리라! 이항 함수가 무조건 나쁘다는 소리는 아니다. 프로그램을 짜다보면 불가피한 경우도 생긴다. 하지만 단항 함수로 바꾸도록 애써야 한다. 예를 들어, writeField 메서드를 outputStream 클래스 구성원으로 만들어 outputStream.writeField(name)으로 호출한다. 아니면 outputStream을 현재 클래스 구성원 변수로 만들어 인수로 넘기지 않는다. 아니면 FieldWriter라는 새 클래스를 만들어 구성자에서 outputStream을 받고 write 메서드를 구현한다.
삼항 함수
삼항 함수를 만들 때는 신중히 고려하라 권고한다.
인수 객체
인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어 본다. 예를 들어, 다음 두 함수를 살펴보자.
Circle makeCircle(double x, double y, double radius);
Circle makeCircle(Point center, double radius);
인수 목록
때로는 인수 개수가 가변적인 함수도 필요하다. String.format 메서드가 좋은 예다.
String.format("%s worked %.2f hours.", name, hours);가변 인수 전부를 동등하게 취급하면 List 형 인수 하나로 취급할 수 있다. 이런 논리로 따져보면 String.format은 사실상 이항 함수다.
동사와 키워드
함수 이름에 키워드를 추가하는 형식이다. 즉, 함수 이름에 인수 이름을 넣는다. 예를 들어, assertEquals보다 assertExpectedEqualsActual(expected, actual)이 더 좋다. 그러면 인수 순서를 기억할 필요가 없어진다.
부수 효과를 일으키지 마라!
부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까. 때로는 예상치 못하게 클래스 변수를 수정한다. 때로는 함수로 넘어온 인수나 시스템 전역 변수를 수정한다.
목록 3-6을 살펴보자. 아주 무해하게 보이는 함수다. 함수는 표준 알고리즘을 사용해 userName과 password를 확인한다. 두 인수가 올바르면 true를 반환하고 아니면 false를 반환한다. 하지만 함수는 부수 효과를 일으킨다. 보이는가?
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".eqauls(phrase)) {
Session.initialize();
return true
}
}
return false;
}
}여기서 함수가 일으키는 부수 효과는 Session.initialize() 호출이다. checkPassword 함수는 이름 그대로 암호를 확인한다. 겉으로는 세션을 초기화 한다는 사실이 드러나지 않는다. 그래서 함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다.
이런 부수 효과가 시간적인 결합을 초래한다. 즉, checkPassword 함수는 특정 상황에서만 호출이 가능하다. 다시 말해, 세션을 초기화해도 괜찮은 경우에만 호출이 가능하다. 자칫 잘못 호출하면 의도하지 않게 세션 정보가 날아간다.
시간적인 결합은 혼란을 일으킨다. 특히 부수 효과로 숨겨진 경우에는 더더욱 혼란이 커진다. 만약 시간적인 결합이 필요하다면 함수 이름에 분명히 명시한다. checkPasswordAndInitializeSession 이라는 이름이 훨씬 좋다. 물론 함수가 '한 가지'만 한다는 규칙을 위반하지만.
출력 인수
일반적으로 우리는 인수를 함수 입력으로 해석한다. 예를 들어, 다음 함수를 보자.
appendFooter(s);이 함수는 무언가에 s를 바닥글로 첨부할까? 아니면 s에 바닥글을 첨부할까? 인수 s는 입력일까 출력일까?
public void appendFooter(StringBuffer report)인수 s가 출력 인수라는 사실은 분명하지만 함수 선언부를 찾아보고 나서야 알았다.
객체 지향 프로그래밍이 나오기 전에는 출력 인수가 불가피한 경우도 있었다. 출력 인수로 사용하라고 설계한 변수가 바로 this이기 때문이다. 다시 말해 appendFooter는 다음과 같이 호출하는 방식이 좋다.
report.appendFooter()함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
명령과 조회를 분리하라!
함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다. 객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.
public boolean set(String attribute, String value);이 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true를 반환하고 실패하면 false를 반환한다. 그래서 다음과 같이 괴상한 코드가 나온다.
if (set("username", "unclebob"))...해결책은 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법이다.
if (attributes("username")) {
setAttribute("username","unclebob");
...
}
오류 코드보다 예외를 사용하라!
명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 if 문에서 명령을 표현식으로 사용하기 쉬운 탓이다.
if (deletePage(page) == E_OK)위 코드는 동사/형용사 혼란을 일으키지 않는 대신 여러 단계로 중첩되는 코드를 야기한다. 오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.
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 {
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
}
catch (Exception e) {
logger.log(e.getmessage());
}
Try/Catch 블록 뽑아내기
try/catch 블록은 원래 추하다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.
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.getMessages());
}위에서 delete 함수는 모든 오류를 처리한다. 그래서 코드를 이해하기 쉽다. deletePageAndAllReferences 함수는 예외를 처리하지 않는다. 이렇게 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.
오류 처리도 한 가지 작업이다.
함수는 '한 가지' 작업만 해야 한다. 오류 처리도 '한 가지' 작업에 속한다. 그러므로 오류를 처리하는 함수는 오류만 처리해야 마땅하다. 함수에 키워드 try가 있다면 함수는 try 문으로 시작해 catch/finally 문으로 끝나야 한다는 말이다.
반복하지 마라!
어쩌면 중복은 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다. 자료에서 중복을 제거할 목적으로 관계형 데이터베이스에 정규 형식을 만들었다. 객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다. 구조적 프로그래밍, AOP, COP 모두 어떤 면에서 중복 제거 전략이다.
구조적 프로그래밍
어떤 프로그래머는 Dijkstra의 구조적 프로그래밍 원칙을 따른다. 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다. 즉, 함수는 return 문이 하나여야 한다는 말이다. 루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로, 절대로 안된다.
목표와 규율은 공감하지만, 함수가 작다면 위 규칙은 별 이익을 제공하지 못한다. 함수가 아주 클 때만 상당한 이익을 제공한다.
그러므로, 함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다. 오히려 때로는 의도 표현하기가 쉬워진다.
반면, goto 문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야만 한다.
함수를 어떻게 짜죠?
소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다. 다듬고 고치고 정리한다.
함수를 짤 때도 마찬가지다. 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다. 이름은 즉흥적이고 코드는 중복된다. 하지만 나는 그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다. 이 와중에도 코드는 항상 단위 테스트를 통과한다.
최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다. 처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.
결론
함수는 동사며, 클래스는 명사다. 프로그래밍의 기술은 언제나 언어 설계의 기술이다.
프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.
여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나오리라.
하지만 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하기 바란다. 여러분이 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다는 사실을 기억하기 바란다.
'개발 > 클린 코드' 카테고리의 다른 글
| 클린코드 5장 - 형식 맞추기 (0) | 2021.04.14 |
|---|---|
| 클린코드 4장 - 주석 (0) | 2021.04.13 |
| 클린코드 2장 - 의미 있는 이름 (0) | 2021.04.07 |
| 클린코드 1장 - 깨끗한 코드 (0) | 2021.04.05 |
| 클린코드 정리를 시작하며.. (0) | 2021.04.05 |
