이 글은 Clean code 책 내용을 정리한 글입니다.

저작권 관련 문제가 있다면 "[email protected]"으로 메일 보내주시면, 바로 삭제하도록 하겠습니다

6장 객체와 자료구조

변수를 private로 정의하는 것은 남들이 변수에 의존하지 않게 만들고 싶어서입니다.
그런데 대부분의 프로그래머들은 조회(get), 설정(set) 함수를 당연하게 public으로 공개할까?

자료 추상화

구현을 감추기 위해서는 추상화가 필요합니다.

변수 사이에 함수라는 계층을 넣는다고 구현이 감춰지지 않습니다.
조회/설정 함수로 변수를 다룬다고 감춰지는 것이 아닙니다. 그보다는 추상 인터페이스를 제공해 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 진정한 의미의 클래스입니다.
그렇다고 인터페이스나 조회/설정 함수만으로는 추상화가 이뤄지는 것은 아닙니다. 개발자는 객체가 포함하는 자료를 표현할 방법을 고민해봐야합니다. 아무 생각 없이 조회/설정 함수를 추가하는 방법은 좋지 않습니다.

// 구체적인 Point 클래스
// 명확하게 직교 좌표계를 쓴다는 것을 알 수 있다.
public class Point {
	public double x;
	public double y;
}

// 추상적인 Point 클래스
// 클래스 메서드가 접근 정책을 강제한다.
// = 값을 읽을때 get으로 값을 개별적으로 읽어야 한다. 하지만 좌표를 설정할 때는 두 값을 한꺼번에 설정해야한다.
// 이게 더 좋음

public interface Point {
	double getX(); 
	double getY(); // 조회는 각각 가능하지만
	void setCartesian(double x, double y); // 설정을 2개의 값을 동시에 넣어주어야 한다.
	double getR();
	double getTheta();
	void setPolar(double r, double theta);

추가 내용 : interface란 추상 메서드의 집합 + static 메서드 + default 메서드 + 상수라고 보면 됨
interface에는 제어자,지정자가 생략되어서 표현되어있다.
예를 들어 double getR()은 사실 public abstract double getR()이고,
코드에는 안나와있지만 만약 int num = 1; 이라고 선언되어있다면
이건 public static final int num = 1인 상수를 의미한다.

// 구체적인 Vehicle 클래스
// 변수를 그대로 리턴하는 함수일 것이 틀림없다.
public interface Vehicle {
	public getFuelThankCapacityInGallons();
	public getGallonsOfGasoline();
}

// 추상적인 Vehicle 클래스
// 백분율이라는 추상적인 개념으로 반환하기에 어디서 오는지 사용자에게 드러나지 않는다.
// 이게 더 좋음
public interface Vehicle {
	double getPercentFuelRemaining();
}

자료/객체 비대칭

자료와 자료 구조는 본질적으로 상반됩니다.

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

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

절차적인 도형

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 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) 메서드를 제공합니다. 새 도형을 추가해서 기존 함수에 아무런 영향을 미치지 않습니다. 반면 새 함수를 추가하고 싶다면 도형 클래스 전부를 고쳐야 합니다.

앞서도 말했듯이, 두 방식은 사실상 반대입니다! 그래서 객체와 자료 구조는 근본적으로 양분됩니다.

(자료 구조를 사용하는) 절차적인 코드는 기존 자료 구조를 변경하지 않으면서 새 함수를 추가하기 쉽다. 반면, 객체 지향 코드는 기존 함수를 변경하지 않으면서 새 클래스를 추가하기 쉽다.

반대쪽도 참입니다.

절차적인 코드는 새로운 자료 구조를 추가하기 어렵다. 그러려면 모든 함수를 고쳐야 한다. 객체 지향 코드는 새로운 함수를 추가하기 어렵다. 그러려면 모든 클래스를 고쳐야 한다.

복잡한 시스템을 짜다 보면 새로운 함수가 필요할 경우거나, 새로운 자료 타입이 필요한 경우가 생깁니다. 이때 상황에 맞게 클래스 & 객체 지향 기법을 사용하거나, 절차적인 코드와 자료 구조를 적절하게 사용하는 것이 좋습니다. 때로는 단순한 자료 구조와 절차적인 코드가 가장 적합한 상황일 수 있습니다.

디미터 법칙

디미터 법칙은 잘 알려진 휴리스틱heuristic(경험에 기반하여 문제를 해결하거나 학습하거나 발견해 내는 방법)으로, 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙입니다. 즉, 객체는 자료를 숨기고 함수를 공개하여 조회 함수로 내부 구조를 공개하면 안된다는 의미입니다.

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

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

하지만 위 객체에서 허용된 메서드가 반환하는 객체의 메서드는 호출하면 안 됩니다. 다시 말해, 낯선 사람은 경계하고 친구랑만 놀라는 의미입니다.

기차 충돌

다음과 같은 디미터 법칙을 어기는 듯한 코드를 기차 충돌train wreck이라 부릅니다. getOptions()함수가 반환하는 객체의 getScratchDir()함수를 호출한 후 getScratchDir() 함수가 반환하는 객체의 getAbsouluthpath()함수를 호출하기 때문입니다.

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.oprions.scratchDir.absolutePath;

만약 이런 코드라면 자료구조이기 때문에 문제가 되지 않음이 명백합니다.

이런 혼란으로 말미암아 때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나옵니다. 잡종 구조는 중요한 기능을 수행하는 함수도 있고, 공개 변수나 공개 get/set 함수도 있습니다. 이런 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렸습니다. 양쪽 세상에서 단점만 모아놓은 구조. 그러므로 되도록 이런 구조는 피하도록 합니다. 프로그래머가 함수나 타입을 보호할지 공개할지 확신하지 못해 (더 나쁘게는 무지해) 어중간하게 내놓은 설계에 불과하기 때문입니다.

구조체 감추기

위의 outputDir 예제의 경우 좋은 방식이 아니다. 이 경로를 왜 필요할지 같은 모듈에서 찾아 보았더니 (한참 아래로 내려가서) 이런 코드가 있다.

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

추상화 수준을 뒤섞어 놓아 다소 불편합니다. 점, 슬래시, 파일 확장자, File 객체를 부주의하게 마구 뒤섞으면 안 되기 때문입니다. 어찌 되었거나, 위 코드에 따르면 경로를 얻으려는 이유가 임시 파일을 생성하기 위함을 알 수 있습니다.

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

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

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

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

자료 전달 객체

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

추가 내용 : spring에서는 Service, Co이터를 ntroller,Repository 각 계층간에 전달, 교환할 때 사용되는 클래스로도 볼 수 있습니다.

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

활성 레코드

DTO의 특수한 형태입니다. 공개 변수가 있거나 비공개 변수에 getter/setter가 있는 자료 구조지만, 대게 save나 find와 같은 탐색 함수도 제공합니다. 활성 레코드는 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과입니다.
불행히도 활성 레코드에 비즈니스 규칙 메서드를 추가해 이런 자료 구조를 객체로 취급하는 개발자가 흔합니다. 하지만 이렇게 하게 되면 잡종 구조가 나오게 된다.

해결책은 당연히 활성 레코드는 자료 구조로 취급하는 것입니다. 비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성해야 합니다. (여기서 내부 자료는 활성 레코드의 인스턴스일 가능성이 높다.)

결론

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

객체 지향 코드는 새 클래스를 추가하기 쉽지만 새 함수를 추가하기는 어렵다.

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

(어떤) 시스템을 구현할 때, 새로운 자료 타입을 추가하는 유연성이 필요하면 객체가 더 적합합니다. 다른 경우로 새로운 동작을 추가하는 유연성이 필요하면 자료 구조와 절차적인 코드가 더 적합합니다. 우수한 소프트웨어 개발자는 편견 없이 이 사실을 이해해 직면한 문제에 최적인 해결책을 선택해야 합니다.