1. 작게 만들어라.
20줄도 길다. 하나의 함수는 5줄 이내면 충분하다.
2. 한 가지 일 만 하게하라.
함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
하나의 함수 안에서 추상화 수준이 하나인 단계만 수행한다면, 그 함수는 하나의 일만 한다.
>> 하나의 함수 안에서는 동일한 추상화 수준을 유지한다.
기존의 코드에서 의미있는 이름으로 새로운 함수를 추출할 수 있다면, 그 함수는 하나의 일만 하고 있는 것이 아니다.
3. 함수당 추상화 수준은 하나로.
추상화 수준이 높은 것 : 함수가 포함하는 기능, 그 함수의 뒤에서 일어나는 일이 많다는 것.
ex) getHtml()
추상화 수준이 낮은 것 : 그 함수 하나로 작은 기능 하나가 실행되는 것
ex) .append("!");
이 높고 낮음이 하나의 함수 안에서는 일정해야 한다.
그렇지 않으면, 특정 표현이 근본 개념인지 세부 사항인지 구분하기가 어렵다.
4. 내려가기 규칙(위에서 아래로 코드 읽기)
코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
위에서 아래로 하는 하는 일이 순차적으로 함수가 나열되어야 한다.
이는 곧 함수의 추상화 레벨이 위는 높은 것에서 부터 아래로 차례로 낮아져야 한다는 것이다.
짧으면서 한 가지만 하는 함수가 위에서 아래로 차례로 나열된다면, 읽기가 쉽다.
5. switch문 사용하지 말기
switch문은 의미 자체에서 한가지 일이 아닌 N가지 일을 처리하는 함수이다.
다형성을 이용하여 switch문의 조건인 변수를 간단하게 처리할 수 있긴 하다.
하지만 여러가지 일을 하는 것은 변함 없다.
그리고 switch문은 객체지향 설계원칙의
SRP(Single Responsibility Principle)(각 분기마다 코드를 수정할 이유가 다르기 때문)
OCP(Open Close Principle)(새로운 분기 유형이 생기면 코드를 수정해야 하기에 확장에 열려있지 않다)
를 위반한다.
또한, 심각한 문제로 Switch를 이용한 함수와 구조가 동일한 함수가 무한정 존재한다는 것이다.(어떤 의미인지 잘 모르겠음)
switch를 이용하여 작업을 나누는 것은 추상 팩토리를 이용하여 문제를 해결할 수 있다.
switch에서 분기 처리를 하는 작업들은 어떠한 공통점이 있을 것이다. 이 공통점을 정의한 부모클래스와 이를 상속하는 여러 클래스(분기 처리할)를 만든다. 그리고 상속한 파생 클래스로 객체를 생성하는 추상 팩토리에서 알맞은 객체를 생성하여 반환하면, 이 반환값과 다형성을 이용하여 switch문은 내부로 숨기고 외부에서 한 명령으로 분기를 처리할 수 있다.
저자는 위와같이 다형적 객체를 생성하는 코드 안에서 외부에 절대 노출하지 않는 switch문을 한번 정도 참아준다고 한다.
6. 서술적인 이름을 사용하라.
한 가지 일만 하는 작은 함수에 서술적인 이름을 붙인다면, 코드가 술술 읽히게 된다. (ex. includesetupAndTeardownPages)
함수가 작고 간단할수록 서술적인 이름을 붙이기 쉬워진다.
쉽게 읽히는 단어를 선택한 후, 기능을 최대한 잘 표현하게 이어 붙인다. (길어도 상관없다.)
7. 함수 인수
함수에서 이상적인 인수 개수는 0개이다.
그 다음은 1개, 그 다음은 2개이다.
3개는 피하는게 좋고, 4개는 쓰면 안된다.
인수는 개념을 이해하기 어렵게 만든다.
예를 들어, Scanner나 의 중복을 피하겠답시고 메소드의 인수로 Scanner, StringBuffer을 달고 다니는 것이다.
코드를 읽는 사람이 그 시점에서 별로 중요하지 않은 세부사항(Scanner, StringBuffer가 무엇인가)를 알아야 하는 불편함이 생긴다.
그리고 Scanner와 StringBuffer가 필요한 시점까지 이를 인수로 가지고 다니게 되면, 이를 사용하는 메서드 빼고 중간의 메서드들은 모두 함수이름과 인자사이의 추상화 수준이 맞지 않게 된다.
테스트 관점에서도 인수가 많으면 테스트하기 어렵다.
출력 인수는 입력 인수보다 더 이해하기 힘들다. 함수에 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙하기 때문이다.
출력 인수를 사용하는 함수는 인수로 결과를 받는다. 그 함수의 결과를 집어넣기 위해 인수를 전달하는 경우다. (c언어의 scanf("%d", &a)같은 경우 입력받은 값(결과값)을 인수 a에서 받는다.)
7-1. 많이 쓰는 단항 형식
- 인수에 질문을 던지는 경우
boolean fileExists("MyFile")은 MyFile이 있는지 없는지 질문을 던진다.
- 인수를 뭔가로 변환해 결과를 반환하는 경우
InputStream fileOpen("MyFile")은 String형 "MyFile"을 InputStream으로 변환한다.
- 이벤트 형식
프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다. (passwordAttemptFaildNtimes(int attempts))
입력 인수를 변환하는 함수라면 변환 결과는 반환값을 돌려준다. (출력인수를 사용하여 결과를 출력인수에 넣지 않는다)
StringBuffer transform(StringBuffer in)이 void transform(StringBuffer out)보다 좋다.
7-2. 플래그 인수
bool값을 인수로 넘겨준다는 것은 bool값이 참이면 이걸 하고 거짓이면 저걸 한다는 것이다.
대놓고 두가지 일을 한다는 것이다. 쓰지말자.
7-3. 이항 함수
writeField(name)은 writeField(outputStream, name) 보다 이해하기 쉽다.
writeField(outputStream, name)는 첫 인수를 무시하고 코드를 봐야 한다는 사실을 깨닫기까지 시간이 걸린다.
하지만 이 무시는 이후 오류를 불러올 가능성이 큰 위험한 무시이다.
또한 이 두 인수는 자연적인 순서가 없기에, 코드를 작성하는 사람이 매번 일일이 인수의 순서를 기억하고 코드를 작성해야한다.
테스트의 assertEquals(expected, actual) 도 그렇다. expected 자리에 actual을 써본 경험이 많을 것이다.
이항 함수는 항상 단항 함수로 바꾸려는 노력을 해야 하는데,
1) 위와 같은 경우에는, writeField 메서드를 outputStream 클래스 구성원으로 만들어서, outputStream.writeField(name) 으로 처리하면, 기존의 outputStream 인수를 클래스 인스턴스로 처리하여 인수하나를 줄일 수 있다.
2) 아니면 기존의 클래스에 outputStream을 인스턴스 변수로 만들고, 생성자로 초기화하든 클래스에서 초기화하든 사용할 수 있다.
3) 아니면 FieldWriter라는 클래스에서 생성자로 outputStream을 받고, write 메서드를 구현할 수 도 있겠다.
-> 불필요해 보이는 인수의 존재는 클래스를 나누는 방법의 실마리가 될 수 있다.
7-4. 삼항 함수
이항 함수보다도 이해하기 어렵고, 무시로 인한 오류의 위험도가 배이다.
특별한 이유가 있어야 하고, 있어도 피해야 한다.
7-5. 인수 객체
인수가 두 세개로 많으면, 인수를 객체로 만들 방법을 고민한다.
예를 들어, Circle makeCircle(double x, double y, double radius) 은 x, y값을 관리하는 Point 클래스를 만들어 줄일 수 있다.
-> Circle makeCircle(Point p, double radius);
7-6. 인수 목록
가변적인 인수 목록은 List를 통해 하나의 인수로 처리할 수 있다.
String.format() 함수는 String.format("my name is %s", name) 처럼 앞의 포멧과 뒤의 실제 값을 인수로 가진다.
포멧에 넣을 실제 값의 갯수에 따라 인수가 늘어나는데, 이 실제 값들을 List형 인수 하나로 만들면 사실상 이항함수이다.
7-7. 동사와 키워드
단항 함수는 함수와 인수가 동사/명사 쌍을 이루어야 한다.
write(name) 과 같은 동사 명사 쌍은 이름을 쓴다는 명확한 의미를 전달한다.
writeField(name)이라 쓰면 이름을 쓰는데 이름은 필드다 라는 더 명확한 의미를 전달한다.
그리고, 메소드에 인수의 이름을 넣는다면 더 좋은 메소드명을 만들 수 있다.
예를 들어 위의 assertEquals 메소드는 assertExpectedEqualsActual() 로 짓는다면, 순서를 기억 할 필요가 없다.
8. 부수 효과를 일으키지 마라.
책의 예시에서 checkPassword(String userName, String password) 메서드 안에서는 사용자 정보의 유효성 검사를 하면서 유효한 사용자면 Session.initialize() 를 통해 세션을 초기화한다.
이는 숨겨진 부수 효과이다. 메서드명만 보고 이 메서드를 사용하는 사용자는 유효성 검사만 하고 싶었는데, 기존 세션을 초기화시켜버리는 사태가 발생할 수 있다.
이름을 checkPasswordAndInitializeSession으로 짓는 것이 낫다.
물론, 이렇게 이름을 짓는다 해도 함수가 두가지 역할을 하게 된다. 한가지 역할만 하도록 분리하는 것이 최선일 것이다.
8-1. 출력 인수
위에서 언급했지만, 우리는 인수를 함수의 입력으로 해석한다. 이 입력으로 어떤 처리를 해서 함수는 출력을 반환하는 것을 함수의 역할로 주로 알고 있다.
그래서 출력 인수는 이해하기가 더 힘들다.
예를 들어 appendFooter(s); 라는 메서드를 보자.
함수가 s에 바닥글을 첨부하는지(s가 출력 인순지), s라는 글을 바닥글로 첨부하는지(입력 인순지) 알 수 없다. 그래서 선언부를 본다.
(선언부를 봐야 하는 행위도 의미전달이 되고 있지 않다는 뜻이다.)
public void appendFooter(StringBuffer report);
report에 바닥글을 첨부하라는 뜻을 알게 되고 출력인수로 판단한다.
이는 Report라는 클래스를 만들면 해결할 수 있다.
Report 클래스 안에 appendFooter 메소드를 만들어서 report.appendFooter() 을 하면 인수도 줄일 수 있고, 출력 인수로 인한 이해의 어려움도 없앨 수 있다.
함수에서 상태를 변경해야 한다면, 함수가 속한 객체상태를 변경하는 방식을 택한다.
9. 명령과 조회를 분리하라.
함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다.
(= 객체 상태를 변경하거나, 객체 정보를 반환하거나 둘 중 하나만 해야 한다.)
10. 오류 코드보다 예외를 사용하라.
오류 코드와 if 문을 통한 코드 검증은 코드를 더럽게 한다.
try / catch로 호출자와 오류 처리 코드를 분리하면, 코드가 더욱 깨끗해진다.
10-1. try / catch 블록 뽑아내기
try / catch 문 역시 코드 구조에 혼란을 일으킨다. 따라서 try / catch 블록은 별도 함수로 뽑아내는 것이 좋다.
try {
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
} catch (Exception e) {
logger.log(e.getMessage());
}를 아래와 같이 분리할 수 있다.
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());
}
10-2. 오류 처리도 한 가지 작업이다.
함수는 한가지 일만 하도록 하라 라고 했다.
오류 처리도 한 가지 작업이다.
따라서 try / catch 문이 있는 함수는 , try 로 시작하여 catch 나 finally 로 끝나야 한다.
11. 반복하지 마라.
중복을 제거하라. 중복은 모든 악의 근원이다.
12. 함수를 어떻게 짤까.
1) 길고, 복잡하고, 들여쓰기 단계도 많고, 중복된 루프도 많고, 인수 목록도 많은 더러운 코드를 만든다.
2) 이를 빠짐없이 테스트하고 돌아가는 단위 테스트를 만든다.
3) 이 단위 테스트를 매번 통과하면서, 함수를 쪼개고, 이름을 바꾸고, 중복을 제거하고, 메서드의 순서도 바꾸고 한다.
처음부터 깨끗하고 깔끔한 코드를 만들기는 쉽지 않다. 처음에는 더러운 코드를 짜고, 단계별로 다듬는 과정을 거친다.