Clean Code 요약해보기 (5)

변수를 private으로 정의하는 이유가 있다. 남들이 변수에 의존하지 않게 만들고 싶어서다. 

그럼에도 왜 get/set 함수를 공개하여 외부에 노출할까?

 

자료 추상화

아래 두 코드를 보자.

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

밑에 코드는 점이 직교좌표계를 사용하는지 극좌표계를 사용하는지 알 길이 없다. 그럼에도 인터페이스는 자료 구조를 명백하게 표현하며 자료 구조 그 이상을 나타낸다. 클래스 메서드가 접근 정책을 강제한다.

좌표를 읽을 때 -> 각 값을 개별적으로 읽어야 함.

좌표를 설정할 때 -> 두 값을 한꺼번에 설정해야함.

 

반면 앞에 코드는 직교좌표계를 사용하는 걸 알 수 있고 개별적으로 좌표값을 읽고 설정하게 강제한다.

그리고 구현 역시 노출된다. get, set 함수를 각각 제공한다면 구현을 외부로 노출하는 셈이다.

 

따라서 구현을 감추려면 추상화가 필요하다!

 

자료/객체 비대칭

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 클래스에 속한 함수를 모두 고쳐야 한다.

 

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 widte;
    
    public double area() {
        return height * width;
    }
}

이번 코드는 객체 지향적인 도형 클래스다. 여기서 area()는 다형(polymorphic) 메서드다. Geometry 클래스는 필요 없다. 그러므로 새 도형을 추가해도 기존 함수에 아무런 영향을 미치지 않는다. 반면 새 함수를 추가하고 싶다면 도형 클래스를 전부 고쳐야 한다.

 

결론적으로 객체 지향 코드에서 어려운 변경은 절차적인 코드에서 쉬우며, 절차적인 코드에서 어려운 변경은 객체 지향 코드에서 쉽다.

 

 

디미터 법칙

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

"클래스 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, opts, scratchDir이 객체인지 자료구조인지 알 수가 없어서 위반 여부를 알 수 없다. 만약 아래와 같다면 디미터 법칙을 거론할 필요는 없다.

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

하지만 보통 이러한 단순한 자료 구조에도 조회 함수와 설정 함수를 정의하라고 요구하는 프레임워크와 표준이 존재한다. (ex : Bean)

 

잡종 구조

절반은 객체, 절반은 자료 구조인 잡종 구조도 있다. 양쪽에서 단점만 모아놓은 구조다. 따라서 되도록 피하는 것이 좋다.

 

구조체 감추기

ctxt, options, scratchDir이 객체라면? 그럼 내부 구조를 감춰야 한다.

ctxt.getAbsolutePathOfScratchDirectoryOptions();
ctxt.getScratchDirectoryOption().getAbsolutePath();

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

아래 줄은 getScratchDirectoryOption()이 객체가 아니라 자료 구조를 반환한다고 가정한다. 두 방법 다 썩 내키지 않는다.

 

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

여기서 ctxt가 절대 경로(absolute path)를 얻으려고 하는 이유는 해당 코드에서 임시 파일을 생성하기 위함이다.

// outputDir 사용하는 부분
String outFile = outputDir + "/" + className.replace('.', '/') + ".class";
FileOutputStream fout = new FileOutputStream(outFile);
BufferedOutputStream bos = new BufferOutputStream(fout);

 

따라서 ctxt 객체에게 임시 파일을 생성하라고 시키는 걸로 해결하자.

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

자료 전달 객체

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

 

아래 예제는 빈(Bean) 구조다. 빈은 private 변수를 조회/설정 함수로 조작한다. 일종의 사이비 캡슐화로. 일부 OO 순수주의자나 만족시킬 뿐 별다른 이익을 제공하지 않는다.

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;
    }
    
    // 이하 생략
}

활성 레코드

활성 레코드는 DTO의 특수한 형태다. 공개 변수가 있거나 비공개 변수에 조회/설정 함수가 있는 자료 구조지만, 대개 save나 find와 같은 탐색 함수도 제공한다. 활성 레코드는 DB 테이블이나 다른 소스에서 자료를 직접 변환한 결과다.

활성 레코드에 비즈니스 규칙 메서드를 추가하지 말자. 잡종 구조가 된다.

해결책은 활성 레코드를 자료 구조로 취급하여 비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성하는 것이 좋다.

 

결론

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

 

결국 답은 없다! 새로운 자료 타입을 추가하는 유연성이 필요한지, 새로운 동작을 추가하는 유연성이 필요한지에 따라 적합한 선택을 하자!