1. 작게만들어라.
1) 함수를 만드는 첫 번째 규칙은 '작게!'이고, 둘째 규칙은 '더 작게!'
함수를 작으면 작을 수록 이해하기 쉽다.
if/else, switch 등에 들어가는 블록은 한 줄이어야하고, 호출되는 함수의 이름을 적절히 지어야 이해하기 쉽다
- 중첩구조가 생길만큼 함수가 커져서는 안된다는 의미.
⬇️
2. 한 가지만 하라!
1) 함수는 한 가지를 해야한다. 그 한 가지를 잘해야하고, 그 한 가지만 해야한다.
지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 해야된다.
- 함수를 만드는 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위함이다.
- 함수 섹션: 함수내에서 작업들을 섹션으로 나눌 수 있으면 그 함수는 여러 작업을 하는 함수이다.
3. 함수 당 추상화 수준은 하나로!
1) 함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일 해야된다.
getHtml(); -> 추상화 높음
String pagePathName = PathParser.render(pagepath); -> 추상화 중간
pagePathName.append("\n"); -> 추상화 낮음
* 하나의 함수에서 한 가지라는 것은 동일한 수준의 추상화를 의미한다.
2) 위에서 아래로 코드 읽기: 내려가기 규칙
- 코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
- 한 함수 다음에는 추상화 수준이 한 단계 낮아지는 것이 이상적이다.(내려가기 규칙)
- 여기서의 가장 핵심은 '한 가지'만을 하는 함수이다.
4. Switch문
1) Switch문은 본질적으로 n가지를 처리하기 때문에 작게 만들기가 어렵다.
2) 다형성을 이용하여 Switch문을 클래스에 숨기는 방법이 존재한다.
- 위 함수는 몇 가지 문제가 존재 한다.
1. 함수가 길다.
2. '한 가지' 작업만 수행하지 않는다.
3. SRP(Single Responsibility Principle)을 위반한다.
* SRP: 하나의 클래스는 하나의 책임을 가진다는 원칙
4. OCP(Open/Closed Principle)을 위반한다.
* OCP: 확장에 대해선 열려 있어야되고, 변경에 대해서는 닫혀있어야되는 원칙
- 위 함수처럼 구현할 경우 동일한 구조를 가진 함수를 만들어야 할 수 있다.
예시) isPayDay(Employee employee, Date date); - 고용타입에 따른 급여일 체크
deliveryPay(Employee employee, Money money); - 고용타입에 따른 급여 지급 함수
* 클린코드에서는 switch문을 추상 팩토리에 숨기는 것을 권장
1. 추상팩토리 클래에서 직원타입에 따라서 직원객체를 생성하는 Switch문만 존재한다.
- 다형성에 맞는 로직 수행, 가독성 향상
2. 수정이 발생했을 경우 추상팩토리 클래스만 수정하면 된다.
3. 차이점
- 첫 번째 예시는 Switch의 생성 기준을 작업 단위로 생성, 두 번째 예시는 직원별 기준으로 Switch문 생성
👍 두 차이점을 빗대어 봤을 때 추상화를 어떻게 설정하느냐에 따라서 반복적인 구조를 만들수도 있고,
간결하게 만들 수도 있다는 것을 알 수 있다는 것을 알게되었다.
5. 서술적인 이름을 사용하라!
1) 함수가 하는일을 좀 더 잘 표현하므로 훨씬 좋음 이름이다.
워드 - 코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.
2) 한 가지만하는 작은 함수에 좋은 이름을 붙이는 것은 원칙을 달성함에 있어 절반은 성공한 것이다.
3) 함수가 작고 단순할수록 서술적인 이름을 고르기 쉽다.
4) 이름이 길어도 괜찮고, 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
- 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
- 함수의 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.
- 여러 단어를 사용해 함수기능을 잘 표현하는 이름을 선택한다.
5) 서술적인 이름을 사용하면 개발자 머릿속에 설계가 뚜렷해지므로 코드 개선이 쉬워진다.
- 좋은 이름을 고른 후 더 좋게 재구성하는 사례도 없지 않다.
6) 이름을 붙일때는 일관성이 있어야 한다.
- 모듈내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.
- 문체가 비슷하면 이야기를 순차적으로 풀어가기가 쉬워진다.
6. 함수 인수
1) 함수의 이상적인 인수의 개수는 0개이며
- 다음으로는 1개이며, 그 다음은 2개이다. 3개는 가능한 피하는 편이 좋다.
- 4개 이상은 특별한 이유가 필요하지만 이유가 있어도 사용하면 안된다.
2) 테스트 관점에서 보면 인수는 더 어렵다.
- 갖가지 인수 조합으로 함수를 검증하는 테스트 케이스 작성이 어려울 것이다.
-> 인수가 없다면 간단해진다.
- 인수가 한 개면 괜찮으나, 2개이상으로 넘어갈 경우 복잡해진다.
-> 인수마다 유효한 값으로 모든 조합을 구성해 테스트하기가 부담스러워짐
3) 많이 쓰는 단항 형식
- 인수에 질문을 던질 때
boolean fileExsits("fileName");
- 인수를 무언가로 변환해 가져올 때
InputStream fileOpen("fileName");
- 이벤트 함수 일 때
이 경우에는 이벤트라는 사실이 코드에 명확하게 표현되어야 한다.
* 위의 세 가지의 경우가 아니라면 가급적 단항 인수는 피한다.
예시) void includeSetupInfo(StringBuffer pageText)
-> 변환함수에서 출력인수를 사용할 경우 혼란을 일으킬 수 있으므로 가급적 피한다.
-> StringBuffer타입으로 결과 값을 반환하는 형태의 함수로 생성한다.
4) 플래그 인수
- 플래그 변수는 추하다
-> boolean값을 넘기는 것 자체가 여러 작업을 처리한다는 것을 공표하는 것과 같다.
5) 이항 함수
- 인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
-> 예를들어, writeField(name)은 writeField(outputStream, name)보다 이해하기 쉽다. 둘 다
의미는 명백하지만, 전자가 더 쉽게 읽히고 더 빨리 이해된다.
- 이항 함수가 적절하게 필요한 경우도 있다.
-> Point point = new Point(0, 0)과 같이 직교 좌표계 점은 일반적으로 인수 2개를 취한다.
- 이항 함수가 무조건 나쁜건 아니지만 가능하면 단항 함수로 바꾸도록 해야된다.
6) 삼항 함수
- 인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다.
- 이해하기 어려움에 따른 위험도가 2배이상 늘어나기때문에, 삼항 함수를 만들때는 신중히 고려해야된다.
7) 인수 객체
- 인수가 2~3개 필요하다면 일부를 클래스 변수로 선언하여 전달해야한다.
-> Circle makeCircle(double x, double y, double radius);
-> Circle makeCircle(Point center, double radius);
8) 인수 목록
- 때로는 인수 개수가 가변적인 함수도 필요하다.
-> 예시로 String.format같은 메소드이다.
-> String.format("%s worked %.2f hours", name, hours);
- String.format은 리스트형 인수 하나로 취급하므로 사실상 이항 함수이다.
-> public String format(String format, Object... args);
- 가변인수를 취하는 함수는 단항, 이항, 삼항함수로 취급할 수 있으며, 이를 넘어서 인수를 사용할 경우에는 문제가 있다.
9) 동사와 키워드
- 함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.
- 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야한다.
-> 예시1) write(name) -> writeField(name)
-> 예시2) assertExpectedEqualsActual(expected, actual)
-> 인수의 순서를 기억할 필요가 없어진다.
7. 부수 효과를 일으키지 마라!
1) 부수효과는 거짓말이다.
- 함수에서 '한 가지'만 한다고는 하지만 남몰래 다른 행동을 할 수 있다.
-> 때로는 예상치 못하게 클래스를 수정하면서 함수에서 여러가지 기능을 수행
-> 그로 인해, 시간적 결합, 순서 종속성을 초래
- 시간적 결합이 필요할 경우 함수 이름에 명시를하면 되지만, '한 가지'만 한다는 규칙을 위반할 수 있음.
2) 출력 인수
- 일반적으로 인수를 함수의 입력으로 해석한다. 함수의 인수가 출력 인수 일 경우 어색해진다.
- 예를들어 appendFooter(str); 함수가 있다고 가정
-> appendFooter라는 것은 str에 문자열을 붙이는지, 문자열에 str을 붙이는지 알 수 없다.
- 이러한 문제들을 해결하기 위해 나온 키워드 this
-> 함수 내부에서 this키워드를 이용해 출력 인수 기능 제공
8. 명령과 조회를 분리하라!
1) 함수가 뭔가를 수행하거나 답하거나 둘 중 하나만 해야한다.
이 둘을 모두 수행하는 함수라면 이해하기 어렵다
예를들어 public boolean set(String attribute, String value) -> 어떤 속성에 어떤 값을 넣고 true/false를 반환하는 함수
- 함수 이름이 set일경우, 키 값과 벨류 값의 구분이 모호해짐
- 함수 이름이 setAndCheckIfExists로 바꾸는 방법도 있으나, if문에 넣으면 아직도 어색함
// 작업 별로 분리하여 역할을 명확히 표현한다
if(attributeExists("fieldName")){
setAttribute("fieldName, "value");
}
9. 오류코드보다 예외를 사용하라!
1) 오류코드를 반환하는 방식을 여러 단계로 중첩되는 코드를 야기한다.
- 명령함수에서 오류코드를 반환할 경우 호출자에서 오류코드를 곧바로 처리해야하는데, 이 경우 오류코드 처리문이 중첩될 수 있고,
코드가 지저분해짐
- 이런 오류 코드를 사용하는 것보다 예외 처리를 이용하면 코드가 더 깔끔해진다.
2) try-catch 블록 뽑아내기
- try-catch는 코드 구조에 혼란을 일으키고, 정상동작과 오류 처리 동작을 뒤섞기 떄문에 추하다.
- try-catch블록은 별로 함수로 뽑아내는 것이 좋다.
3) 의존성 자석
- 오류코드를 사용하는 경우 클래스든 열거형이든 어디선가 오류에 대해 정의하고 import를 해서 사용하고 있다는 의미
- 즉, 의존성 자석이라는 말은 오류 코드가 변경 될 경우 import하고 있는 모든 클래스에서 변경을 해야한다는 것을 의미
-> 이렇게 사용할 바에는 함수를 Throw함수로 생성
10. 반복하지 마라
1) 중복은 소프트웨어에서 악의 근원이다.
- 중복을 없앴다는 것은 모듈의 가독성을 크게 높였다는 것
- 중복을 없애기 위해, 데이터베이스의 경우 정규식이 만들어졌고, 객체지향프로그래밍은 코드를 부모클래스로 몰아 중복을 없앤다.
11. 구조적 프로그래밍
1) 어떤 프로그래머는 에츠허르 데이크스트라의 구조적 프로그래밍 원칙을 따른다.
- 데이크스트라는 모든 함수와 함수 내 모든 불록에 입구와 출구가 하나만 존재해야한다고 말했다.
-> 즉 함수는 하나의 return문만 가진다는 의미
-> 루프안에서 break, continue를 사용해선 안되고, goto는 절대 사용하면 안된다.
- 구조적 프로그래밍은 큰 규모의 함수에서만 이익을 제공한다.
- 작은 구조의 함수에선 간혹 return, break, continue를 여러 차례 사용해도 괜찮다.
-> 단, goto는 큰 함수에서만 의미가 있으므로 작은 함수에서는 피해야만 한다
* goto 피하는이유: 코드의 흐름이 여기저기 갈 수있어서, 스파게티 코드를 야기하기 때문
12. 함수를 어떻게 짜죠?
1) 소프트웨어를 짜는 행위는 글짓기와 비슷하다.
- 처음에는 코드가 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많고, 인수목록도 길다
이름은 중복도 되지만, 그 코드들을 빠짐없이 테스트하는 단위 테스트 케이스를 만든다.
- 그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 글고 메소드를 줄이고 순서를 바꾼다.
- 이런 와중에도 항상 단위테스트를 통과한다.
- 최종적으로는 이 장에서 설명한 규칙을 따르는 함수가 얻어진다. 처음부터 탁 짜내지 않고, 그게 가능한 사람도 없다.
13. 결론
1) 함수를 잘만드는 기교를 소개했고, 여기서 설명한 규칙을 따른다면 길이가 짧고, 이름이 좋고, 체계가 잡힌 함수가 나온다.
2) 진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하기 바란다.
3) 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아 떨어져야 이야기를 풀어가기 쉬워진다는 사실을 기억하기 바란다.
