[Clean Code] 6. 객체와 자료 구조

Clean Code ..............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................

본 게시글은 도서, Clean Code를 읽고 정리한 글입니다.

Clean Code(클린 코드) | 로버트 C. 마틴 - 교보문고

 

1. 자료 추상화

// 구체적인 Point 클래스
public class Point {
    private double x;
    private double y;
    
    public double getX() {
    	return x;
    }
    
    public double getY() {
    	return y;
    }
    
    public void setX(double x) {
    	this.x = x;
    }
    
    public void setY(double y) {
    	this.y = y;
    }
}

// 추상적인 Point 클래스
public interface Point {
    double getX();
    double getY();
    void setCartesian(double x, double y);
    double getR();
    double getTheta();
    void setPolar(double r, double theta);
}

 

위 두 코드의 차이점을 보자.

 

첫 번째 코드는 직교좌표계를 나타낸다. 그런데 두 번째 코드에서는 무슨 좌표계인지 알 수 없다.

그 말은 곧,  첫 번째 코드는 구현을 노출하고, 두 번째 코드는 그렇지 않다.

 

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

 

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

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

 

위 두 코드를 비교하면, 어느정도의 추상화는 이루어졌지만 더욱 추상화된 두 번째 코드가 더 좋다.

 

최대한 자료를 공개하지 않고 추상적인 개념으로 표현하려고 해야 한다.

  

  

2. 자료 / 객체 비대칭

위 1번에서 보자면 객체와 자료 구조는 서로 반대되는 개념인데, 

객체는 추상화 뒤로 자료를 숨기고, 자료를 다루는 함수만 공개한다.

자료 구조는 있는 그대로를 공개하며, 별다른 함수를 제공하지 않는다.

 

이 반대되는 개념에 대해 설명하고자 한다.

 

// 절차지향적 
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;
}

publi class Geometry {
    public final double PI = 3.141592653589793;
    
    public double area(Object shape) throws NoSuchShapeException {
        ...
    }
}

 

이 코드는 절차적인 코드인데, 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 Circle implements Shape {
    private Point center;
    private double radius;
    public final double PI = 3.141592653589793;
    
    public double area() {
        return PI * radius * radius;
    }
}

 

반면 위 코드에서는객체 지향 코드로서, 새 도형을 추가해도 기존 함수에 영향이 없고, 새 함수를 추가하고 싶다면 도형 클래스 전체를 고쳐야 한다.

 

그렇기 때문에 객체와 자료 구조는 반대 개념이다.

 

다시 말해 객체 지향 코드에서 어려운 변경은 절차 지향 코드에서 쉽고, 절차 지향 코드에서 어려운 변경은 객체 지향 코드에서 쉽다.

 

그렇기 때문에 객체 지향적인 코드가 만능이란 것은 아니다. 상황에 맞게 짜는 능력이 중요하다.

  

  

3. 디미터 법칙

디미터 법칙은 모듈은 자신이 조작하는 객체의 자세한 사정을 몰라야 한다 라는 법칙이다.

아까 말했던 객체는 자료를 숨기고, 함수를 공개하는 것이 여기에 속한다. 

 

디미터 법칙은 "클래스 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, scratchDir이 객체냐 자료구조냐에 따라 다르다.

객체라면 당연히 내부 구조를 숨겨야 하므로 디미터 법칙을 위반한다고 볼 수 있고, 자료 구조라면 그렇지 않다.

그래서 헷갈린다. 그래서 아래처럼 고치면?

 

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

 

이렇게 조회함수를 사용하지 않으면 헷갈릴 일이 없다. 자료구조니까.

 

 

잡종 구조

일부는 객체, 일부는 자료 구조인 형태를 잡종 구조라고 한다.

이런 잡종 구조는 새로운 함수 추가는 물론, 새로운 자료 구조 추가도 어렵다.

양쪽의 단점을 모두 가져간 형태기 때문에 피하는 것이 좋다.

 

 

구조체 감추기

만약 위 사례에서 ctxt, options, scratchDir이 객체라면 내부 구조를 감춰야 하므로 기차처럼 엮어서는 안된다.

 

ctxt가 객체라면, 뭔가를 하라고 말하자. 속을 드러내라고 하지 말자. 

이 outputDir는 결국 이름으로 유추하면 임시 디렉터리의 절대 경로를 나타낸다.

 

임시 디렉터리의 절대 경로를 얻어야 하는 이유가 만약 임시 파일을 생성하기 위한 것이였다고 가정하자. 그렇다면

그냥 단순하게 ctxt 객체에게 임시 파일을 생성하라고 시키는 것이다.

 

BufferedOutputSream bos = ctxt.createScratchFileStream(classFileName);

 

객체에게 맡기기 적당한 임무며, ctxt는 내부 구조를 드러내지 않게 되고, 해당 함수는 자신이 몰라도되는 다른 객체를 탐색할 필요가 없다.

 

 

4. 자료 전달 객체

자료 구조체는 공개 변수만 있고 함수는 없는 클래스다.

이를 때로는 자료 전달 객체 (DTO, Data Transfer Object) 라고 부른다.

 

이 구조체는 특히 DB와 통신하거나 소켓에서 받은 메시지의 구문을 분석할 때 특히 유용하다. 

 

이것의 조금 더 일반적인 형태는 '빈' 구조이다.

빈은 비공개 변수를 조회/설정 함수로 조작한다. 

 

아래와 같은 방식이다.

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의 특수한 형태다. 

공개 변수가 있거나 비공개 변수에도 조회 및 설정 함수가 있는 자료 구조이면서 save나 find같은 탐색 함수도 제공한다.

 

활성 레코드는 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과다.

 

그러나 이 활성 레코드에 비즈니스 메서드를 추가하여 자료구조임에도 객체 취급하는 경우가 있는데 이는 바람직하지 않고, 잡종 구조를 만든다.

 

활성 레코드는 자료 구조로 취급하고, 비즈니스 룰을 담으면서 내부 자료를 숨기는 객체는 별도로 생성하자.

  

  

5. 결론

객체는 동작을 공개하고 자료를 숨긴다.

=> 기존 동작을 변경하지 않으면 새 객체 타입을 추가하기 쉽지만 기존 객체에 새 동작을 추가하는 것은 어렵다.

 

자료 구조는 별다른 동작 없이 자료를 노출한다.

=> 새 동작을 추가하기는 쉬우나, 새 자료 구조를 추가하는 것은 어렵다.

 

이 둘의 차이를 이해하고 각자의 장점을 잘 살릴 수 있는 상황에서 사용해야 한다.

 

새로운 자료 타입을 추가하는 유연성이 필요한 상황이면 객체가 더 적합하고, 새로운 동작을 추가하는 유연성이 필요한 상황이면 자료 구조 및 절차적 설계가 더 적합하다.

 

편견없이 문제에 최적인 해결책의 구조를 사용하자.