[Clean Code] 함수

로버트 C. 마틴의 Clean Code, 애자일 소프트웨어 장인정신이라는 책의 내용을 정리한 내용입니다.

---

작게 만들어라!

함수를 만드는 첫번째 규칙으로 함수를 '작게' 만드는 것이다. 

무조건적으로 작은 함수가 좋다는 근거를 대기는 곤란하지만, 일반적으로 함수를 작게 구현하는 것이 좋다고 저자는 말하고 있다.

 

블록과 들여 쓰기

if 문/ else 문/ while 문 등에 들어가는 블록은 한 줄이어야 한다.

함수에서 들여 쓰기 수준은 1단이나 2단을 넘어서면 안 된다.

- 이 부분은 인지하고 있지만 막상 작업을 하다 보면 놓칠 때가 많다 (습관을 들여야 한다.)

 

한 가지만 해라

함수는 한 가지를 해야 한다.

그 한 가지를 잘해야 한다.

그 한 가지만을 해야 한다.

 

여기에서 표현하는 '한 가지'란 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행하는 것을 의미한다.

예를 들어 아래 세 단계를 보았을 때, 세 가지의 일을 한다고 생각할 수 있다.

1. 페이지가 테스트 페이지인지 판단한다.
2. 그렇다면 설정 페이지와 해제 페이지를 넣는다.
3. 페이지를 HTML로 렌더링한다.

하지만, 위에서 언급한 세 단계는 지정된 함수 이름 아래에서 추상화 수준이 하나인 경우이다.

( 페이지가 테스트 페이지인지 확인한 후 테스트 페이지라면 설정 페이지와 해제 페이지를 넣는다. 테스트 페이지든 아니든 페이지를 HTML로 렌더링 한다 )

 

- 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈인 것이다.

 

함수 당 추상화 수준은 하나로

함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.

핵심은 짧으면서도 '한 가지'만 하는 함수이다.

 

서술적인 이름을 사용하라

함수가 하는 일을 좀 더 잘 표현해야 좋은 이름이라고 할 수 있다.

ex) testableHtml -> SetupTeardownIncluder

- 한눈에 봐도 함수가 하는 일을 짐작할 수 있기 때문에 더 좋은 이름이라고 할 수 있다.

 

함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다 (한눈에 어떤 기능을 하는 함수인지 알 수 있어야 한다)

이름을 정하는데 시간을 들이는 것을 아까워할 필요 없다. 이런저런 이름을 넣어 코드를 읽어보는 것도 좋다고 한다.

 

함수 인수

함수에서 이상적인 인수 개수는 0개(무항)다.

다음은 1개(단항), 다음은 2개(이항)다. 

3개는 가능한 피하는 편이 좋으며, 4개 이상은 특별한 이유가 필요하다.(특별한 이유가 있다고 해도 사용하면 안된다)

그 이유는 인수는 개념을 이해하기 어렵게 만들기 때문이다.

- 인수가 많다면 독자입장에선 코드를 재차 확인해야하기 때문에 효율적이지 않다.

 

많이 쓰는 단항 형식

함수에 인수 1개를 넘기는 이유로 가장 흔한 두 가지 경우는 

1. 인수에 질문을 던지는 경우

2. 인수를 뭔가로 변환해 결과를 반환하는 경우

 

플래그 인수

함수를 부울 값을 넘기는 관례는 정말로 끔찍하다고 한다.

그 이유는 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하기 때문이라고한다.

그런 함수가 있다면 두 개의 함수로 나누는것이 마땅하다고 한다.

render(true)

-->

renderForSuite()
renderForSingleTest()

 

이항 함수

writeField(outputStream, name)

위와같은 함수를 보았을때, 주춤하며 첫 인수를 무시해야 한다는 사실을 깨다는 시간이 필요하다.

(어떤 코드든 절대로 무시하면 안되기때문에, 무시한 코드에 오류가 숨어드니까)

단, 자연적인 순서로 인해 2개의 인수를 취할때가 있다.

Point p = new Point(0, 0)

직교 좌표계 점은 일반적으로 인수 2개를 취한다.(오히려 코드가 Point(0)이였다면 혼란을 일으켰을것이다)

프로그램을 짜다보면 불가피한 경우도 생기지만 그만큼 위험이 따른다는 사실을 이해하고 가능하다면 단항함수로 바꾸도록 해야한다.

 

삼항 함수

인수가 2개인 함수보다 훨씬 더 이해하기 어렵기 때문에 신중히 고려하여 불가피할 경우에만 사용해야한다.

 

인수 객체

인수가 2~3개 필요하다면, 일부를 독자적인 클래스 변수로 선언할 가능성이 있다.

Circle makeCircle(double x, double y, double radius);

위 함수의 경우 x와 y를 객체로 묶어서 사용할 수 있다.

Circle makeCircle(Point center, double radius);

위처럼 객체로 묶어주게 되면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.

 

인수 목록

때로는 인수 개수가 가변적인 함수도 필요한데, String.format 메서드가 좋은 예다.

 

부수 효과를 일으키지 마라

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;
    }
}

위 코드는 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않기때문에

함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 기존 세션 정보를 지워버릴 위험에 처한다.

이처럼 함수 이름에 분명히 명시되어있지않다면 자칫 잘못 호출했을 경우 세션 정보가 날아가게되는 위험한 상황이 생길 수 있다.

- 되도록 함수는 '한 가지'만 한다는 규칙을 지키도록하자

출력 인수

appendFooter(s);

- 이 함수는 무언가에 s를 바닥글로 첨부할까 라는 부분을 알기 위해선 함수 선언부를 찾아보면 분명해진다.

 

함수 선언부를 찾아보는 행위는 코드를 보다가 주춤하는 행위와 동급이다. 인지적으로 거슬린다는 뜻이므로 피해야한다.

일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

 

명령과 조회를 분리하라

함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다.

if(set("username", "inclebob"))...

위 코드를 보았을때 독자는 무슨뜻인지 한눈에 보기 어렵다.

if (attributeExists("username")) {
	setAttribute("username", "unclebob");
    ...
}

하지만 위 코드를 보았을땐 username의 검증을 먼저 한뒤 저장하는것임을 한눈에 알수있다

이처럼 명령과 조회를 분리해 혼란을 애초에 뿌리뽑을 수 있다.

 

오류 코드보다 예외를 사용하라

오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

 

Try/Catch 블록 뽑아내기

코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 

그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다.

 

오류 처리도 한 가지 작업이다

오류를 처리하는 함수는 오류만 처리해야한다.

 

함수를 어떻게 짜죠?

1. 생각을 기록한 후 읽기 좋게 다듬는다

2. 초안은 서투르고 어수선하므로 읽힐 때까지 말을 다듬는다

3. 문장을 고치고 문단을 정리한다

---

- 되도록 한 가지 행동을 하는 함수를 작성한다

- 함수명, 인자를 보았을때 어떤동작을 하는 함수인지 알수있게 작성한다

- 인수는 되도록 없으면 좋지만, 필요하다면 한 가지 인수만 사용하고 두 가지부턴 꼭 필요한 인수인지 체크하여 되도록 줄인다