CS Clean Code - 객체와 자료 구조

자료 추상화

public class Point {
    public double x;
    public double y;
}

• 확실히 직교좌표계를 사용한다.
• 개별적으로 좌표값을 읽고 설정하게 강제한다.

public interface Point {
    double getX();
    double getY();
    void setCartesian(double x, double y);
    double getR();
    double getTheta();
    void setPolar(double r, double theta);
}

• 직교좌표계를 사용하는지 극좌표계를 사용하는지 알 길이 없다.
• 좌표를 읽을 때 각 값을 개별적으로 읽어야 한다.
• 좌표를 설정할 때는 두 값을 한꺼번에 설정해야 한다.

그저 조회 함수와 설정 함수로 변수를 다룬다고 클래스가 되지 않는다. 추상 인터페이스를 제공해 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 진정한 의미의 클래스다.

 

public interface Vehicle {
    double getFuelTankCapacityInGallons();
    double getGallonsOfGasoline();
}

• 자동차 연료 상태를 구체적인 숫자 값으로 알려준다.
• 단순히 변수값을 읽어 반환할 뿐이라는 사실을 거의 확신할 수 있다.

public interface Vehicle {
    double getPercentFuelRemaining();
}

• 정보가 어디서 오는지 전혀 드러나지 않는다.

 

자료를 세세하게 공개하기보다는 추상적인 개념으로 표현하는 편이 좋다. 단순하게 인터페이스, set, get 함수로 감췄다고 추상화가 이뤄지지 않는다. 아무 생각 없이 set, get 함수를 추가하는 방법은 가장 나쁘다.

: 개발자는 항상 어떻게 자료를 표현할지 심각하게 고민해야 한다.

 

자료/객체 비대칭

1. 절차적인 코드(자료 구조를 이용하는)

public class Circle {
    public Point center;
    public double radius;
}
public class Rectangle {
    public Point topLeft;
    public double height;
    public double width;
}

public class Geometry {
    public final double PI = 3.14159;
    
    public double area(Object shape) throws NoSuchShapeException {
        if (shape instanceof Circle) {
            Circle c = (Circle) shape;
            return PI * c.radius * c.radius;
        } else if (shape instanceof Rectangle) {
            Rectangle r = (Rectangle) shape;
            return r.height * r.width;
        }
    }
}

 

2. 객체 지향 코드

public interface Shape {
    double area();
}

public class Circle implements Shape {
    public final double PI = 3.14159;

    public Point center;
    public double radius;

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

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

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

 

객체 지향이 100퍼 옳다고 말하기는 어렵다. 만약 perimeter() 함수를 추가하고 싶다면? Geometry 클래스만 수정하면 되고, 도형 클래스는 아무런 영향을 받지 않는다. 반면 객체 지향 코드는 모든 도형 클래스를 수정해야한다.

 

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

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

절차적인 코드와 객체 지향 코드는 상호 보완적인 특징이 있다. 객체 지향 코드에서 어려운 변경은 절차적인 코드에서 쉽고, 절차적인 코드에서 어려운 변경은 객체 지향 코드에서 쉽다. 분별 있는 프로그래머는 모든 것이 객체라는 생각이 미신임을 잘 안다. 때로는 단순한 자료 구조와 절차적인 코드가 가장 적합한 상황이 있다.

 

디미터 법칙

자신이 조작하는 객체의 속사정을 몰라야 한다

객체 지향 프로그래밍에서 가장 중요한 것은 "객체가 어떤 메시지를 주고 받는가?"이다. 그렇기에 디미터 법칙은 객체 지향 프로그래밍에서 상당히 중요하다.

디미터 법칙을 위반하는 것은 클래스 내부 구조가 노출된다는 뜻이다. 그러면 클래스에 변경 사항이 생겼을 경우, 영향 범위가 매우 클 것이다. 반면 인터페이스로 클래스 내부 구조를 숨긴 경우, 영향 범위는 작을 것이다.

디미터 법칙을 위반하면 클래스간 결합도가 증가한다.

 

1) 기차 충돌

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

위와 같이 여러 객차가 한 줄로 이어진 기차처럼 보이는 코드를 기차 충돌이라고 부른다.

 

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

기차 충돌 코드는 위와 같이 나눌 수 있다. 그렇다면 위의 예제는 디미터 법칙을 위반할까?

• ctxt 객체가 Options를 포함한다.
• Options 객체가 ScratchDir를 포함한다.
• ScratchDir가 AbsolutePath를 포함한다.

위 예제가 디미터 법칙을 위반하는 것은 ctxt, Options, ScratchDir이 객체인지 아니면 자료 구조인지에 달렸다. 객체라면 당연히 내부 구조를 숨겨야 하므로 위반한다. 반면, 자료 구조라면 당연히 내부 구조를 노출하므로 위반하지 않는다.

 

디비터 법칙은 결합도와 관련된 것이며, 객체의 내부 구조가 외부로 노출되는지에 대한 것이다. 만약 묻는 대상이 객체가 아닌 자료 구조라면 당연히 내부를 노출해야 하므로 디미터 법칙을 적용할 필요가 없다.

 

2) 잡종 구조

때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다. 이런 잡종 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렵다. 양쪽 세상에서 단점만 모아놓은 구조다. 프로그래머가 함수나 타입을 보호할지 공개할지 무지하여 어중간하게 내놓은 설계에 불과하다.

 

3) 구조체 감추기

만약 ctxt, options, scratchDir이 진짜 객체라면? 기차 충돌 코드를 작성하면 안 된다. ctxt가 객체라면 뭔가를 하라고 말해야지 속을 드러내라고 말하면 안 된다.

 

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

임시 디렉터리의 절대 경로가 왜 필요할까? 위 코드는 같은 모듈에서 가져온 코드이다. 임시 디렉터리를 통해 임시 파일을 생성하기 위해서다.

 

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

그렇다면 ctxt 객체에 임시 파일을 생성하라고 시키면 내부 구조를 드러내지 않으며, 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다.

 

자료 전달 객체

자료 구조체의 전형적인 형태는 공개 변수만 있고 함수가 없는 클래스다. 이런 자료 구조체를 DTO라 한다. DTO는 데이터베이스와 통신하거나 소켓에서 받은 메시지의 정보들을 전달할 때 매우 유용하다.

 

1) 활성 레코드

활성 레코드는 DTO의 특수한 형태다. get, set 뿐만 아니라 save, find 등 탐색 함수도 제공하여 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과다. 불행히도 활성 레코드에 비즈니스 규칙 메서드를 추가하여 객체로 취급하는 개발자가 흔하다. 이는 잡종 구조를 만들기 때문에 바람직하지 않다.

해결책은 당연하다. 활성 레코드는 자료 구조로 취갑하고, 비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성한다.

 

결론

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

 

느낀점

객체를 만들 때 디미터의 법칙을 적용하여 최대한 결합도를 줄여야 한다. 하지만 무분별하게 객체 타입을 만드는 것은 새로운 동작을 추가할 때 영향 범위가 커진다. 객체와 자료 구조를 잘 구분하고, 역할에 맞게 구현해야 한다.