[Clean Code] Chapter 6 - 객체와 자료 구조

Chapter 6 객체와 자료 구조

 

변수를 `private`로 정의하는 이유는 남들이 변수에 의존하지 않게 만들고 싶어서다.
그렇다면 어째서 수많은 프로그래머가 `getter`와 `setter`를 당연하게 `public`으로 만들어 `private`로 선언한 변수를 외부에 노출할까?

 

 

 

자료 추상화

 

// 구체적인 Point 클래스
public class Point {
    public double x;
    public double y;
}

 

// 추상적인 Point 클래스
public interface Point {
    double getX();
    double getY();
    void setCartesian(double x, double y);
    double getR();
    double getTheta();
    void setPolar(double r, double theta);
}

 

첫 번째 코드는 Point 객체와 `x`와 `y`좌표를 외부에서 직접 접근할 수 있다.
이것은 `자료구조(Data Structure)`를 노출하는 방식으로 Point 클래스의 내부 데이터가 어떤 구조로 되어 있는지 외부에서 그대로 알 수 있다.

 

변수를 `private`으로 선언하더라도 각 값마다 `getter`와 `setter` 함수를 제공한다면 구현을 외부로 노출하는 셈이다.
변수 사이에 함수라는 계층을 넣는다고 구현이 저절로 감춰지지는 않는다.
구현을 감추려면 추상화가 필요하다.

 

 

두 번째 코드는 Point라는 인터페이스를 정의하고 있다. 이 인터페이스는 `getX()`와 `getY()`라는 메서드만을 제공한다.
이 방법은  `자료 추상화(Data Abstraction)`의 한 예이다.

여기서 중요한 점은 이 인터페이스가 실제로 어떤 자료구조를 사용하는지 사용자가 전혀 알 수 없다는 것이다.

 

예를 들어, Point 인터페이스를 구현한 클래스가 `x`, `y` 좌표를 직교좌표계(평면에서 x축과 y축으로 정의되는 좌표계) 로 표현할 수도 있고,
극좌표계(반지름과 각도로 정의되는 좌표계) 로 표현할 수도 있다. 또는 완전히 다른 방식으로 표현할 수도 있다.

하지만 이 인터페이스를 사용하는 외부 코드 입장에서는 `getX()`와 `getY()` 메서드를 호출해 값을 얻기만 하면 되고,
그 내부에서 어떤 자료구조를 사용하고 있는지는 알 필요도, 알 수도 없다.

 

 

// 구체적인 Vehicle 클래스
public interface Vehicle {
    double getFuelTankCapacityInGallons(); // 연료 탱크의 용량을 갤런 단위로 반환하는 메서드
    double getGallonsOfGasoline(); // 현재 연료 탱크에 남아 있는 휘발유의 양을 갤런 단위로 반환하는 메서드
}

 

// 추상적인 Vehicle 클래스
public interface Vehicle {
    double getPercentFuelRemaining(); // 자동차에 남아 있는 연료의 양을 퍼센트로 반환하는 메서드
}

 

 

두 코드를 비교해보자. 위 인터페이스는 연료에 대한 정보를 매우 구체적으로 노출하고 있다.
이 경우 Vehicle 객체가 얼마나 많은 연료를 가지고 있는지 정확히 알 수 있지만, 이 정보가 너무 구체적이라서 나중에 변경하기 어려울 수 있다.

아래 인터페이스는 구체적으로 갤런 단위의 정보가 아니라 단순히 연료가 몇 퍼센트 남아 있는지라는 정보를 제공하므로 더 추상적이다.
개발자는 단순히 자료 추상화를 만드는 것에 그치지 않고 자료를 표현할 가장 좋은 방법을 심각하게 고민해야 한다.

 

 

 

자료/객체 비대칭

객체는 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 공개한다. 자료 구조는 자료를 그대로 공개하며 별다른 함수는 제공하지 않는다.
즉 객체와 자료구는 본질적으로 상반된 정의를 가지고 있다.

 

(자료 구조를 사용하는) 절차적인 코드는 기존 자료 구조를 변경하지 않으면서 새 함수를 추가하기 쉽다.
반면, 객체 지향 코드는 기존 함수를 변경하지 않으면서 새 클래스를 추가하기 쉽다.

절차적인 코드는 새로운 자료 구조를 추가하기 어렵다. 그러려면 모든 함수를 고쳐야 한다.
객체 지향 코드는 새로운 함수를 추가하기 어렵다. 그러려면 모든 클래스를 고쳐야 한다.

 

 

다시 말해, 객체 지향 코드에서 어려운 변경은 절차적인 코드에서 쉬우며, 절차적인 코드에서 어려운 변경은 객체 지향 코드에서 쉽다.

복잡한 시스템을 짜다 보면 새로운 함수가 아니라 새로운 자료 타입이 필요한 경우가 생긴다. 이때는 클래스와 객체 지향 기법이 가장 적합하다.
반면, 새로운 자료 타임이 아니라 새로운 함수가 필요한 경우도 생긴다. 이때는 절차적인 코드와 자료 구조가 좀 더 적합하다.

 

 

 

디미터 법칙

디미터 법칙은 잘 알려진 휴리스틱(어떤 문제를 해결하기 위해 사용되는 경험적이고 실용적인 접근법 또는 방법론)으로
"낯선 사람은 경계하고 친구랑만 놀아라"라는 규칙이다.
객체 지향 프로그래밍 관점에서 설명하자면 어떤 객체가 다른 객체의 내부 구조를 알지 않도록 설계해야 한다는 원칙이다.
쉽게 말해 객체는 직접적으로 관련된 객체들만 상호작용해야 하며, 지나치게 여러 단계에 걸쳐 접근하는 것을 피해야 한다.

예를 들어 다음과 같은 코드가 있다고 가정해보자.

 

final String outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath();

 

이 코드는 `getOption()` 함수가 반환하는 객체의 `getScratchDir()` 함수를 호출한 후
`getScratchDir()` 함수가 반환하는 객체의  `getAbsolutePath()` 함수를 호출하고 있다.

디미터 법칙에 따르면 이런 식으로 다른 객체의 내부를 차례차례 파고드는 것은 좋지 않은 방법이다.
이 방식은 객체 간의 결합도를 높이고 코드의 유지보수를 어렵게 만든다.

 

기차 충돌

흔히 위와 같은 코드를 기차 충돌(train wreck)이라 부른다. 여러 객차가 한 줄로 이어진 기차처럼 보이기 때문이다.
일반적으로 조잡하다 여겨지는 방식이므로 피하는 편이 좋다.

 

Options opts = ctxt.getOptions();
File scratchDir = opts.getScratchDir();
final String outputDir = scratchDir.getOutputDirPath();

 

코드를 다음과 같이 바꿨다면 이 코드는 디미터 법칙을 위반할까?

위 코드는 `ctxt` 객체가 `Options` 객체를 알고 있고, `Options` 객체가 `scratchDir` 객체를 알고 있으며,
`scratchDir` 객체가 또  `outputDir` 경로를 알고 있다.
결국, 하나의 함수가 너무 많은 다른 객체의 내부 구조를 알고 있다는 것이다.

 

이 코드가 디미터 법칙을 위반하는지 아닌지는 `ctxt`, `Options`, `ScratchDir`이 ‘객체’인지 ‘자료 구조’인지에 따라 달라진다.
만약 객체라면, 내부 구조를 숨겨야 하므로 디미터 법칙을 위반한다고 볼 수 있다.

하지만, 단순한 자료 구조라면 내부 구조를 노출해도 되기 때문에 디미터 법칙이 적용되지 않는다.

 

final String outputDir = ctxt.options.scratchDir.absolutePath;

 

위와 같이 조회 함수가 아닌 공개된 변수를 통해서만 접근이 가능했다면 디미터 법칙을 거론할 필요가 없어진다.

 

 

 

잡종 구조

자료 구조는 무조건 함수 없이 공개 변수만 포함하고 객체는 비공개 변수와 공개 함수를 포함한다면 문제는 훨씬 간단하겠지만
단순한 자료 구조에도 `getter`와 `setter` 함수를 정의하라 요구하는 프레임워크와 표준(예: Java Beans)이 존재한다.

이런 혼란으로 때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다.

잡종 구조는 중요한 기능을 수행하는 함수도 있고, 공개 변수나 공개 조회/설정 함수도 있다. 공개 조회/설정 함수는 비공개 변수를 그대로 노출한다.

이런 잡종 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어려우므로 잡종 구조는 되도록 피하는 편이 좋다.

 

 

 

구조체 감추기

만약 `ctxt`, `options`, `scratchDir`이 진짜 객체라면 앞서 코드 예제처럼 줄줄이 사탕으로 엮어서는 안 된다.
그렇다면 임시 디렉터리의 절대 경로는 어떻게 얻어야 좋을까?

 

ctxt.getAbsolutePathOfScratchDirectoryOption();

 

ctxt.getScratchDirectoryOption().getAbsolutePath();

 

다음 두 코드를 살펴보자.

첫 번째 방법은 `ctxt` 객체에 공개해야 하는 메서드가 너무 많아진다.

두 번째 방법은 `getScratchDirectoryOption()`이 객체가 아니라 자료 구조를 반환한다고 가정한다.

어느 방법도 썩 내키지 않는다.

ctxt가 객체라면 뭔가를 하라고 말해야지 속을 드러내라고 말하면 안 된다.

 

String outFile = outputDir + "/" + className.replace('.', '/') + ".class";
FileOutputStream fout = new FileOutputStream(outFile);
BufferedOutputStream bos = new BufferedOutputStream(fout);

 

같은 모듈에서 가져온 코드가 다음과 같다면 결국 임시 디렉터리의 절대 경로를 얻으려는 이유가 임시 파일을 생성하기 위한 목적이라는 사실이 드러난다.

그렇다면 `ctxt` 객체에 임시 파일을 생성하라고 시키면 어떨까?

 

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

 

 

`ctxt`는 내부 구조를 드러내지 않으며, 모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다.
따라서 디미터 법칙을 위반하지 않는다.

 

 

 

자료 전달 객체 (DTO)

자료 구조체의 전형적인 형태는 `public` 변수만 있고 함수가 없는 클래스다.
이런 자료 구조체를 때로는 자료 전달 객체(Data Transfer Object, DTO) 라 한다.

DTO는 DB와 통신하거나 소켓에서 받은 메세지의 구문을 분석할 때 특히 유용하다.
흔히 DTO는 DB에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체다.

좀 더 일반적인 형태는 `bean` 구조다.

 

public class ExampleBean {
    private String value;

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }
}

 

 

`Bean`은 `private` 변수를 조회/설정 함수로 조작한다.
이런 Bean 구조는 사실상 ‘진정한’ 캡슐화가 아닌 일종의 사이비 캡슐화로, 일부 OO 순수주의자나 만족시킬 뿐 별다른 이익을 제공하지 않는다.

`getter`와 `setter`를 사용하는 방식이 결국은 변수에 접근할 수 있는 방법을 열어두는 것이기 때문에,
내부 구조를 숨기는 캡슐화의 진정한 목적을 완전히 달성하지 못하기 때문이다.

 

 

활성 레코드 (Active Record)

활성 레코드는 DTO의 특수한 형태다.
`public` 변수가 있거나 `private` 변수에 조회/설정 함수가 있는 자료 구조지만, 대개 save나 find 같은 탐색 함수도 제공한다.

활성 레코드는 데이터베이스와 상호작용하는 `자료구조`로서의 역할만 수행해야 하며, 비즈니스 로직을 포함하지 않아야 한다.
비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성한다.

 

 

 

결론

객체는 동작을 공개하고 자료를 숨긴다. 그래서 기존 동작을 변경하지 않으면서 새 객체 타입을 추가하기는 쉬운 반면,
기존 객체에 새 동작을 추가하기는 어렵다.
자료구조는 별다른 동작 없이 자료를 노출한다. 그래서 기존 자료 구조에 새 동작을 추가하기는 쉬우나,
기존 함수에 새 자료 구조를 추가하기는 어렵다.

 

시스템을 구현할 때 새로운 자료 타입을 추가하는 유연성이 필요하면 객체가 더 적합하다.
다른 경우로 새로운 동작을 추가하는 유연성이 필요하면 자료 구조와 절차적인 코드가 더 적합하다.