본문 바로가기

기타/클린 코드

[클린 코드] 객체와 자료구조

자료 추상화

변수를 private으로 선언하더라도 각 값마다 get 함수와 set 함수를 제공한다면 구현을 외부로 노출하는 셈이다. 변수 사이에 함수라는 계층을 넣는다고 구현이 감춰지지 않는다. 구현을 감추려면 추상화가 필요하다.

 

객체(Objects)와 자료구조(Data Structure)

객체 자료구조
추상화 자료를 숨긴 채 자료를 다루는 함수만 공개한다. 자료를 그대로 공개하며 다른 함수는 제공하지 않는다.
동작을 공개하고 자료를 숨긴다. 동작을 숨기고 자료를 공개한다.
(기존 동작을 변경하지 않으면서) 새 객체 타입을 추가하기 쉽다. 새 자료구조를 추가하기 어렵다.
객체에 새 동작을 추가하기 어렵다. 새 동작을 추가하기 쉽다.

잡종구조(hybrid)

객체도 자료구조도 아닌 구조이다. 잘못된 설계이므로 사용하지 않아야 한다.

 

  • 구체적인 Point 클래스
public class Point {
	public double x;
	public double y;
}

 

  • 추상적인 Point 클래스
public interface Point {
	double getX();
	double getY(); // 조회는 각각 가능하지만
	void setCartesian(double x, double y); // 2개의 값을 동시에 설정하도록 강제한다.
	double getR();
	double getTheta();
	void setPolar(double r, double theta);
}

 

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

 

  • 다형적인 도형
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;
	} 
}

 

디미터 법칙

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

ex) 클래스 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()

객체라면 내부 구조를 숨겨야 하므로 디미터 법칙을 위반한다. 자료구조라면 내부 구조를 노출 하므로 디미터 법칙이 적용되지 않는다. 그런데 위 예제는 getter 함수를 사용하는 바람에 자료구조인지 객체인지 알 수 없다.

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

코드를 위와 같이 구현한다면 디미터법칙을 거론할 필요가 없다. (자료구조이기 때문에)

 

DTO(Data Transfer Object)

자료구조체의 전형적인 형태이다. 공개 변수만 있고 함수가 없는 클래스이다. 데이터베이스에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체이다.

  class Address {
      private final String postalCode;
      private final String city;
      private final String street;
      private final String streetNumber;
      private final String apartmentNumber;

      public Address(String postalCode, String city, String street, String streetNumber, String apartmentNumber) {
          this.postalCode = postalCode;
          this.city = city;
          this.street = street;
          this.streetNumber = streetNumber;
          this.apartmentNumber = apartmentNumber;
      }

      public String getPostalCode() {
          return postalCode;
      }

      public String getCity() {
          return city;
      }

      public String street() {
          return street;
      }

      public String streetNumber() {
          return streetNumber;
      }

      public String apartmentNumber() {
          return apartmentNumber;
      }
  }

 

활성레코드

DTO의 특수한 형태이다. 공개변수가 있거나 비공개 변수에 조회/설정 함수가 있는 자료구조지만, 대개 save나 find와 같은 탐색 함수도 제공한다. 활성레코드는 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과다. 활성레코드는 자료구조이다.