[Clean Code] 클린코드 3장 : 함수

클린코드 3장(로버트C. 마틴)을 읽고...

 

작게 만들어라

함수는 작으면 작을 수록 좋다.

public static Stirng renderPageWithSetupsAndTeardowns (
    PageData pageData, boolean isSuite) throws Exception {
    if (isTextPage(pageData))
    	includeSetupAndTeardownPages(pageData, isSuite);
    return pageData.getHtml();
}

 

블록과 들여쓰기

if문, else문, while문 등에 들어가는 블록은 한 줄이어야 한다. (대개 거기서 함수를 호출)

 

한가지만 해라

함수는 한 가지를 해야한다. 그 한 가지를 잘해야 한다. 그 한 가지만을 해야 한다.

지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만을 하는 것이다.

또한, 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 세임다. 

 

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

위에서 아래로 코드 읽기: 내려가기 규칙

 

코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.

즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다.

 

switch문

public Money calculatePay(Employee e)
throws InvalidEmployeeType{
    switch (e.type){
    	case COMMISSIONED:
            return calculateCommissionedPay(e);
        case HOURLY:
            return calculateHourlyPay(e);
        case SALARIED:
            return calculateSalariedPay(e);
        default:
            throw new InvalidEmployeeType(e.Type);
    }
}

 

위 코드의 문제점은

1. 함수가 길다.

2. 한가지 작업만 수행하지 않는다.

3. SRP를 위반한다.

4. OCP를 위반한다.

5. 함수와 구조가 동일한 함수가 무한정 존재한다. (isPayday(Employee e, Date date) 혹은 deliverPay(Employee e, Money pay))

 

public abstract class Employee {
    public abstract boolean is Payday();
    public abstract Money calculatePay();
    public abstract void deliverPay(Money pay);
}

public interface EmployeeFactory {
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}

public class EmployeeFactoryImpl implements EmployeeFactory {
    public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType{
        switch (e.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문을 추상팩토리에 숨기고, 팩토리는 switch문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다.

함수는 Employee 인터페이스를 거쳐 호출되고, 그러면 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.

(switch문은 다형적 객체를 생성하는 코드 안에서 1번정도는 괜찮다. (저자의 의견에 따르면...))

 

서술적인 이름을 사용하라

코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 할 수 있다.

'길고 서술적인 이름'이 짧고 어려운 이름, 길고 서술적인 주석보다 좋다.

함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.

그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

 

이름을 붙일 때는 일관성이 있어야 한다.

모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.

includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage.. 등이 좋은 예다.

 

함수 인수

함수에서 이상적인 인수 개수는 0개이다. (적으면 적을 수록 좋다.)

최선은 입력 인수가 없는 경우이며, 차선은 1개뿐인 경우다.

SetupTeardownIncluder.render(pageData)는

pageData 객체 내용을 렌더링하겠다는 뜻으로 이해하기 쉽다.

 

출력인수는 입력인수보다 이해하기 어렵다.

흔히 우리는 함수에다 인수로 입력을 넘기고 반환값으로 출력을 받는다는 개념에 익숙하다.

대개 함수에서 인수로 결과를 받으리라 기대하지 않기 때문에 출력 인수는 코드를 재차 확인하게 만든다.

 

 

많이 쓰는 단항 형식

 

함수에 인수 1개를 넘기는 이유는 인수에 질문을 던지거나, 인수를 뭔가로 변환해 결과를 반환하는 경우이다.

두 경우는 독자가 당연하게 받아드린다.

다소 드물게 사용하지만 유용한 단항 함수 형식은 이벤트다.

이벤트 함수는 이벤트라는 사실이 코드에 명확히 드러나야 한다.

이 3가지 경우가 아니라면 단항 함수는 가급적 피하는 것이 좋다.

 

 

플래그 인수

 

플래그 인수는 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이다...

 

 

이항 함수

 

인수가 2개인 함수는 1개인 함수보다 이해하기 어렵다.

writeField(name)는 writeField(outputStream, name)보다 더 쉽게 읽히고 빨리 이해된다.

 

물론 Point p = new Point(0,0)같이 이항 함수가 적절한 경우도 있다.

직교 좌표계 점은 일반적으로 인수 2개를 취한다.

여기서 인수 2개는 한 값을 표현하는 두 요소며, 두 요소에는 자연적인 순서도 있다.

(outputStream과 name은 한 값을 표현하지도, 자연적인 순서가 있지도 않다.)

 

이항함수가 무조건 나쁘다는 것은 아니다.

가능하면 단항 함수로 바꾸는 것이 좋다.

 

예를 들어, writeField 메서드를 outputStream 클래스 구성원으로 만들어

outputStream.writeField(name)으로 호출하거나,

outputStream을 현재 클래스 구성원 변수로 만들어 인수로 넘기지 않는다.

 

 

삼항 함수

 

assertEquals(message, expected, actual)

assertEauals(1.0, amount, .001)

// 이부분은 이해가 잘 안돼서 나중에 수정해야겠다..

 

 

인수 객체

인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언하자.

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

↓

Circle makeCircle(Point center, double radius);

 

 

인수 목록

 

때로는 인수 개수가 가변적인 함수도 필요하다. Stirng.format 메서드가 좋은 예다.

String.format("%s worked %.2f" hours.", name, hours);

 

가변인수 전부를 동등하게 취급하면 list형 인수 하나로 취급할 수 있는데,

이런 논리라면 String.format은 사실상 이항함수이다.

 

* public String format(String format, Object... args)

 

 

동사와 키워드

 

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필요하다.

단항 함수는 함수와 인수가 동사/명사 쌍을 이루어야 한다. ->writeField(name)

또한 함수 이름에 인수를 넣는 것이 좋다. -> asserExpectedEqualsActual(expected, actual)

 

부수 효과를 일으키지 마라

아래 코드에서 함수가 일으키는 부수 효과는 Session.initialize() 호출이다.

checkPassword 함수는 이름 그대로 암호를 확인하는 것인데, 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다.

 

checkPassword 함수는 세션을 초기화해도 괜찮은 경우에만 호출이 가능하다.

자칫 잘못 호출하면 의도하지 않게 세션 정보가 날아가므로,

시간적인 결합이 필요하다면 함수 이름에 분명히 명시해야한다. (→ checkPasswordAndInitializeSession)

 

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

 

출력 인수

 

객체 지향 언어에서는 출력인수를 사용할 필요가 거의 없다.

출력 인수로 사용하라고 설계한 변수가 this 이므로...

 

명령과 조회를 분리하라

함수는 객체 상태를 변경하거나 객체 정보를 반환하거나 둘 중 하나만 해야한다.

 

public boolean set(String attribute, String value);

이 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true, 아니면 false를 반환한다.

 

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

이 코드를 보면 username을 unclebob으로 설정하라는 코드인지, 아니면 설정되어 있는지 확인하는 코드인지 의미가 모호하다.

 

set을 동사로 의도했지만, if문에 넣으면 형용사로 느껴진다.

그래서 if문은 username 속성이 unclebob으로 설정되어 있다면...으로 읽힌다.

(username을 unclebob으로 설정하는데 성공하면...으로 읽히지 않는다.)

 

그래서 명령과 조회를 분리하자!

if (attribueExists("username")) {
    setAttribute("username", "unclebob")
}

 

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

if (deletePage(page) == E_OK) 같은 코드는 중첩되는 코드를 야기한다.

오류 코드 대신 예외를 사용하면 코드가 더욱 깔끔해진다.

 

- try/catch 블록 뽑아내기

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

 

반복하지 마라

많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.

구조적 프로그래밍, AOP, COP 모두 어떤 면에서 중복 제거 전략이다.

 

구조적  프로그래밍

- 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다. (return문이 한개여야 함.)

- 루프 안에서 break나 continue를 사용하지 말고, goto는 절대로 안된다.

 

함수를 어떻게 짜죠?

소프트웨어를 짜는 행위는 글짓기와 비슷하다.

초안은 대개 서투르고 어수선하므로 원하는대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.

(처음부터 완벽하게 짤 수 없다!!!!!)