작게 만들어라
함수를 작게 만들어라. 함수를 작게 만들어야 한 눈에 파악하기 쉽다. 하나의 함수는 15줄을 초과하면 안된다. 함수 내부에서 조건문, 반복문을 사용할때 들여쓰기의 depth가 2를 넘기지 말아야 한다. 이를 위해서는 조건문, 반복문 내부에서 함수를 호출하면 된다. 그러면 바깥을 감싸는 함수(enclosing function)이 작아진다. 또 한 블록안에서 호출하는 함수 이름이 적절하면 코드를 이해하기 쉬워진다.
한 가지만 해라!
함수는 한 가지 일만을 해야 한다. 제발 한 가지 일만 하게 하자.
여기서 말하는 한 가지 일은 지정한 하나의 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행하는 것을 의미한다. 즉, 함수이름으로 정해진 한가지 일 만을 수행한다면 그 함수는 한가지 일만을 하는 것이다.
함수 당 추상화를 하나로!
함수가 확실히 '한 가지'작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다. 여기서 말하는 추상화는 함수의 호출이다. 예를 들어 getHtml()은 추상화 수준이 높다. String pagePathName = PathParse.render(pagepath);는 추상 화 수준이 중간이다. .apeend("\n");는 추상화 수준이 아주 낮다.
한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헛갈린다. 특정 표현이 근본 개념인지, 세부사항인지 구분하기 어 려운 탓이다. 근본 개념과 세부사항이 뒤섞기기 시작하면 사람들이 함수에 세부사항을 점점 더 추가하게 되고 이는 스프게 티 코드가 된다.
위에서 아래로 코드 읽기: 내려가기 규칙
코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.
추상화 수준이 하나인 함수를 구현하기란 쉽지 않다. 하지만 매우 중요한 규칙이며 함수는 짧으면서도 '한 가지'일만 해야 한다.
Switch 문
Switch문과 if else if 같은 조건문은 작게 만들기 어렵다. 본질적으로 switch문은 N 가지 일을 처리하기 때문에 함수는 '한 가지' 일만을 처리해야 한다는 것에도 위반된다.
물론 switch 문을 완전히 사용하지 않는 것은 어렵다. 하지만 다형성을 사용하면 각 switch문을 저차원 클래스에 숨기고 반복하지 않을 수 있다.
|
1
2
3
4
5
6
7
8
9
10
|
public Money calculatePay(Employee e) throws InvalidEmployeeType {
switch (e.type) {
case COMMISSIONED:
return calculateCommissionedPay(e);
case HOURLY:
return calculateHourlyPlay(e);
default:
throw new InvalidEmployeeType(e.type);
}
}
|
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
abstract class Employee {
public abstract boolean isPayDay();
public abstract Money calculatePay();
public abstract void deliverPay(Money pay);
}
interface EmployeeFactory {
public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}
public class EmployeeFactoryImpl implements EmployeeFactory {
@Override
public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
return switch (r.type) {
case COMMISSIONED -> calculateCommissionedPay(e);
case HOURLY -> calculateHourlyPlay(e);
default -> throw new InvalidEmployeeType(e.type);
}
}
}
|
cs |
서술적인 이름을 사용하라
코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 된다. 함수는 작고 단순할 수록 서술적인 이름을 붙이기 쉬워진다.
이름이 길어도 괜찮다. 길고 서술적인 이름이 짧고 어려운 이름이나 길고 서술적인 주석보다 좋다.
이름을 정하느라 긴 시간을 들여도 괜찮다. 이런저런 이름을 시도해 보고 최대한 서술적인 이름을 골라라.
서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지기 때문에 코드를 개선하기 쉬워진다.
이름을 붙일때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용해야 한다. includeSetupAndTeardownPages, includeSetupPages, includeSuitSetupPage 등이 그 예시이다.
함수 인수
함수에서 가장 이상적인 인수는 0개(무항)이다. 1개(단항), 2개(이항) 까지도 괜찮다. 3개(삼항)은 피하는 것이 좋고 4개(다항)부터는 특별한 이유가 있어도 사용하면 안된다. 인수가 있으면 읽는 사람이 그 인수의 의미를 해석해야 한다. 또 한 코드를 읽는 사람이 현 시점에서 별로 중요하지 않은 세부사항을 알아야 한다.
테스트 관점에서도 많은 인수는 부담스럽다. 인수가 있으면 그 인수 케이스에 맞게 모든 조합을 구성해 테스트해야 한다.
출력 인수는 입력 인수보다 이해하기 어렵다. 대부분의 사람들은 함수에다 인수로 입력을 넘기고 반환값으로 출력을 하는 것에 익숙하다. 따라서 출력 인수는 코드를 읽는 사람이 코드를 재차 확인하게 한다.
많이 쓰는 단항 형식
통상적으로 단항 인수 함수는 다음과 같은 경우에 사용한다.
1. 인수에 질문을 던지는 경우: boolean fileExists("someFile");이 그 예시다.
2. 인수를 이용해 무엇인가 결과를 반환해야 하는 경우: InputStream fileOpen("someFile");은 String을 InpuStream 으로 변환한다.
3. 다소 드물지만 단항 함수 형식 이벤트를 사용할 경우: 프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상 태를 바꾼다. passwordAttemptFiledNtimes(int apptemts)가 그 예시다. 이벤트 함수는 이벤트라는 사실이 코드에 명확이 들어난다.
플래그 인수
플래그 인수를 사용하지 말라. 인자로 boolean값을 넘긴다는 것은 대놓고 해당 함수가 두 가지 일을 한다고 공표하는 것 과 같다. 함수는 한 가지 일만 해야 한다.
이항 함수
이항 함수는 단항 함수보다 이해하기 어렵다. 예를 들어 writeFiled(name)은 writeFiled(outputStream, name)보다 이해하기 쉽다. 이 예시의 경우 두 개의 인자를 보고 잠시 주춤한 뒤 우선적으로 outputStream을 무시해야 한다는 사실을 알게 된다. 바로 이 점에서 버그가 발생한다. 어떤 코드든 절대 무시하면 안된다. 무시된 코드는 버그를 발생시킨다.
물론 이항 함수를 사용해야 하는 경우도 있다. x, y좌표를 넘길 경우가 그 예시다. 하지만 이 예시의 경우 두 개의 인자는 하나의 값을 의미하는 두 요소다. 반면 outpuStream과 name은 하나의 값을 위한 요소들이 아니다.
이항 함수를 사용하지 말라는 의미가 아니다. 이항 함수를 사용해야 할 경우도 있다. 단지 그에 상응하는 위험이 따른다는 것을 인지하고 가급적이면 단항 함수를 사용해야 한다.
삼항 함수
인수가 3개인 함수는 이항 함수와 같이 더 이해하기 어렵다. 따라서 굳이 삼항 함수를 만들어야 하는지 신중히 고려해야 한 다.
인수 객체
인수가 2-3개 필요하다면 클래스 변수로 선언해도 좋다. 객체를 생성해 인수를 줄이는 것은 눈속임이 아니다. 변수를 묶어 서 넘기려면 이름을 붙여야 하기 떄문에 개념을 표시하게 된다.
예시:
Circle makeCircle(double x, double y, double radius);
Circle makeCircle(Point center, double radius);
인수 목록
인수 개수가 가변적인 함수를 사용할때 역시 위와 같은 원리가 적용된다. 가변 인수를 취하는 함수는 단항, 이항, 삼항 함. 수로 취급한다. 이 역시 삼항 함수를 넘기지 말라. 예시: void function(String name, Integer ... args).
동사와 키워드
함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
함수에 키워드를 추가하는 것 역시 좋은 방식이다. 예를 들어 assertEuals(expected, actual)보다 assertExpectedEqualsActual(expected, actual)이 더 좋다.
Side effect를 일으키지 말라
Side effect는 시간적 결합(temporal coupling) 또는 순서 종속성(order dependency)을 초래한다.
시간적 결합: 동시성(같은 시각에 일어나는 일들)과 순서(시간 속에서 일들의 상대적인 위치). 동시성을 허용하고 순서에 따른 의존성의 결합을 끊어야 한다.
아래의 예제를 보자
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
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;
}
}
|
cs |
이 예제에서는 Session.initialize()가 side effect를 야기한다. checkPassword라는 메서드 이름만을 가지고는 이 메서드가 세션을 초기화 한다는 것이 들어나지 않는다. 따라서 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다. 따라서 시간적 결합을 야기하고 시간적 결합은 혼란을 야기한다. 시간적 결합으로 인한 혼란은 특히 사이드 이펙트가 숨겨진 경우에 더 커진다.
만약 시간적 결합이 반드시 필요하다면 반드시 함수 이름에 명시해야 한다. 위 메서드 같은 경우 checkPasswordAndInitializeSession 이라는 이름이 더 적절하다. 물론 이 메서드는 '한 가지' 일만을 한다는 규칙을 위반한다.
출력 인수
일반적으로 개발자는 인수를 함수 입력으로 해석한다. 따라서 인수를 출력으로 사용하면 어색한 감이 있다. appendFooter(s);를 예로 들어보자. 이것만으로는 s를 바닥글로 첨부하는 건지, s에 바닥글을 첨부하는 건지 알 수 없다. 또 한 인수 s가 입력인지, 출력인지도 알 수 없다. 즉, 이런 코드는 인지적으로 거슬리기 때문에 피해야 한다.
객체지향 언어에서는 출력 인수를 사용할 이유가 없다. 출력 인수로 사용하라고 설계한 변수가 this 이기 때문이다. 따라 서 appendFooter 메서드는 다음과 같이 출력하는 것이 좋다. report.appendFooter().
일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
명령과 조회를 분리하라
함수는 뭔가를 수행하거나 뭔가를 답하거나 둘 중 하나만 해야 한다. 객체 메서드에서는 객체 상태를 변경하거나 객체 정보를 반환하거나 둘 중 하나만 해야 한다. 이 둘을 하나의 메서드에서 실행하면 혼란을 야기한다.
아래의 예시를 보자.
public boolean set(String attribute, String value); // 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true를, 실패하면 false를 반환한다.
위 메서드는 객체 상태 변경과 정보 반환을 동시에 하고 있다. 따라서 다음과 같은 괴상한 코드가 나온다.
if(set("username", "unclebob"))...
이 부분만 봐서는 "username"을 "unclebob"로 설정되어 있는지 확인을 하는 건지 실제로 설정을 하는 것지 구분이 안된다. 또 한 개발자는 set을 동사로 의도하고 작성했겠지만 if문 때문에 읽어보면 "username을 unclebob으로 설정되어 있다면..."으로 읽힌다.
물론 set을 setAndCheckIfExists로 바꾸어도 되지만 근본적인 해결책은 명령과 조회를 분리하는 것이다.
if(attributeExists("username")) { setAttribute("username", "uncleboob"); ... }
오류 코드보다 예외를 사용하라
명령 함수에서 오류를 반환하는 방식은 명령 / 조회 분리 규칙을 미묘하게 위반한다. 이는 if문에서 명령을 표현식으로 사용하기 쉬운 이유다.
if(deletePage(page) === E_OK)
위 코드는 여러 단계로 중첩되는 코드를 야기한다. 오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제제 부딪힌다.
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
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;
}
|
cs |
위 코드에서 오류 코드 대신 예외를 사용하면 다음과 같이 깔끔해 진다.
|
1
2
3
4
5
6
7
|
try {
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
} catch (Exception e) {
logger.log(e.getMessage());
}
|
cs |
try / catch 블록 뽑아내기
try / catch 블록은 추하다 . 코드 구조에 혼란을 일으키고 정상 동작과 오류 처리 동작을 뒤섞는다. 따라서 try / catch 블 록을 별도의 함수로 뽑아내야 한다.
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
private void deletePageAndAllReferences(Page page) throws Exception {
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
}
public void delete(Page page) {
try {
deletePageAnddAllReferences(page);
} catch (Exception e) {
logError(e);
}
}
|
cs |
위코드는 delete함수에서 오류 처리를 하고 실질적인 페이지 제거는 deletePageAndAllReferences 메서드가 수행하며 에러를 처리하지 않는다.
오류 처리도 한 가지 작업이다.
오류 처리도 '한 가지' 작업이다. 따라서 오류를 처리하는 함수는 오류만 처리해야 한다.
Error.java 의존성 자석(magnet)
오류 코드를 반환한다는 것은 어떤 식으로든 오류 코드를 정의한다는 의미이다. 아래와 같은 클래스는 의존성 자석이다.
|
1
2
3
4
5
|
public enum Error {
OK,
INVALID,
NO_SUCH;
}
|
cs |
다른 클래스에서 Error enum을 import해 사용해야 한다. 따라서 Error enum이 변하면 import한 클래스를 전부 다시 컴파일하고 다 시 배치해야 한다. 그래서 Error 클래스 변경이 어려워진다.
오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다. 따라서 재컴파일 / 재배치가 없어도 새 예외 클래스를 추가 할 수 있다(개방 폐쇄 원칙).
반복하지 마라
반복된 코드는 코드의 길이가 늘어나게 하고 한번에 여러 곳을 수정하게 해 버그를 야기한다. 중복을 없애는 것은 가독성을 높인다.
중복된 코드는 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다. 객체지향 프로그래밍은 코드를 부모에 몰아 중복을 없앤다. 구조적 프로그래밍, AOP(Aspect Oriented Programming), COP(Component Oriented Programming) 모두 어떤 면에서 중복 제거 전략이다.
구조적 프로그래밍
어떤 프로그래머는 에츠허르 데이크스트라(Edsger Djikstra)의 구조적 프로그래밍 원칙을 따른다. Djikstra는 모든 함수와 함수 내 모든 블록의 입구와 출구가 하나만 존재해야 한다 했다. 즉, 함수는 return문이 하나여야 한다는 의미다. 루프 안에서 break, continue, goto를 사용해서는 안된다.
이런 구조적 프로그래밍은 함수가 작다면 별다른 이익이 없다. 따라서 함수가 작다면 return, break, continue를 여러 차례 사용해도 된다. 반면 goto문은 큰 함수에서만 의미가 있으므로 작은 함수에서는 피해야 한다.
함수 작성법
소프트웨어를 짜는 행위는 글짓기와 비슷하다. 글을 지을때는 생각을 나열하고 그 생각을 보기 좋게, 읽기 좋게 다듬는다.
함수를 작성할때도 마찬가지다. 처음에는 길고 복잡한 함수를 작성하지만 코드를 빠짐없이 테스트 하는 유닛 테스트 케이스를 통해 함수의 정상 작동 여부를 검증하면서 코드를 다음고, 더 좋은 이름을 사용하고, 중복을 제거해야 한다.
결론
모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한 도메인 특화 언어(Domain Specific Language - DSL)로 만들어진다. 함수는 그 언어에서 동사며, 클래스는 명사다. 요구사항 문서에 나오는 명사와 동사를 클래스와 함수 후보로 고려하는 것은 오래된 진실이다. 프로그래밍의 기술은 언제나 언어 설계의 기술이다.
대가(master) 프로그래머는 시스템을 구현할 프로그램이 아니라 풀어갈 이야기로 여긴다. 프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현이 강력한 언어를 만들어 이야기를 풀어간다. 시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 바로 그 언어에 속한다. 재귀라는 기교로 각 동작은 바로 그 도메인에 특화된 언어를 사용해 자신만의 이야기를 풀어나간다.
출처 - 클린코드