Clean Code - 03. 함수

February 5, 2022

어떤 프로그램이든 가장 기본적인 단위가 함수다

어떤 함수가 읽기 쉽고 이해하기 쉬운 이유는 무엇일까?
의도를 분명히 표현하는 함수를 어떻게 구현할 수 있을까?
함수에 어떤 속성을 부여해야 처음 읽는 사람이 프로그램 내부를 직관적으로 파악할 수 있을까?

작게 만들어라!

함수가 몇 줄이냐가 정해져 있지는 않다.
함수가 하나의 이야기를 한다면 자연스럽게 작아진다.

블록과 들여쓰기

if문/else문/while문 등에 들어가는 블록은 한 줄이어야 함 -> 대개 거기서 함수를 호출하기 때문!
중첩 구조가 생길만큼 함수가 커져서는 안 된다. -> 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다.

// bad
public void enclosingFunction() {
    ...
    if (조건1) {
        if (조건2) {
            setter(); // 특정 조건 시 어떤 값 세팅해주고
            if (조건3) {
                if(조건4) { 
                    function(); // 특정 조건 시 어떤 함수 호출
                }
            }
        }
    }
}

// good
// 바깥을 감싸는 함수(enclosing function)가 작아지고, 블록 안에서 호출하는 함수 이름이 적절하다면 코드를 이해하기도 쉽다
public void enclosingFunction() {
    ...
    if (조건1) {
        function(); // 특정 조건일 때만 함수 호출
    }
}

한 가지만 해라!

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

여기서 말하는 “한 가지”란 무엇일까?
지정된 함수 이름 아래에서 추상화 수준이 하나다.
의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 것

우리가 함수를 만드는 이유 : 큰 개념(함수 이름)을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서

함수 내 섹션

한 가지 작업만 하는 함수는 자연스럽게 섹션으로 나누기 어렵다.

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

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

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

코드는 위에서 아래로 이야기처럼 읽혀야 좋다.

// 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.   
// 위에서 아래로 TO 문단을 읽어내려 가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기가 쉬워진다.  

public void 추상화3단계함수() {
    ...
    추상화2단계함수();
    ...
}

public void 추상화2단계함수() {
    ...
    추상화1단계함수();
    ...
}

public void 추상화1단계함수() {
    ...
    // do something..
    ...
}

Switch 문

다형성(polymorphism)을 이용하면 각 switch 문을 저차원 클래스에 숨기고 반복하지 않을 수 있다.

// bad
// 함수가 길고 한 가지 작업만 하지 않는다.
// SRP (Single Responsibility Principle), OCP (Open Closed Principle) 을 위배 
// -> 직원 유형이 추가될 때마다 코드가 변경되야 함
public Money calculatePay(Employee e) throws InvalidEmployeeType {
    switch (e.type) {
        case COMISSIONED:
            return calculateCommissionedPay(e);
        case HOURLY:
            return calculateHourlyPay(e);
        case SALARIED:
            return calculateSalariedPay(e);
        default:
            throw new InvalidEmplyeeType(e.type);
    }
}

// good
public abstract class Employee {
    public abstract boolean isPayday();
    public abstract Money calculatePay();
    public abstract void delieverPay(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 (r.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);
        }
    }
}

class diagram

SOLID 원칙

SRP (단일 책임 원칙) : 클래스는 단 한 개의 책임을 가져야 한다.

OCP (개방-폐쇄 원칙) : 확장에는 열려 있어야 하고, 변경에는 닫혀 있어야 한다.
(기능을 변경하거나 확장할 수 있으면서 그 기능을 사용하는 코드는 수정하지 않는다.)
추상화, 상속 등을 사용

LSP (리스코프 치환 원칙) : 상위 타입의 객체를 하위 타입의 객체로 치환해도 상위 타입을 사용하는 프로그램은 정상적으로 동작해야 한다.

DIP (의존 역전 원칙) : 고수준 모듈은 저수준 모듈의 구현에 의존해서는 안 된다.
저수준 모듈이 고수준 모듈에서 정의한 추상 타입에 의존해야 한다.

ISP (인터페이스 분리 원칙) : 클라이언트는 자신이 사용하는 메소드에만 의존해야 한다.
인터페이스는 그 인터페이스를 사용하는 클라이언트를 기준으로 분리해야 한다.

서술적인 이름을 사용하라!

“코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.” by. 워드

함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.
길고 서술적인 이름 > 짧고 어려운 이름
길고 서술적인 이름 > 길고 서술적인 주석
함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.
그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.
서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.
이름을 붙일 때는 일관성이 있어야 한다.
모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.

함수 인수

인수는 개념을 이해하기 어렵게 만든다.
테스트 관점에서 보면, 인수가 많아질수록 인수의 모든 조합에 따라 테스트하기 복잡해진다.

많이 쓰는 단항 형식

인수에 질문을 던지는 경우
인수를 뭔가로 변환해 결과를 반환하는 경우
이벤트 - 입력 인수로 시스템 상태를 바꿈

플래그 인수

함수로 부울 값을 넘기는 관례는 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈
-> 플래그가 참이면 A를 하고, 플래그가 거짓이면 B를 하겠다는 것임

이항 함수

두 개의 인수를 사용할 시에 인수의 순서를 인위적으로 기억해야 함 -> 인수 입력 시 실수하는 경우가 많음
~~(요새는 함수 사용할 때 IDE에서 다 보여줘서 이 정도는 괜찮지 않나.. 하는 생각)~~

삼항 함수

인수 객체

인수가 2~3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.
ex) makeCircle(double x, double y, double radius) -> makeCircle(Point center, double radius)

인수 목록

때로는 인수 개수가 가변적인 함수도 필요하다.
ex) String.format -> public String format(String format, Object... args)

동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.
단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
write(name), writeField(name)
함수 이름에 키워드를 추가하는 형식이다.
assertEquals -> assertExpectedEqualsActual(expected, actual)

부수 효과를 일으키지 마라!

함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓을 하는 것은
시간적인 결합(temporal coupling)이나 순서 종속성(order dependency)을 초래한다.

시간적 결합 : 메서드 A는 언제나 반드시 메서드 B보다 먼저 호출해야 한다.

출력 인수

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

명령과 조회를 분리하라!

함수는 무너가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다.
객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.

// bad
// 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 성공하면 true, 실패하면 false 반환
public boolean set(String attribute, String value); 

// username이 unclebob으로 설정되어있는지 확인하는 함수인지, username을 unclebob으로 설정하는 함수인지 의미가 모호함
if (set("username", "unclebob")) ... 

// good
if (attributeExists("username")) { // 조회
    setAttribute("username", "unclebob"); // 명령
    ...
}

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

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.
자칫하면 if 문에서 명령을 표현식으로 사용하기 쉬운 탓이다.
오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.

Try/Catch 블록 뽑아내기

try/catch 문은 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞기 때문에 별도 함수로 뽑아내는 편이 좋다.

// bad
if (deletePage(page) == E_OK) {
    if (registry.deleteReference(page.name) == E_OK) {
        if (configKeys.deleteKey(page.name.makeKey()) == E_OK) {
            ...
        } else { }
    } else { }
} else { }

// good
try {
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
} catch (Exception e) {
    ...
}

// GREAT
public void delete(Page page) {
    try {
        deletePageAndAllReferences(page);
    } catch (Exception e) {

    }
}

private void deletePageAndAllReferences(Page page) throws Exception {
    deletePAge(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}

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

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

Error.java 의존성 자석

오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.

반복하지 마라! - DRY (Don’t Repeat Yourself)

중복은 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 사용된 곳 모두 손봐야 하고, 이 중 한 곳이라도 빠뜨리면 오류로 이어진다.
어쩌면 중복은 소프트웨어에서 모든 악의 근원이다.

구조적 프로그래밍

모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다. by. 에츠허르 데이크스트라 ~~(다익스트라 알고리즘의 그분)~~
즉, 함수는 return 문이 하나여야 한다는 말이다.
루프 안에서 break나 continue, goto를 사용해선 안 된다.

함수를 어떻게 짜죠?

처음부터 잘 짤 수 있는 사람은 없다.
코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거하고, 메서드를 줄이고 순서를 바꾸고, 전체 클래스를 쪼개기도 하면서 더 나은 코드가 될 수 있다.

결론

우리가 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기 쉬워진다는 사실을 명심하자.

내 생각

한 함수에서 하나만 실행한다.
서버 코드 작성 시에는 이해가 되는데 화면 개발 시에는 어떻게 해야 할까?
함수 이름이 중요한 것은 알고 있지만, ~~(고작)~~ 한 기능을 하는 함수에 긴 이름을 붙이는 게 낯설다..

Twitter Facebook LinkedIn

윤주