Clean Code - 객체와 자료구조

로버트 C.마틴의 클린 코드를 읽고 정리한 내용입니다.

자료 추상화

// 구체적인 클래스
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);
}

두 클래스는 2차원 점을 표현한다. 아래 코드는 직교좌표계를 사용하는지 극좌표계를 사용하는지 알 길이 없다. 그럼에도 인터페이스는 자료구조를 명백하게 표현하고 있다.

좌표를 읽을 때는 각 값을 개별적으로 읽어야 한다. 하지만 좌표를 설정할 때는 두 값을 한꺼번에 설정해야 한다.

구체적인 코드는 구현을 노출한다. 변수를 private으로 선언하더라도 각 값마다 get/set을 제공하면 구현을 외부로 노출하는 셈이다.

// 구체적인 클래스
public interface Vehicle {
	double getFuelTankCapacityInGallons();
	double getGallonsOfGasoline();
}

// 추상적인 클래스
public interface Vehicle {
	double getPercentFuelRemaining();
}

자료를 세세하게 공개하기보다는 추상적인 개념으로 표현하는 편이 좋다. 인터페이스나 get/set 함수만으로는 추상화가 이뤄지지 않는다. 아무 생각 없이 get/set 함수를 추가하는 방법이 가장 나쁘다.

자료/객체 비대칭

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

// 절차적인 도형 클래스
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 = (Ractangle)shape;
			return r.height * r.width;
		}
		else if (shape instanceof Circle) {
			Circle c = (Circle)shape;
			return PI * c.radius * c.radius;
		}
		throws new NoSuchShapeException();
	}
}

만약 위 클래스에 둘레 길이를 구하는 perimeter() 함수를 추가하더라도 Geometry 클래스는 아무 영향을 받지 않는다. 반대로 새 도형을 추가하고 싶다면 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 Rectangle implements Shape {
	private Point center;
	private double radius;
	public final double PI = 3.14592653589793;
	
	public double area() {
		return PI * radius * radius;
	}
}

객체 지향적인 도형 클래스의 area() 는 다형 메서드다. Geometry 클래스는 필요 없다. 그래서 새 도형을 추가해도 기존 함수에 아무런 영향을 미치지 않는다. 반면 새 함수를 추가하고 싶으면 도형 클래스 전부를 고쳐야 한다.

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

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

디미터 법칙

• 디미터 법칙이란 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙이다.
• 객체는 자료를 숨기고 함수를 공갠한다. 즉, 객체는 조회 함수로 내부 구조를 공개하면 안 된다는 의미이다. 그렇지 않으면 내부 구조를 노출하게 되기 때문이다.
• 좀 더 쉽게 표현하자면, 디미터 법칙은 “클래스 C의 메서드 f는 다음과 같은 객체의 메서드만 호출해야 한다.
  • 클래스 C
  • f가 생성한 객체
  • f 인수로 넘어온 객체
  • C 인스턴스 변수에 저장된 객체
• 여기서 중요한 것은 위 객체에서 허용된 메서드가 반환하는 객체의 메서드는 호출하면 안 된다. 낯선 사람은 경곅하고 친구랑만 놀라는 의미이다.

다음 코드는 디미터 법칙을 어기고 있다.

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

getOptions() 함수가 반환하는 객체의 getScratchDir() 함수를 호출한 후 getScratchDir() 함수가 반환하는 getAbsolutePath() 함수를 호출하기 때문이다.

기차 충돌

• 흔히 위와 같은 코드를 기차 충돌(train wreck)이라고 부른다. 여러 객차가 한 줄로 이어진 기차처럼 보이기 때문이다. 일반적으로 조잡한 방식이므로 피하는 편이 좋다. 아래와 같이 나누는 편이 좋다.

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

위 코드는 디미터 법칙을 위반할까? 확실히 함수 하나가 담당하는 역할이 많다. 위 코드를 사용하는 함수는 많은 객체를 탐색할 줄 안다는 말이 된다.

위 예제가 디미터 법칙을 위반하는지 여부는 ctxt, Options, ScratchDir이 객체인지 자료구조인지에 달렸다. 객체라면 내부 구조를 숨겨야 하므로 디미터 법칙을 위반한다. 반면, 자료 구조라면 당연히 내부 구조를 노출하므로 디미터 법칙을 위반하지 않는다.

그런데 위 예제는 조회 함수를 사용하는 바람에 혼란을 일으킨다. 코드를 다음과 같이 구현한다면 디미터 법칙을 거론할 필요도 없다.

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

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

잡종 구조

• 절반은 객체, 절반은 자료 구조인 잡종 구조가 나오는 경우가 있다.
• 잡종 구조는 중요한 기능을 수행하는 함수, 공개 변수, 공개 get/set 함수가 섞여 있다.
• 공개 get/set 함수는 비공개 변수를 그대로 노출한다.
• 이런 잡종 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렵다.
• 잡종 구조는 되도록 피하자
• 프로그래머가 함수나 타입을 보호할지 공개할지 확신하지 못해 어중간하게 내놓은 설계를 만들어내기 때문이다.

자료 전달 객체

• 자료 구조체의 전형적인 형태는 공개 변수만 있고 함수가 없는 클래스다.
• 이런 자료 구조체를 자료 전달 객체(Data Transfer Object, DTO)라고 한다.
• DTO는 데이터베이스와 통신하거나 소켓에서 받은 메시지의 구문을 분석할 때 유용하다.
• 흔히 DTO는 데이터베이스에 저장된 가공되지 않은 정보를 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체이다.
• 좀 더 일반 적인 형태는 빈(bean) 구조다. 빈은 공개 변수를 get/set 함수로 조작한다.

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의 특수한 형태다.
• 공개 변수가 있거나 비공개 변수에 get/set 함수가 있는 자료 구조지만, save나 find와 같은 탐색 함수도 제공한다.
• 활성 레코드는 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과다.
• 활성 레코드에 비즈니스 로직 메서드를 추가해 자료 구조를 객체로 취급하는 개발자가 흔하다. 하지만 이 방법은 바람직하지 않다. 자료 구조도 아니고 객체도 아닌 잡종 구조가 나오기 때문이다.
• 해결책은 활성 레코드를 자료 구조로 취급하는 것이다. 비즈니스 로직을 담으면서 내부 자료를 숨기는 객체는 따로 생성한다. (여기서 내부 자료는 활성 레코드의 인스턴스일 가능성이 높다.)

결론

• 객체는 동작을 공개하고 자료 구조는 숨긴다.
• 기존 동작을 변경하지 않으면서 새 객체 타입을 추가하기는 쉬운 반면, 기존 객체에 새 동작을 추가하기는 어렵다.
• 자료 구조는 별다른 동작 없이 자료를 노출한다. 그래서 기존 자료 구조에 새 동작을 추가하기는 쉽지만, 기존 함수에 새 자료 구조를 추가하기는 어렵다.
• 시스템을 구현할 때, 새로운 자료 타입을 추가하는 유연성이 필요하면 객체가 더 적합하다.
• 다른 경우로 새로운 동작을 추가하는 유연성이 필요하면 자료 구조와 절차적인 코드가 더 적합하다.
• 개발자는 편견 없이 이 사실을 이해해 직면한 문제에 최적화된 해결책을 선택해야 한다.