search

jongfeel / BookReview

Reviews the IT or any books slowly and steady.
MIT License
4 stars 0 forks source link

Clean Code, Chapter 6: Objects and Data Structures #756

Closed jongfeel closed 5 months ago

jongfeel commented 5 months ago

Chapter 6 객체와 자료구조

변수를 비공개private으로 정의하는 이유는 외부에서 변수에 의존하지 않게 만들고 싶어서이다. 그러면 조회get 함수와 설정set 함수를 당연하게 공개public해 비공개 변수를 외부에 노출하는가?

자료 추상화

목록 6-1과 목록 6-2의 차이는 구현을 외부로 노출하고 구현을 완전히 숨긴다는 차이가 있다.

목록 6-1 구체적인 Point 클래스

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

목록 6-2 추상적인 Point 클래스

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

목록 6-2의 인터페이스는 자료 구조를 명백하게 표현한다. 좌표를 읽을 때는 개별적으로 읽지만 설정할 때는 한꺼번에 설정한다.

목록 6-1은 직교좌표계를 사용한다. 개별적으로 좌표값을 읽고 설정하게 강제한다. 구현을 노출하고 변수를 pirvate으로 선언해도 각 값마다 조회get 함수와 설정set 함수를 제공하면 구현을 외부로 노출하게 된다.

변수 사이에 함수를 넣어도 구현이 저절로 감춰지지는 않는다. 구현을 감추려면 추상화가 필요하다. 추상 인터페이스를 제공해서 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 한다.

목록 6-3은 자동차 연료 상태를 구체적인 숫자 값으로 알려준다. 이는 변수 값을 읽어 반환한다는 사실이 드러난다. 목록 6-4는 자동차 연료 상태를 백분율이라는 추상적인 개념으로 알려준다. 어떻게 정보를 가져오게 되는지 드러나지는 않는다.

목록 6-3 구체적인 Vehicle 클래스

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

목록 6-4 추상적인 Vehicle 클래스

public interface Vehicle {
    double getPercentFuelRemaining();
}

각 목록 별로 목록 6-2와 목록 6-4가 자료를 세세하게 공개하는 것 보다는 추상적인 개념으로 표현하는 것이 좋다. 개발자는 객체가 포함하는 자료를 표현할 좋은 방법을 고민해야 한다. 별 생각 없이 조회/설정 함수를 추가하는 방법은 좋지 않다.

자료/객체 비대칭

목록 6-1 에서 6-4는 객체와 자료 구조 사이에 벌어진 차이를 보여준다. 객체는 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 공개한다. 자료 구조는 자료를 그대로 공개하며 별다른 함수는 제공하지 않는다. 두 정의는 본질적으로 상반된다.

목록 6-5는 절차적인 도형 클래스이다. Square, Rectangle, Circle 세 가지 도형 클래스는 자료구조이며 아무 메서드도 제공하지 않는다. Geometry 클래스는 이 세 도형 클래스를 다루며 동작하는 방식을 구현한다.

목록 6-4 절차적인 도형

 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(Object 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 클래스에 둘레의 길이를 구하는 perimeter() 함수를 추가한다면 도형 클래스는 영향을 받지 않는다. 반면 새 도형 클래스를 추가한다면 Geometry 클래스에 속한 함수를 모두 고쳐야 한다. 이건 객체와 자료구조의 두 조건이 반대인 상황을 설명한 것이다.

목록 6-6은 객체 지향적인 도형 클래스이다. area() 함수는 다형polymorphic 메서드이다. Geometry는 필요가 없기에 새 도형을 추가해도 기존 함수에 영향을 미치지 않는다. 반면 새 함수를 추가한다면 도형 클래스 전부를 고쳐야 한다.

목록 6-6 다형적인 도형

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 Circle implements Shape {
    private Point center;
    private double radius;
    public final double PI = 3.141592653589793;
    public double area() {
        return PI * radius * radius;
    }
}

목록 6-5와 6-6은 상호 보완적인 특질이 있다. 그래서 객체와 자료 구조는 근본적으로 양분된다.

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

반대쪽도 참이다.

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

모든 것이 객체라는 생각이 미신이기도 하다. 때로는 단순한 자료 구조와 절차적인 코드가 가장 적합한 상황도 있다.

디미터 법칙

디비터의 법칙: 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙이다. "클래스 C의 메서드 f는 다음과 같은 객체의 메서드만 호출해야 한다"는 뜻이기도 하다.

아래 코드는 디미터 법칙을 어기는 것 처럼 보인다.

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

기차 충돌

위 코드를 기차 충돌train wreck이라 부른다. 일반적으로 조잡하다 여겨지는 방식이므로 피하는 편이 좋다. 위 코드는 다음과 같이 나누는 편이 좋다.

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

이 코드가 디미터 법칙을 위반하는지 여부는 ctxt, Options, ScratchDir이 객체인지 아니면 자료 구조인지에 달렸다. 객체라면 내부 구조를 숨기지 않았으므로 디미터 법칙을 위반한다. 자료구조라면 내부 구조를 노출하므로 디미터 법칙이 적용되지 않는다.

만약 다음과 같이 구현했다면 디미터 법칙을 거론할 필요가 없어진다.

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

자료 구조는 함수 없이 공개 변수만 포함하고 객체는 비공개 변수와 공개 함수를 포함한다면 문제는 간단해진다.

잡종 구조

그래서 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다. 중요한 기능을 수행하는 함수와 함께 공개 변수와 공개 조회/설정 함수도 있다. 그래서 다른 함수가 절차적인 프로그래밍의 자료 구조 접근 방식처럼 비공개 변수를 사용하고픈 유혹에 빠진다.

이런 구조는 새로운 함수, 새로운 자료 구조도 추가하기 어렵다. 양쪽의 단점만 모아놓은 구조이기 때문이다.

구조체 감추기

ctxt, options, scratchDir이 진짜 객체라면 내부 구조를 감춰야 하므로 기차 충돌 코드는 바람직 하지 않다.

ctxt.getAbsolutePathofScratchDirectoryOption();
ctxt.getScratchirectoryOption().getAbsolutePath();

첫 번째 방법은 ctxt에 공개해야 하는 메서드가 너무 많아진다. 두 번째 방법은 getScratchirectoryOption()이 객체가 아니라 자료구조를 반환한다고 가정한다.

ctxt가 객체라면 뭔가를 하라고 말해야지 속을 드러내라고 말하면 안 된다. 임시 디렉터리의 절대 경로를 얻으려는 이유를 살펴봐야 하는데 임시 파일을 생성하기 위한 목적이라는 걸 같은 모듈에서 작성된 코드를 보고 파악이 된다.

그렇다면 ctxt 객체에 임시 파일을 생성하라고 하면 괜찮을 수 있다.

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

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

자료 전달 객체

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

일반적인 형태는 '빈bean' 구조이며 빈은 비공개 변수를 조회/설정 함수로 조작한다. 사이비 캡슐화로, 일부 Object Oriented 순수주의자나 만족시킬 뿐 별다른 이득은 없다. 예제는 목록 6-7의 address.java를 참고한다.

목록 6-7 address.java

public class Address {
    private String street;
    private String streetExtra;
    private String city;
    private String state;
    private String zip;
    public Address(String street, String streetExtra,
        String city, String state, String zip) {
        this.street = street;
        this.streetExtra = streetExtra;
        this.city = city;
        this.state = state;
        this.zip = zip;
    }
    public String getStreet() {
        return street;
    }
    public String getStreetExtra() {
        return streetExtra;
    }
    public String getCity() {
        return city;
    }
    public String getState() {
        return state;
    }
    public String getZip() {
        return zip;
    }
}

활성 레코드

활성 레코드는 DTO의 특수한 형태다. save, find와 같은 탐색 함수도 제공한다. 활성 레코드는 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과다.

활성 레코드에 비즈니스 규칙 메서드를 추가해 자료 구조를 객체로 취급하는 경우가 있는데 바람직하지 않다. 그렇게 하면 자료 구조도 아니고 객체도 아닌 잡종 구조가 나오기 때문이다.

따라서 활성 레코드는 자료 구조로 취급한다. 비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성한다.

결론

객체는 동작을 공개하고 자료를 숨긴다. 기존 동작을 변경하지 않으면서 새 타입을 추가하기 쉽고 기존 객체에 새 동작을 추가하는 건 어렵다.

자료 구조는 자료를 노출한다. 기존 자료 구조에 새 동작을 추가하기는 쉽지만 기존 함수에 새 자료 구조를 추가하기는 어렵다.

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

우수한 소프트웨어 개발자는 편견 없이 이 사실을 이해해 직면한 문제에 최적인 해결책을 선택한다.

참고 문헌

jongfeel commented 5 months ago

디미터의 법칙에서

이 법칙에 대한 자세한 설명으로 < 실용주의 프로그래머 > 227쪽을 언급한다. 하지만 이건 구판의 정보이고 현재는 20주년 기념판이 출간 됐으므로 페이지로 하면 182페이지의 Topic 28 결합도 줄이기 부분에 있다.

2년 전 academic conference를 진행하고 정리한 issue 링크는 아래에 있다.

jongfeel commented 5 months ago

구조체 감추기에서

"ctxt가 객체라면 뭔가를 하라고 말해야지 속을 드러내라고 말하면 안 된다." 이건 아주 중요한 객체지향 관점에서의 방향성이며 객체는 메서드를 통해 자율적으로 구현하는 방법을 선택하고 책임을 다하는 방식으로 구현하는 게 좋다. 속을 드러내라고 하는 것 부터 이미 메서드 이름 부터 그럴 가능성이 높고 호출 하는 쪽에서 그 속을 알고 호출하는 것일 가능성이 높다.

jongfeel commented 5 months ago

자료 전달 객체 활성 레코드 에서

이 용어는 사실 최근 academic conference를 진행하면서 읽고 있는 < 엔터프라이즈 애플리케이션 아키텍처 패턴 > 에서 언급한 패턴과 그 용어들이다.

특별히 코멘트를 다는 이유는 2년 전에 클린 코드를 읽었을 때의 느낌으로 DTO는 springboot를 하면서 접해서 알고 있다 정도였고 활성 레코드는 잘 몰라서 읽고 이해만 했다 수준이었던 것 같다.

지금은 < 엔터프라이즈 애플리케이션 아키텍처 패턴 > 에서 DTO와 Active Record에 대해 풍부한 예제와 설명을 읽고 알았기 때문에 조금 더 특별하게 다가오는 느낌이다.

아래 링크가 < 엔터프라이즈 애플리케이션 아키텍처 패턴 > 에서 설명하는 DTO와 ActiveRecord에 대한 내용이다.