[클린 코드] 3장 함수

TIL (Today I Learned)

22.02.22~22.02.23

오늘 읽은 범위

3장. 함수

책에서 기억하고 싶은 내용

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

 

- 함수는 작게 만들어야 한다. 다시 말해, if문/else문/while문에 들어가는 블록은 한 줄이어야 한다는 말이다. 이 말은 중첩 구조가 생길만큼 함수가 커져서는 안 된다는 뜻이다. 그러므로 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다.

 

- 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하는 셈이다[G34] -> 새로운 객체를 생성하는 것도 하나의 작업이다!

 

- 각 함수는 다음 함수를 소개하고, 각 함수는 일정한 추상화 수준을 유지한다.

 

switch문

switch 문을 꼭 사용해야 한다면 다형적 객체를 생성하는 코드 안에서 + 선택 유형 하나에 한 번만 사용한다. 

1) 추상팩토리에 switch 문을 숨기고 팩토리가 대신 파생클래스의 인스턴스를 생성.

2) 인터페이스를 통해 함수가 호출

3) 다형성으로 인해 실제 파생 클래스의 함수가 실행

public abstract class Employee {
    public abstract boolean isPayday();
    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 (r.type) {
        	case COMMISIONED:
            	return new CommisionedEmployee(r);
            case HOURLY:
            	return new HourlyEmployee(r);
            case SALARIED;
        }
    }
}

함수 인수

함수에서 이상적인 인수 개수는 0개이다. 3개는 가능한 피하는 편이 좋고, 4개 이상은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다. 

1) 단항 형식

- 인수에 질문을 던지는 경우

boolean fileExists("MyFile")

- 인수를 무언가로 변환해 결과를 반환하는 경우

InputStream fileOpen("MyFile")

2) 플래그 인수

- 함수로 boolean값을 넘기지 말고 boolean true인 함수와 boolean false인 함수를 각각 만들어라

 

3) 이항 함수

- 단항 함수로 만들자.

writeField(outputStream, name)

-> writeField 메서드를 outputStream 구성원으로 만들어 outputStream.writeField(name)으로 호출

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

-> FieldWriter라는 새 클래스를 만들어서 구성자에서 outputStream을 받고 write 메서드 구현

 

4) 인수 객체

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

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

 

5) 동사와 키워드

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

함수 이름에 키워드를 추가하면 인수 순서를 기억할 필요가 없어진다.

 

부수 효과를 일으키지 마라

부수 효과를 무시하면 시간적인 결합이나 순서 종속성을 초래할 수 있기 때문에, 가급적이면 함수 이름에 명시하는 것이 좋다. 새로운 함수를 만드는 것도 좋은 방법.

 

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

1) try-catch 블록을 별도 함수로 뽑아내기

public void delete(Page page) {
	try {
    	deletePageAndAllReferences(page);
    } catch (Exception e) {
    	logErorr(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());
}

2) Error.java 의존성 자석

오류 코드를 정의하는 클래스가 변한다면 해당 오류 코드를 사용하는 클래스 전부를 다시 컴파일하고 다시 배치해야 한다. 오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생되기 때문에 재컴파일이나 재배치 없이도 새 예외 클래스를 추가할 수 있다.

 

구조적 프로그래밍

루프 안에서 break, continue는 거의 사용하지 말 것. 특히 goto는 사용 금지

 

함수를 짜는 방법

1. 먼저 쭉 써내려간다 + 단위 테스트

2. 기능 단위로 분리 / 적절한 네이밍 / 중복 제거 등을 고려하여 리팩토링 + 단위 테스트

 

오늘 읽은 소감

목록 3-1을 보는 순간 졸프 코드와 너무 똑같아서 놀랐다. 거의 저작권 위반으로 고소해야 할 정도

이번 장에서는 무의식적인 코드 작성법을 지적하는 내용이 많았다. 아래 3가지 내용이 내 코드의 주 문제점인데, 앞으로 함수를 생성할 때마다 이 3가지 내용을 새겨야겠다. 특히 switch문은 꼭 팩토리 메서드를 적용해봐야겠다!

1) switch문의 사용

2) 플래그 인수를 함수 인수로 넘기는 것

3) try-catch 블록 사용

 

궁금하거나 잘 이해되지 않는 내용

추상 팩토리 vs 팩토리 메서드

- 추상 팩토리 패턴(Abstract Factory Pattern) : 서로 관련이 있는 객체들을 통째로 묶어서 팩토리 클래스로 만들고, 이들 팩토리를 조건에 따라 생성하도록 다시 팩토리를 만들어서 객체를 생성하는 패턴

- 팩토리 메서드 패턴 : 조건에 따른 객체 생성을 팩토리 클래스로 위임하여, 팩토르 클래스에서 객체를 생성하는 패턴

=> 팩토리 메서드 패턴에서는 구성품마다 팩토리를 만들어 어떤 객체를 형성했는데, 그 객체의 구성품은 일정하므로 추상 팩토리 패턴을 적용하여 관련된 객체들을 한꺼번에 캡슐화하여 팩토리로 만든 후 일관되게 객체 생성.

https://victorydntmd.tistory.com/300

[디자인패턴] 추상 팩토리 패턴 ( Abstract Factory Pattern )

 

시간적인 결합(temporal coupling)

소프트웨어의 설계 요소 자체로서의 시간 역할

ex) 메서드 A는 언제나 반드시 메서드 B보다 먼저 호출해야 한다

1) 동시성(같은 시간에 일어나는 일)

2) 순서(시간 속에서 일들의 상대적 위치)

=> 우리는 동시성을 허용하고 순서가 없는 프로그램을 만들어야 한다. 

 

순서 종속성(order dependency)

후속 작업은 선행 작업이 완료될 때까지 시자갛ㄹ 수 없다. 

 

 

- SRP : 클래스에는 한 가지, 단 한 가지 변경 이유만 존재해야 한다.

-> 클래스의 변경 = 코드의 변경이다. 

- OCP : 클래스는 확장에 열려 있어야 하며 변경에 닫혀 있어야 한다.

-> 새 직원을 추가할 때마다 코드가 변경되면 안 된다.