[개발서적] Clean Code 6. 객체와 자료 구조

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

충동이든 변덕이든, 변수 타입이나 구현을 맘대로 바꾸고 싶어서다.

 

그렇다면 어째서 많은 프로그래머가 조회(get)함수와 설정(set)함수를 당연하게 공개(public)해 비공개 변수를 외부로 노출할까?

 

[자료 추상화]

목록 6-1과 목록 6-2에서 차이를 살펴보자.

두 클래스 모두 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-2의 특징을 살펴보면

• 클래스 메서드(setCartesian, setPolar)가 접근 정책을 강제
• 좌표를 읽을 때는 각 값을 개별적으로 읽어야 함
• 하지만 좌표를 설정할 때는 두 값을 한꺼번에 설정해야 함

목록 6-1은

• 확실히 직교좌표계를 사용
• 개별적으로 좌표값을 읽고 설정이 가능
• 구현을 밖으로 노출

변수 사이에 함수라는 계층을 넣는다고 구현이 저절로 감춰지지 않는다.

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

 

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

 

목록 6-3과 목록 6-4를 살펴보자.

 

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

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

 

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

public interface Vehicle {
  double getPercentFuelRemaining();
}

 

목록 6-3은 자동차 연료 상태를 구체적인 숫자 값으로 알려준다.

반면 목록 6-4는 연료 상태를 백분율이라는 추상적인 개념으로 알려준다.

따라서 목록 6-1 보다는 목록 6-2가, 목록 6-3 보다는 목록 6-4가 더 좋다.

 

자료를 세세하게 공개하기보다는 추상적인 개념으로 표현하는 편이 좋다.

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

 

[자료/객체 비대칭]

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

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

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

 

예를 들어 목록 6-5를 살펴보자.

 

목록 6-5 절차적인 도형

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 클래스에서 구현한다.

 

객체 지향 프로그래머가 위 코드를 본다면 코웃음을 칠지도 모른다.

클래스가 절차적이라 비판한다면 맞는 말이다. 하지만 그런 비웃음이 100% 옳다고 말하기는 어렵다.

만약 Geometry 클래스에 둘레 길이를 구하는 perimeter() 함수를 추가하고 싶다면?

도형 클래스는 아무 영향을 받지 않는다. 도형 클래스에 의존하는 다른 클래스도 마찬가지다!

반대로 새 도형을 추가하고 싶다면?

Geometry 클래스에 속한 함수를 모두 고쳐야 한다!

 

두 조건은 완전히 정반대다.

 

이번에는 목록 6-6를 살펴보자.

 

목록 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-6은 객체 지향적인 도형 클래스다. 여기서 area함수는 다형 메서드다.

Geometry 클래스는 필요 없다. 그러므로 새 도형을 추가해도 기존 함수에는 아무런 영향이 없다.

반면 새 함수를 추가하고 싶다면 도형 클래스를 전부 고쳐야 한다.

 

요약해보면 객체 지향 코드에서 어려운 변경은 절차적인 코드에서 쉬우며,

절차적인 코드에서 어려운 변경은 객체 지향 코드에서 쉽다!

 

복잡한 시스템을 짜다 보면 새로운 함수가 아니라 새로운 자료 타입이 필요한 경우가 있다.

이때는 클래스와 객체 지향 기법이 가장 적합하다.

반면, 새로운 자료 타입이 아니라 새로운 함수가 필요한 경우가 생긴다.

이때는 절차적인 코드와 자료 구조가 좀 더 적절하다.

 

분별력 있게 상황에 맞춰 사용하자.

 

[디미터 법칙]

디미터 법칙은 잘 알려진 휴리스틱으로, 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙이다.

즉, 객체는 조회 함수로 내부 구조를 공개하면 안 된다는 의미다. 그러면 내부 구조를 노출하는 셈이니까.

 

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

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

 

흔히 위와 같은 코드를 기차 충돌이라 부른다.

여러 객체가 한 줄로 이어진 기차처럼 보이기 때문이다.

일반적으로 조잡하다 여겨지는 방식이므로 피하는 편이 좋다.

 

따라서 위의 코드는 다음과 같이 나누는 것이 좋다.

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

 

방금 살펴본 코드 예제는 둘 다 디미터 법칙을 위반할까?

 

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

객체라면 내부 구조를 숨겨야 하므로 확실히 디미터 법칙을 위반한다.

반면, 자료 구조라면 당연히 내부 구조를 노출하므로 디미터 법칙이 적용되지 않는다.

 

그런데 위 예제를 다음과 같이 구현한다면 디미터 법칙을 거론할 필요가 없어진다.

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

 

잡종 구조

이런 혼란으로 말미암아 때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다.

이런 잡종 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렵다.

그러므로 잡종 구조는 되도록 피하는 편이 좋다.

 

구조체 감추기

만약 ctxt, options, scratchDir이 진짜 객체라면?

그렇다면 앞서 코드 예제처럼 줄줄이 사탕으로 엮어서는 안 된다. 객체라면 내부 구조를 감춰야 하니까.

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

 

임시 디렉토리 경로가 왜 필요할까? 절대 경로를 얻어 어디에 쓰려고?

코드를 살펴보면, 결국 임시 디렉터리의 절대 경로는 임시 파일을 생성하기 위한 목적임이 드러난다.

그렇다면 ctxt 객체에 임시 파일을 생성하라고 시키면 어떨까?

 

BufferOutputStream bos = ctxt.createScratchFileStream(classFileName);

 

객체에 맡기기에 적당한 임무로 보인다!

 

ctxt 내부 구조가 드러나지 않으며, 모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요도 없다.

따라서 디미터 법칙을 위반하지 않는다.

 

[자료 전달 객체]

자료 구조체의 전형적인 형태는 공개 변수만 있고, 함수가 없는 클래스다.

이런 자료 구조체를 때로는 자료 전달 객체(DTO)라 한다. DTO는 굉장히 유용한 구조체다.

 

특히 데이터베이스와 통신하거나, 소켓에서 받은 메시지의 구문을 분석하는데 유용하다.

흔히 DTO는 데이터베이스에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체다.

 

DTO의 예는 목록 6-7을 참조하자.

 

목록 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와 같은 탐색 함수도 제공한다.

불행히도 활성 레코드에 비즈니스 규칙 메서드를 추가해 이런 자료 구조를 객체로 취급하는 개발자가 흔하다.

 

해결책은 간단하다. 활성 레코드는 자료 구조로 취급한다.

비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성한다.

 

[결론]

객체는 동작을 공개하고 자료를 숨긴다. 그래서 기존 동작을 변경하지 않으면서 새 객체를 추가하기 쉽다.

반면 자료 구조는 별다른 동작 없이 자료를 노출한다.

어떤 시스템을 구현할 때, 새로운 자료 타입을 추가하는 유연성이 필요하면 객체가 더 적합하다.

만약 새로운 동작을 추가하는 유연성이 필요하면 자료 구조와 절차적인 코드가 더 적합하다.

 

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