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

자료 추상화

개발자는 객체가 포함하는 자료를 표현할 가장 좋은 방법을 심각하게 고민해야 한다.

객체는 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 공개하는 편이 좋다.

아무 생각 없이 get/set 함수를 추가하는 방법이 가장 나쁘다.

• 구체적인 Point 클래스 (구현을 외부로 노출) → 나쁜 케이스
  • 내부 구조를 노출 (변수를 private로 설정하더라도 get,set 함수 제공시 구조가 외부로 노출)
  • 개별적으로 좌표값을 읽고 설정하게 강제.

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

 

• 추상적인 Point 클래스 (구현을 완전히 숨김) → 좋은 케이스
  • 클래스 메서드가 접근 정책을 강제.
  • 좌표를 읽을 때는 각 값을 개별적으로 읽도록 강제
  • 좌표를 설정할 때는 두 값을 한꺼번에 설정하게 강제.

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

 

• 구체적인 Vehicle 클래스 (구현을 외부로 노출) → 나쁜 케이스
  • 자동차 연료 상태를 구체적인 숫자 값으로 알려줌
    → 두 함수가 변수 값을 읽어 반환할 뿐이라는 사실이 거의 확실.

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

 

• 추상적인 Vehicle 클래스 (구현을 완전히 숨김) → 좋은 케이스
  • 자동차 연료 상태를 백분율이라는 추상적인 개념으로 알려줌
    → 정보가 어디서 오는지 드러나지 않음.

public interface Vehicle {
  double getPercentFuelRemaining();
}

 

자료/객체 비대칭

객체와 자료구조는 본질적으로 상반된다.

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

• 객체 : 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 공개한다.

(새로운 함수를 추가하는 일은 어려움. 새로운 자료 타입이 필요한 경우에 더 적합)

 

• 자료구조 : 자료를 그대로 공개하고 별다른 함수는 제공하지 않는다.

(새 자료구조를 추가하는 일은 어려움. 새로운 함수가 필요한 경우에 더 적합)

 

• 절자적인 도형
  • 새 함수를 추가한다고 해도 도형 클래스들은 영향받지 않는다.
  • 새 도형(자료구조)을 추가하고 싶다면 Geometry 클래스에 속한 함수들을 모두 고쳐야 한다.

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 double width;
}

public class Geometry {
    public final double PI = 3.141592653585793;

    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
        }
    }
}

 

• 객체지향적인 도형
  • 새 도형을 추가하더라도 기존 함수에 아무런 영향을 미치지 않는다.
  • 새 함수를 추가하고 싶다면 도형 클래스를 전부 고쳐야 한다.

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

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

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

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

public class Circle implements Shape {
    public Point center;
    public double radius;
    public double width;

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

 

디미터 법칙

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

클래스 C의 메서드 f는 다음과 같은 객체의 메서드만 호출해야 한다.

• 클래스 C
• f가 생성한 객체
• f 인수로 넘어온 객체
• C 인스턴스 변수에 저장된 객체.

하지만 허용된 메서드가 반환하는 개체의 메서드는 호출하면 안된다. (낮선 사람은 경계하고 친구랑만 놀아라)

 

기차 충돌

메소드가 반환하는 객체의 메소드를 연쇄적으로 불러오는 문제.

// 기차 충돌 예시
String outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath();

// 올바른 예시
Options opts = ctxt.getOptions();
File scratchDir = opts.getScratchDir();
String outputDir = scratchDir.getAbsolutePath();

위 예제가 디미터 법칙을 위반하는지 여부는 ctxt, Options, ScratchDir이 객체인지 자료구조인지에 달렸다.

• 자료구조일 경우 : 자료구조는 당연히 내부 구조를 노출하므로 디미터 법칙이 적용되지 않음.
• 객체일 경우 : 객체는 내부 구조를 숨겨야 하므로 디미터 법칙 위반

final String outputDir = cxtx.opts.scratchDir.absolutePath;

해당 예제는 조회 함수(get)를 이용했기 때문에 혼란을 일으킨다.

코드를 위와 같이 구현했다면 디미터 법칙을 거론할 필요 없다.

(하지만 단순한 자료구조에도 get/set 함수를 정의하라 요구하는 프레임워크와 표준이 존재. 예를들어 Bean)

 

잡종 구조

절반은 객체, 절반은 자료구조인 클래스 (공개 변수, 공개 함수, 주요 함수, getter, setter 모두 섞여있는 구조)

잡종 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렵다. 양쪽의 단점만 모아놓은 구조이다.

 

구조체 감추기

위 예시에서의 ctxt, options, scratchDir이 객체라면 함수 내에서 줄줄이 사탕으로 호출하면 안된다.

(*디렉토리 경로를 얻는 목적은 임시파일 생성을 위함)

• ctxt 객체에 getAbsolutePathOfScratchDirectoryOption() 메소드 생성
  → ctxt 객체에 공개해야 하는 메서드가 너무 많아진다.

ctxt.getAbsolutePathOfScratchDirectoryOption()

 

• ctxt 객체에 getScratchDirectoryOption() 메소드를 생성. 공개해야 하는 메서드 줄이기.
  → ctxt가 객체라면 뭔가를 하라고 말해야지 속을 드러내라고 말하면 안된다.

ctxt.getScratchDirectoryOption().getAbsolutePath()

 

• 디렉토리 경로를 가져오지 말고, 아예 ctxt 객체에게 임시 파일을 생성하라고 시킨다.
  → ctxt가 내부 구조를 드러내지 않으며, 모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다. 디미터 위반 해결!

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

 

자료 전달 객체

DTO

public 변수만 있고 함수가 없는 클래스

class Address {

    public final String postalCode;
    public final String city;
    public final String street;
    public final String streetNumber;
    public final String apartmentNumber;

}

 

Bean

private 변수를 getter/setter 함수로 조작하는 방법.

class Address {

    private final String postalCode;
    private final String city;
    private final String street;
    private final String streetNumber;
    private final String apartmentNumber;

    public Address(String postalCode, String city, String street, String streetNumber, String apartmentNumber) {
        this.postalCode = postalCode;
        this.city = city;
        this.street = street;
        this.streetNumber = streetNumber;
        this.apartmentNumber = apartmentNumber;
    }

    public String getPostalCode() {
        return postalCode;
    }

    public String getCity() {
        return city;
    }

    public String street() {
        return street;
    }

    public String streetNumber() {
        return streetNumber;
    }

    public String apartmentNumber() {
        return apartmentNumber;
    }
}

 

활성 레코드

• DTO의 특수한 형태.
• public 변수가 있거나 private 변수에 getter/setter 함수가 있는 자료구조. 대개 save나 find와 같은 탐색 함수도 제공.
• 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과이다.
• 활성 레코드에 비즈니스 규칙 메서드를 추가해 객체로 취급하는 개발자가 흔하다. 이는 바람직하지 않음. 자료구조도 아니고 객체도 아닌 잡종 구조가 나오기 때문이다.
• 활성 레코드는 자료구조로 취급한다. 비즈니스 규칙을 담으려면 내부 자료를 숨기는 객체는 따로 생성한다. (여기서 내부 자료는 활성 레코드의 인스턴스일 가능성이 높다.)

(일반적으로 ORM에서 사용된다.)

// 비즈니스 규칙 메서드를 추가해 객체로 취급
class Person {
    private String name;
    private String email;

    publicPerson(String name, String email){
        this.name= name;
        this.email= email;
    }
    ...
    publicvoidsendEmail(){
    ...
    }
}

// 비즈니스 규칙을 담는 객체 따로 생성
class EmailSender{
    private Person receiver;
    ...
    public void sendEmail() {
        ...
    }
    ...
}

 

결론

객체

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

자료구조

• 별다른 동작 없이 자료를 노출한다.
• 기존 자료 구조에 새 동작을 추가하기는 쉬우나, 기존 함수에 새 자료구조를 추가하기는 어렵다.

객체 vs 자료구조

• 새로운 자료 타입을 추가하는 유연성이 필요하다 → 객체
• 새로운 동작을 추가하는 유연성이 필요하다 → 자료구조