클린 코드 - 6장 객체와 자료 구조



Intro



초서-독서 한 내용을 그대로 적는 곳이기 때문에 책을 읽지 않은 분들이 보기에 맥락이 애매할 수 있습니다.

초서 : 책을 읽는데 그치는 것이 아닌 손을 이용해 책의 중요한 내용을 옮겨 적음으로써 능동적으로 책의 내용을 수용하고 판단하여 새로운 지식을 재창조하는 과정. 메타인지 학습법




Index





6장 객체와 자료 구조


자료 추상화

두 코드는 2차원 점을 표현한다.

  • 코드1
      public class Point {
          public double x;
          public double y;
      }
    
  • 코드2
      public interface Point {
          double getX();
          double getY();
          void setCartesian(double x, double y);
          double getR();
          double getTheta();
          void setPolar(double r, double theta);
      }
    

아래 인터페이스로 짜여진 코드2는 직교좌표계를 사용하는지 극좌표계를 사용하는지 알 길이 없다.
그럼에도 불구하고 자료구조를 명백하게 표현한다.
클래스 메서드가 접근 정책을 강제하고 좌표를 읽을 때는 각 값을 개별적으로 읽어야 한다.


반면 코드1은 확실히 직교좌표계를 사용한다.
개별적으로 좌표값을 읽고 설정하게 강제하며 구현을 노출한다.

변수를 private 으로 선언하더라도 각 값마다 조회(getter) 함수와 설정(setter) 함수를 제공한다면 구현을 외부로 노출하는 셈이다.


변수 사이에 함수라는 계층을 넣는다고 구현이 저절로 감춰지지는 않는다.
구현을 감추기 위해선 추상화가 필요하다.
추상 인터페이스를 제공해 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 진정한 의미의 클래스이다.


다른 두 코드를 살펴보자.

  • 코드3
      public interface Vehicle {
          double getFuelTankCapacityInGallons();
          double getGallonsOfGasoline();
      }
    
  • 코드4
      public interface Vehicle {
          double getPercentFuelRemaining();
      }
    

코드3 은 자동차 연료 상태를 구체적인 숫자 값으로 알려준다.
반면 코드4 는 자동차 연료를 백분율이라는 추상적인 개념으로 알려준다.


코드3 은 두 함수가 변수값을 읽어 반환할 뿐이라는 사실이 거의 확실하다.
반면 코드4 는 정보가 어디서 오는지 전혀 드러나지 않는다.


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


자료/객체 비대칭

객체는 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 제공한다.
반면 자료구조는 자료를 그대로 공개하며 별다는 함수는 제공하지 않는다.
(두 정의는 본질적으로 상반된다)


다음은 절차적인 도형 클래스이다.
각 도형 클래스는 간단한 자료구조이다.

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 = Math.PI;
    
    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();
      }
}

객체 지향적 사고로 위 코드를 바라본다면 어설퍼보인다.
만약 저 코드에 perimeter() 함수를 추가하고 싶으면?
도형 클래스는 아무도 영향을 받지 않는다. 그저 함수를 추가하고 구현하기만 하면 된다.


하지만 새 자료구조(도형)를 추가하고 싶다면?
Geometry 클래스에 속한 함수를 모두 고쳐야만 한다.


이번에는 객제 지향적인 코드를 살펴보자.

public class Square implements Shape{

  private Point topLeft;
  private double side;

  @Override
  public double getArea() {
    return side * side;
  }
}

public class Rectangle implements Shape{

  public Point topLeft;
  public double height;
  public double width;

  @Override
  public double getArea() {
    return height * width;
  }
}

public class Circle implements Shape{

  public Point center;
  public double radius;

  @Override
  public double getArea() {
    return radius * radius * Math.PI;
  }
}

여기에 새 도형을 추가해도 기존 함수에 아무런 영향을 미치지 않는다.
반면 새 함수를 추가하고 싶다면 도형 클래스 전부를 고쳐야 할 것이다.


복잡한 시스템을 짜다 보면 새로운 함수가 아니라 새로운 자료 타입이 필요한 경우가 생긴다.
이때는 클래스와 객체 지향 기법이 가장 적합하다.


반면 새로운 자료타입이 아니라 새로운 함수가 필요한 경우도 생긴다.
이때는 절차적인 코드와 자료 구조가 좀 더 적합하다.


어느 방식이 필요할지는 주어진 상황에 맞게 편견 없이 최적의 해결책을 선택하는것이 현명하다.


디미터 법칙

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

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

즉, 객체는 조회 함수로 내부 구조를 공개하면 안된다는 의미다.
좀 더 정확히 표현하면 “클래스 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 객체가 Options 를 포함하며, OptionsScratchDir 을 포함하고,
ScratchDirAbsolutePath 를 포함한다는 사실을 알 수 있다.


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


그런데 위 예제는 조회(get블라블라) 함수를 사용하는 바람에 혼란을 일으킨다.
자료구조 였더라면 아래와 같이 표현됐을 것이다.

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


자료 구조는 무조건 (함수 없이) 공개 변수만 포함하고
객체는 비공개 변수와 공개 함수를 포함한다면 문제는 훨씬 간단해진다.
하지만 자료 구조에도 설정 함수를 정의하라 요구하는 프레임워크와 표준(bean 과 같은..)이 존재한다.


잡종 구조

이런 혼란으로 말미암아 떄때로 절반은 객체, 절반은 자료구조인 잡종 구조가 나온다.
공개 조회/설정(getter/setter) 함수는 비공개 변수를 그대로 노출한다.
덕택에 다른 함수가 절차적인 프로그래밍의 자료 구조 접근 방식처럼 비공개 변수를 사용하고픈 유혹(기능 욕심)에 빠지기 십상이다.


구조체 감추기

만약 ctxt, Options, ScratchDir 가 객체라면 앞서 코드 예제처럼 줄줄이 사탕으로 엮어서는 안 된다.
(객체라면 내부 구조를 감춰야 하므로)


ctxt 가 객체하면 ‘뭔가를 하라고’ 말해야지 속을 드러내라고 (자신의 내부를)말하면 안 된다.
임시 디렉터리의 절대 경로가 왜 필요할까? 얻어서 어디에 쓸려고?
다음은 같은 모듈에서 (한참 아래로 내려가서) 가져온 코드이다.

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

절대 경로를 얻으려는 이유가 임시 파일을 생성하기 위한 목적이라는 사실이 드러났다.
그렇다면 ctxt 객체에 임시 파일을 생성하라고 시키면 어떨까?

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

확실히 객체에게 맡기기 적당한 임무에다 내부 구조 또한 드러내지 않으며,
모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 뒤적뒤적 탐색할 필요가 없어지게 된다.
따라서 디미터 법칙을 위반하지 않게 된다.


자료 전달 객체(DTO)

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


주로 데이터베이스와 통신하거나 소켓에서 받은 메시지의 구문을 분석할 때 유용하다.
좀 더 일반적인 형태는 ‘빈(bean)’ 구조이다. 빈은 비공개 변수를 조회/설정 함수로 조작한다.
일종의 사이비 캡슐화로, 일부 OO 순수주의자나 만족시킬 뿐 별다른 이익을 제공하지 않는다.