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

• 변수를 비공개로 정의하는 이유가 있다. 남들이 변수에 의존하지 않게 만들고 싶어서이다.
• 그렇다면 어째서 수많은 프로그래머가 조회함수와 설정함수를 당연하게 공개하여 비공개 변수를 외부에 노출할까?

1. 자료 추상화

• 한 클래스는 구현을 외부로 노출하고, 다른 클래스는 구현을 완전히 숨긴다.

public class Point{
	public double x;
	public double y;
}

public interface Point {
	double getX();
	double getY();
	void setCartesian(double x, double y);
	double getR();
	double getTheta();
	void setPolar(double r, double theta);
}

• 추상적인 Point 코드는 직교좌표계를 사용하는지, 극좌표계를 사용하는지 알 길이 없다. 하지만 인터페이스는 자료구조를 명백하게 표현한다.
• 인터페이스는 클래스 메서드가 접근 정책을 강제하고, 좌표를 읽을때는 각 값을 개별적으로 읽어야 한다. 하지만 좌표를 설정할 때는 두 값을 한번에 설정해야한다.
• 클래스는 확실히 직교좌표계를 사용한다. 또한 개별적으로 좌표값을 읽고 설정하게 강제한다. 그리고 구현을 노출한다

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

public interface Vehicle {
	double getPercentFuelRemaining();
}

• #1은 자동차 연료 상태를 구체적인 숫자 값으로 알려주지만, #2는 백분율이라는 추상적인 개념으로 알려준다. #1은 두 함수가 변수값을 읽어 반환할 뿐이라는 사실이 거의 확실한데, #2는 정보가 어디서 오는지 전혀 드러나지 않는다

---

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

2. 자료/객체 비대칭

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

public class Square {
	public Point topLeft;
	public double side;
}

public class Rectangle {
	public Point topLeft;
	public double height;
	public double width;
}

public class Circle {
	publc Point center;
}

public class Circle {
	public Point center;
	public double radius;
}

public class Geometry {
	public final double PI = 3.14
	
	public double area(Object shape) throws NoSuchShapeException
	{
		if (shape instanceof Square) {
			Square s = (Square)shape;
			return s.side *s.side;
		}
		else if (shape instancef 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 클래스에 둘레 길이를 구하는 perimeter() 함수를 추가하고 싶다면 도형 클래스는 아무 영향도 받지 않는다, 반대로 새 도형을 추가하고 싶다면 Geometry 클래스에 속한 함수들을 모두 고쳐야 한다. 두 조건은 완전히 상반대다.

public class Square imlements 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.14;
	
	public double area() {
		return PI * radius * radius;
	}
}

• 위 코드에서는 새 도형을 추가해도 기존 함수에 아무런 영향을 미치지 않는다. 반면 새 함수를 추가하고 싶다면 도형 클래스 전부를 고쳐야 한다.

요악하면 다음과 같다.

• 자료구조를 사용하는 절차적인 코드는, 기존 자료 구조를 변경하지 않으면서 새 함수를 추가하기 쉽다. 반면, 객체 지향 코드는 기존 함수를 변경하지 않으면서 새 클래스를 추가하기 쉽다.
• 절차적인 코드는 새로운 자료 구조를 추가하기 어렵다. 그러려면 모든 함수를 고쳐야 한다. 객체 지향 코드는 새로운 함수를 추가하기 어렵다. 그러려면 모든 클래스를 고쳐야 한다.

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

3. 디미터 법칙

• 디미터 법칙은 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙이다. 좀 더 정확히 표현하자면, 디미터 법칙은 클래스 C의 메서드 f는 다음과 같은 객체의 메서드만 호출해야 한다고 주장한다.
  • 클래스 C
  • f가 생성한 객체
  • f 인수로 넘어온 객체
  • C 인스턴스 변수에 저장된 객체
• 다음 코드는 디미터 법칙을 어기는 듯이 보인다. getOpions() 함수가 반환하는 객체의 getScaratchDir() 함수를 호출한 후 getScratchDir() 함수가 반환하는 객체의 getAbsolutePath() 함수를 호출하기 때문이다.
  • final String outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath();

기차 충돌

• 흔히 위와 같은 코드를 기차 충돌이라 부른다. 여러 객체가 이어진 기차처럼 보이기 때문이다.

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

• 위 코드처럼 나누는게 좋다, 위 코드 형태로 구현된 함수는 ctxt 객체가 Options를 포함하며, Options가 ScratchDir을 포함하며, ScratchDir이 AbsolutePath를 포함한다는 사실을 안다.
• 위 예제가 디비터 법칙을 위반하는지 여부는 ctxt, Options, ScratchDir이 객체인지 아니면 자료구조인지에 달렸다.
  • 객체면 내부 구조를 숨겨야하므로, 확실히 디미터 법칙을 위반하는 반면 자료 구조라면 당연히 내부 구조를 노출하므로 디미터 법칙이 적용되지 않는다.
  • 자료 구조는 무조건 함수 없이 공개 변수만 포함하고, 객체는 비공개 변수와 공개 함수를 포함한다면 문제는 간단해지는데, 하지만 단순한 자료 구조에도 조회 함수와 설정 함수를 정의하라 요구하는 프레임워크와 표준이 존재한다.

잡종 구조

• 이런 혼란때문에 때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다.
  • 잡종 구조는, 중요한 기능을 수행하는 함수도 있고, 공개 변수나 공개 조회/설정 함수도 있다.
• 이런 잡종 구조는 새로운 함수는 물론이고 새로운 자료구조도 추가하기 어렵다. 그러므로 잡종 구조는 되도록 피하는게 좋다.

구조체 감추기

• 만약에 ctxt, options, scratchDir이 진짜 객체면, 앞서 코드 예제처럼 줄줄이 사탕으로 엮어서는 안된다. 그렇다면 임시 디렉터리의 절대 경로는 어떻게 얻어야 좋을까?

ctxt.getAbsolutePathOfScratrchDirectoryOption();

ctxt.getScratchDirectoryOption().getAbsolutepath();

• 첫 번째 방법은 txt 객체에 공개해야 하는 메서드가 너무 많아진다.
• 두 번쨰 방법은 getScratchDirectoryOption()이 객체가 아니라 자료 구조를 반환한다고 가정한다. 여기서 어느 방법도 썩 내키지 않는다.
• 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는 내부 구조를 드러내지 않으며, 모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다. 따라서 디미터 법칙을 위반하지 않는다.

4. 자료 전달 객체

• 자료 구조체의 전형적인 형태는 공개 변수만 있고 함수가 없는 클래스다. 이런 자료 구조체를 때로는 자료 전달 객체 DTO라 한다.
• DTO는 굉장히 유용한 구조체이다. 특히 데이터베이스와 통신하거나, 소켓에서 받은 메시지의 구문을 분석할 때 유용하다.
• 좀 더 일반적인 형태는 ‘빈(bean)’ 구조인데, 빈은 비공개 변수를 조회/설정 함수로 조작한다. 빈은 별다른 이익을 제공하지 않는다.

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

활성 레코드

• 활성 레코드는 DTO의 특수한 형태이다. 공개 변수가 있거나 비공개 변수에 조회/설정 함수가 있는 자료 구조지만, 대개 savs나 find와 같은 탐색 함수도 제공한다.
• 불행히도 활성 레코드에 비즈니스 규칙 메서드를 추가해 이런 자료 구조를 객체로 취급받는 개발자가 흔하다. 하지만 잡종 구조를 만들어 내기 때문에 바람직 하지 않다.
• 해결책은 활성 레코드는 자료 구조로 취급하여 비즈니스 규칙을 담으면서, 내부 자료를 숨기는 객체를 따로 생성하면 된다.

요약

• 객체는 동작을 공개하고 자료를 숨기지만 기족 동작을 변경하지 않으면서 새 객체 타입을 추가하기는 쉬운 반면, 기존 객체에 새 동작을 추가하기는 어렵다
• 자료 구조는 별다른 동작 없이 자료를 노출해서 기존 자료 구조에 새 동작을 추가하기는 쉬우나, 기존 함수에 새 자료를 추가하기는 어렵다.
• 어떤 시스템을 구현할 때, 새로운 자료 타입을 추가하는 유연성이 필요하면 객체가 더 적합하다. 반면에 새로운 동작을 추가하는 유연성이 필요하면 자료 구조와 절차적인 코드가 더 적합하다.