[Clean Code] 객체와 자료구조

자료 추상화

구체적인 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); 
}

• set, get 메서드로 변수를 다룬다고 클래스가 되는 것이 아니다.
• 추상 인터페이스를 제공해 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 진정한 의미의 클래스다.

자료/객체 비대칭

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

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

절차적인 도형

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

• 기존 자료 구조를 변경하지 않으면서 새 함수를 추가하기 쉽다.
• 새로운 자료 구조를 추가하려면 모든 함수를 고쳐야 한다.

다형적인 도형

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

• 기존 함수를 변경하지 않으면서 새 클래스를 추가하기 쉽다.
• 새로운 함수를 추가하려면 모든 클래스를 고쳐야 한다.

복잡한 시스템을 짜다 보면 새로운 함수가 필요할 경우거나, 새로운 자료 타입이 필요한 경우가 생긴다.

상황에 맞게 클래스와 객체 지향 기법을 사용하거나, 절차적인 코드와 자료 구조를 적절하게 사용하는 것이 좋다.

디미터 법칙

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

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

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

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

낯선 사람은 경계하고 친구랑만 놀라는 의미이다.

기차 충돌

Bad

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

• 위 예제가 디미터 법칙을 위반하는지 여부는 위의 변수들이 객체인지 자료 구조인지에 달렸다.
• 자료 구조라면 당연히 내부 구조를 노출하므로 문제되지 않는다.

  Good

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

잡종 구조

• 때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다.
• 잡종 구조는 중요한 기능을 수행하는 함수도 있고, 공개 변수나 공개 get/set 함수도 있다.
• 이런 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렵다.
• 양쪽 세상에서 단점만 모아놓은 구조이니 되도록 이런 구조는 피하도록 하자.

구조체 감추기

임시 디렉터리의 절대 경로는 어떻게 얻어야 좋을까?

ctxt.getAbsolutePathOfScratchDirectoryOption();
ctxt.getScratchDirectoryOption().getAbsolutePath();

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

다음은 같은 모듈에서 (한참 아래로 내려가서) 가져온 코드다.

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

• 임시 파일을 생성하기 위한 목적이라는 사실이 드러난다.
• 하지만 추상화 수준을 뒤섞어 놓아 다소 불편하다.
• 점, 슬래시, 파일 확장자, File 객체를 부주의하게 마구 뒤섞으면 안 된다.

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

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

• 객체에게 맡기기에 적당한 임무로 보인다!
• ctxt는 내부 구조를 드러내지 않으며, 모듈은 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다.
• 따라서 디미터 법칙을 위반하지 않는다.

자료 전달 객체

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

이를 때로는 자료 전달 객체 DTO(Data Transfer Object)라 한다.

public class Address { 
  public String street; 
  public String streetExtra; 
  public String city; 
  public String state; 
  public String zip;
}

활성 레코드

• 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과다.
• DTO의 특수한 형태다.
• 대게 save나 find와 같은 탐색 함수도 제공한다.
• 활성 레코드에 비즈니스 규칙 메서드를 추가해 이런 자료 구조를 객체로 취급하면 안 된다.
• 활성 레코드는 자료 구조로 취급해야 한다.
• 비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성한다.
  • 여기서 내부 자료는 활성 레코드의 인스턴스일 가능성이 높다

결론

새로운 자료 타입을 추가하는 유연성이 필요하면 객체가 더 적합하다.

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

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