[Clean Code] 6. 객체와 자료구조 - 클린 코드 정독하기

변수를 private로 정의하는 이유는 남들이 변수에 의존하지 않게 만들고 싶어서다. 충동이든 변덕이든, 변수 타입이나 구현을 마음대로 바꾸고 싶어서다.

그렇다면 왜 get 함수(getter)와 set 함수(setter)를 당연하게 공개(public)해 비공개 변수를 외부에 노출할까?

 

자료 추상화

다음 두 클래스는 2차원 점을 표현한다. 그런데 한 클래스는 구현을 외부로 노출하고 다른 클래스는 구현을 완전히 숨긴다.

// 구체적인 Point 클래스
public class Point {
    public double x;
    public double y;
}

// 추상적인 Point 클래스
public interface Point {
    double getX();
    double getY();

    void setCartesian(double x, double y);

    double getR();
    double getTheta();

    void setPolar(double r, double theta);
}

추상적인 Point 클래스는 직교좌표계를 사용하는지 극좌표계를 사용하는지 알 길이 없다. 그럼에도 불구하고 인터페이스는 자료 구조를 명백하게 표현한다.

• 클래스 메서드가 접근 정책을 강제한다.
  • 좌표를 읽을 때는 각 값을 개별적으로 읽어야 한다.
  • 좌표를 설정할 때는 두 값을 한꺼번에 설정해야 한다.

 

반면에 구체적인 Point 클래스는 확실히 직교좌표계를 사용한다. 또한 개별적으로 좌표값을 읽고 설정하게 강제한다. 구체적인 Point 클래스는 구현을 노출한다. 변수를 private으로 선언하더라도 각 값마다 getter와 setter를 제공한다면 구현을 외부로 노출하는 셈이다.

 

변수 사이에 함수라는 계층을 넣는다고 구현이 저절로 감춰지지는 않는다. 구현을 감추려면 추상화가 필요하다. 그저 getter와 setter로 변수를 다룬다고 클래스가 되지는 않는다.

• 추상 인터페이스를 제공해 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 진정한 의미의 클래스다.

 

다음 코드를 살펴보자.

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

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

구체적인 Vehicle 클래스에서는 자동차 연료 상태를 구체적인 숫자 값으로 알려준다.

• 두 함수가 변수의 값을 읽어 반환할 뿐이라는 사실이 거의 확실하다.

반면에 추상적인 Vehicle 클래스에서는 자동차 연료 상태를 백분율이라는 추상적인 개념으로 알려준다.

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

 

자료를 세세하게 공개하기보다는 추상적인 개념으로 표현하는 편이 좋다. 인터페이스나 getter setter 함수만으로는 추상화가 이뤄지지 않는다. 개발자는 객체가 포함하는 자료를 표현할 가장 좋은 방법을 심각하게 고민해야 한다.

• 아무 생각 없이 getter / setter를 추가하는 방법이 가장 나쁘다.

 

 

자료/객체 비대칭

앞서 소개한 두 가지 예제는 객체와 자료 구조 사이에 벌어진 차이를 보여준다.

• 객체는 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 공개한다.
• 자료 구조는 자료를 그대로 공개하며 별다른 함수는 제공하지 않는다.

두 정의는 본질적으로 상반된다. 두 개념은 사실상 정반대다. 사소한 차이로 보일지 모르지만 그 차이가 미치는 영향은 굉장하다.

 

절차적인 도형

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 클래스는 세 가지 도형 클래스를 다룬다.
• 각 도형 클래스는 간단한 자료 구조로 아무 메서드도 제공하지 않는다.
• 도형이 동작하는 방식은 Geometry 클래스에서 구현한다.
• 만약 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 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;
    } 
}

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

 

앞에 다룬 절차적인 도형과 다형적인 도형은 상호 보완적인 특질이 있다. 객체와 자료 구조는 근본적으로 양분된다.

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

분별 있는 프로그래머는 모든 것이 객체라는 생각이 미신임을 잘 안다. 때로는 단순한 자료 구조와 절차적인 코드가 가장 적합한 상황도 있다.

 

 

디미터 법칙

디미터 법칙은 잘 알려진 휴리스틱(Heuristic)으로, 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙이다. 객체는 자료를 숨기고 함수를 공개해야 한다. 즉, 객체는 조회 함수로 내부 구조를 공개하면 안 된다는 의미다.

 

디미터 법칙은 “클래스 C의 메서드 f는 다음과 같은 객체의 메서드만 호출해야 한다”라고 주장한다.

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

하지만 위 객체에서 허용된 메서드가 반환하는 객체의 메서드는 호출하면 안 된다.

 

기차 충돌

다음 코드는 디미터 법칙을 어기는 듯이 보인다.

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

• getOptions() 함수가 반환하는 객체의 getScratchDir() 함수를 호출한 후 getScratchDir() 함수가 반환하는 객체의 getAbsolutePath() 함수를 호출하기 때문이다.

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

 

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

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

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

 

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

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

 

잡종 구조

때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다. 잡종 구조는 중요한 기능을 수행하는 함수도 있고, 공개 변수나 공개 getter/setter 함수도 있다. 공개 getter/setter 함수는 비공개 변수를 그대로 노출한다.

잡종 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렵다. 그러므로 잡종 구조는 되도록 피하는 편이 좋다.

 

구조체 감추기

ctxt.getAbsolutePathOfScratchDirectoryOption();

ctxt.getScratchDirectoryOption().getAbsolutePath();

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

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

 

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

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

 

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

위와 같이 ctxt 객체에 임시 파일을 생성하라고 시키면 내부 구조를 드러내지 않으면서 모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다. 따라서 디미터 법칙을 위반하지 않는다.

 

 

자료 전달 객체(DTO : Data Transfer Object)

자료 구조체의 전형적인 형태는 공개 변수만 있고 함수가 없는 클래스다. 이런 자료 구조체를 때로는 자료 전달 객체(DTO : Data Transfer Object)라 한다.

DTO는 데이터베이스와 통신하거나 소켓에서 받은 메시지의 구문을 분석할 때 유용하다. 흔히 DTO는 데이터베이스에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체다.

좀 더 일반적인 형태는 빈(bean) 구조다. 빈은 비공개(private) 변수를 getter/setter 함수로 조작한다.

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의 특수한 형태다. 공개 변수가 있거나 비공개 변수에 getter/setter 함수가 있는 자료 구조지만, 대개 save나 find와 같은 탐색 함수도 제공한다. 활성 레코드는 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과다.

활성 레코드에 비즈니스 규칙 메서드를 추가해 이런 자료 구조를 객체로 취급하는 개발자가 흔하다. 하지만 이는 바람직하지 않다. 자료 구조도 아니고 객체도 아닌 잡종 구조가 나오기 때문이다.

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

 

 

결론

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

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

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

 

 

https://link.coupang.com/a/4ukH9

Clean Code(클린 코드):애자일 소프트웨어 장인 정신

 

https://link.coupang.com/a/4ukN3

클린 코드 + 클린 아키텍처 세트

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."