[Clean Code] 6장. 객체와 자료 구조

Rose·2024년 2월 4일

클린코드

CleanCode

목록 보기

5/8

TIL(Today I Learned)

내용 3줄 정리 💁🏻‍♀️

객체는 동작을 공개하고 자료를 숨긴다. 그래서 기존 동작을 변경하지 않으면서 새 객체 타입을 추가하기는 쉬운 반면, 기존 객체에 새 동작을 추가하기는 어렵다.
자료 구조는 별다른 동작 없이 자료를 노출한다. 그래서 기존 자료 구조에 새 동작을 추가하기는 쉬우나, 기존 함수에 새 자료구조를 추가하기는 어렵다.
우수한 소프트웨어 개발자는 직면한 문제에 최적인 해결책을 선택한다.

기억하고싶은 내용 📝

1. 자료 추상화

변수 사이에 함수라는 계층을 넣는다고 구현이 저절로 감춰지지는 않는다.
구현을 감추려면 추상화가 필요하다. 그저 (형식과 논리에 치우쳐) 조회 함수와 설정 함수로 변수를 다룬다고 클래스가 되지는 않는다.
추상 인터페이스를 제공해 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 진정한 의미의 클래스다.

// (1) 구체적인 Vehicle 클래스
public interface Vehicle {
	double getFuelTankCapacityInGallons();
    double getGallonsOfGasoline();
}

// (2) 추상적인 Vehicle 클래스
public interface Vehicle {
	double getPercentFuelRemaining();
}

(1)은 자동차의 연료 상태를 구체적인 숫자 값으로 알려준다. 반면, (2)는 자동차 연료 상태를 백분율이라는 추상적인 개념으로 알려준다. 전자의 경우 두 함수가 변수 값을 읽어 반환할 뿐이라는 사실이 거의 확실하다. 그러나 후자의 경우 정보가 어디서 오는지 전혀 드러나지 않는다.

자료를 세세하게 공개하기 보다는 추상적인 개념으로 표현하는 편이 좋다. 개발자는 객체가 포함하는 자료를 표현할 가장 좋은 방법을 심각하게 고민해야 한다. (119p)

2. 자료/객체 비대칭

책에 나온 예제 코드를 통해 자료구조와 객체에 대해 알아보자.

(1) 절차지향

public class Square {
    public Point topLeft;
    public double side;
}

public class Rectangle {
    public Point topLeft;
    public double height;
    public double width;
}

public class Circle {
    public Point center;
    public double radius;
}

public class Geometry {
    public final double PI = 3.141592653589793;

    public double area(Objects shape) throws NoSuchShapeException {
        if (shape instanceof Square) {
            Square s = (Square) shape;
            return s.side * s.side;
        } else if (shape instanceof Rectangle) {
            Rectangle r = (Rectangle) shape;
            return r.height * r.width;
        } else if (shape instanceof Circle) {
            Circle c = (Circle) shape;
            return PI * c.radius * c.radius;
        }
        throw new NoSuchShapeException();
    }
}

Geometry 클래스는 세 가지 도형 클래스를 다룬다. 각 도형 클래스는 간단한 자료구조다. 즉, 아무 메서드도 제공하지 않는다. 도형이 동작하는 방식은 Geometry 클래스에서 구현한다.

Geometry 클래스에 함수를 추가할 때 도형 클래스와 도형 클래스에 의존하는 다른 클래스들은 아무 영향도 받지 않는다.
새 도형을 추가하고 싶다면 Geometry 클래스에 속한 함수를 모두 고쳐야 한다.

(2) 객체 지향

public class Square implements Shape {
    private Point topLeft;
    private double side;

    public double area() {
        return side * side;
    }
}

public class Rectangle implements Shape {
    private Point topLeft;
    private double height;
    private double width;

    public double area() {
        return height * width;
    }
}

public class Rectangle implements Shape {
    private Point center;
    private double radius;
    public final double PI = 3.1415926533589793;

    public double area() {
        return PI * radius * radius;
    }
}

Geometry 클래스는 필요 없다. 그러므로 새 도형을 추가해도 기존 함수에 아무런 영향을 미치지 않는다.
새 함수를 추가하고 싶다면 도형 클래스를 전부 고쳐야 한다.

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

3. 디미터 법칙

: 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙이다.

객체는 조회 함수로 내부 구조를 공개하면 안된다.
클래스 C의 메서드f는 다음과 같은 객체의 메서드만 호출해야 한다.
- 클래스 C
- f가 생성한 객체
- f 인수로 넘어온 객체
- C 인스턴스 변수에 저장된 객체

기차 충돌

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

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

위 코드는 다음과 같이 나누는 편이 좋다.

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

방금 살펴본 코드 예제는 둘 다 디미터 법칙을 위반할까? 그 여부는 ctxt, Options, ScratchDir이 객체인지 아니면 자료구조인지에 달렸다. 객체라면 내부 구조를 숨겨야 하므로 확실히 디미터 법칙을 위반한다. 반면, 자료 구조라면 아래와 같이 이미 노출된 내부 구조를 사용하기에 디미터 법칙을 위반하지 않는다.

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

잡종 구조

때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다. 이런 잡종 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렵다. 그러므로 잡종 구조는 되도록 피하는 편이 좋다.

구조체 감추기

만약 ctxt, options, scratchDir이 진짜 객체라면 내부 구조를 감춰야 하니까 위와 같이 체이닝 하는 방법은 바람직하지 않다.

ctxt.getAbsolutepathOfScratchDirectoryOption();

위 코드는 ctxt 객체에 공개해야 하는 메서드가 너무 많아진다.

ctxt.getScratchDirectoryOption().getAbsolutePath();

위 방법은 getScratchDirectoryOption()이 객체가 아니라 자료 구조를 반환한다고 가정한다. 객체는 내부 구조를 감춰야 하기에 내부를 노출하는 get 함수는 마음에 들지 않는다.

그렇다면 임시 디렉터리의 절대경로를 어떻게 얻어야 할까?

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

위 코드를 보면, 임시 디렉터리의 절대 경로를 얻으려는 이유가 임시 파일을 생성하기 위한 목적이라는 사실을 알 수 있다.

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

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

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

자료 전달 객체

자료 구조체의 전형적인 형태는 공개 변수만 있고 함수가 없는 클래스인데 이런 자료 구조체를 때로는 자료 전달 객체(Data Transfer Object, DTO)라고 한다. 흔히 DTO는 데이터베이스에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체이다.