떼닝로그

[6장] 객체와 자료 구조 본문

개발로그/Clean Code

[6장] 객체와 자료 구조

떼닝 2022. 12. 9. 23:50

- 남들이 변수에 의존하지 않게 만들기 위해 변수를 비공개로 정의한다.

자료 추상화

- 아래 첫 번째와 두 번째 코드 모두 2차원 점을 표현하지만, 한 클래스는 구현을 외부로 노출하고 다른 클래스는 구현을 완전히 숨긴다.

# 6-1
class Point():
	def __init__(self):
    	self.x = 0.0
        self.y = 0.0
        
# 6-2
class Point():
	def __init__(self):
    	pass
    
    def getX(self):
    	pass
    
    def getY(self):
    	pass
        
    def setCartesian(self, x:double, y:double):
    	pass
        
    def getR(self):
    	pass
        
    def getTheta(self):
    	pass
        
    def setPolar(r:double, theta:double):
    	pass

- 두 번째 코드는 자료 구조 이상을 표현한다. 클래스 메서드가 접근 정책을 강제한다.

- 첫 번째 코드는 개별적으로 좌표값을 읽고 설정하게 강제하고, 구현을 노출한다.

- 두 번째 코드가 더 좋은 코드.

- 구현을 감추려면 추상화가 필요하다. 추상 인터페이스를 제공해 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 진정한 의미의 클래스.

- 아래 두 개의 코드를 봤을 때 첫 번째 코드는 상태를 구체적인 숫자 값으로 알려주고, 두 번째 코드는 백분율이라는 추상적인 개념으로 알려준다.

# 6-3
class Vehicle():
	def getFuelTankCapacityInGallons(self):
   		pass
    def getGallonsOfGasoline(self):
    	pass
        
        
# 6-4
class Vehicle():
	def getPercentFuelRemaining(self):
    	pass

- 두 번째 코드가 더 좋다.

- 자료를 세세하게 공개하기보다는 추상적인 개념으로 표현하는 것이 좋다.

- 인터페이스나 조회/설정 함수만으로는 추상화가 이뤄지지 않는다. 객체가 포함하는 자료를 표현할 가장 좋은 방법 고민해야.

자료/객체 비대칭

- 객체는 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 공개.

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

- 아래 코드에서 도형이 동작하는 방식은 Geometry 클래스에서 구현.

class Square():
	def topLeft(self):
    	pass
    def side(self):
    	pass
        
class Rectangle():
	def topLeft(self):
    	pass
        
    def height(self):
    	pass
    
    def width(self):
    	pass
        
class Circle():
	def center(self):
    	pass
        
    def radius(self):
    	pass
        
class Geometry():
	def __init__(self):
    	PI = 3.141592653589793
        
    def area(self, shape:Object):
    	if shape in Square:
        	s = (Square)shape
            return s.side ** 2

		elif shape in Rectangle:
        	r = (Rectangel)shape
            return r.height * r.width
            
        elif shape in Circle:
        	c = (Circle)shape
            return PI * c.radius ** 2

- 클래스가 절차적이지만, 새로운 함수, 예를 들어 둘레 길이를 구하는 perimeter 함수를 만든다고 해도 도형 클래스에는 아무 영향도 없음

- 아래는 객체 지향적인 도형 클래스.

- 새 도형을 추가해도 기존 함수에 아무런 영향을 주지 않지만, 새 함수를 추가할 때는 도형 클래스 전부를 고쳐야 한다.

class Square():
	def __init__(self):
    	topLeft = 0
        side = 0.0
        
    def area(self):
    	return side**2
        
class Rectangle(Shape):
	def __init__(self):
    	topLeft = 0
        self.height = 0.0
        self.width = 0.0
        
    def area(self):
    	return self.height * self.width
        
class Circle(Shape):
	def __init__(self):
    	self.center = 0
        self.radius = 0
        self.PI = 3.141592653589793
        
    def area(self):
    	return self.PI * self.radius * radius

- 위 두 개 코드는 상호 보완적인 특징이 있음... 사실상 반대!

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

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

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

- 새로운 자료 타입이 필요할 때는 클래스와 객체 지향 기법이 가장 적합

- 새로운 함수가 필요할 때는 절차적인 코드와 자료 구조가 좀 더 적합

디미터 법칙

- 디미터 법칙은 잘 알려진 휴리스틱으로, 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙

- 객체는 자료를 숨기고 함수를 공개. 조회 함수로 내부 구조를 공개하면 안 된다.

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

  - 클래스 C

  - f가 생성한 객체

  - f 인수로 넘어온 객체

  - C 인스턴스 변수에 저장된 객체

- 위 객체에서 허용된 메서드가 반환하는 객체의 메서드는 호출하면 안 된다....!

- 아래 코드는 디미터 법칙을 어기는 것처럼 보인다.

outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath()

기차 충돌

- 바로 위에 있는 것과 같은 코드를 기차 충돌이라고 한다. 여러 객차가 한 줄로 이어진 기차처럼 보이기 때문. 피하는 것이 좋음.

- 위 코드는 아래와 같이 나누는 것이 좋다.

opts = ctxt.getOptions()
scratchDir = opts.getScratchDir()
outputDir = scratchDir.getAbsolutePath()

- 첫 번째 코드는 함수 하나가 아는 지식이 굉장히 많다. 이 코드를 사용하는 함수는 많은 객체를 탐색할 줄 안다는 것.

- 위 예제가 디미터 법칙을 위반하는지 여부는 ctxt, Options, ScratchDir이 객체인지 아니면 자료 구조인지에 달렸다.

- 객체라면 내부 구조를 숨겨야 하므로 디미터 법칙을 위반하지만, 자료 구조라면 당연히 내부 구조를 노출하므로 디미터 법칙이 적용되지 않음

- 아래와 같이 코드를 구현했을 경우 디미터 법칙을 거론할 필요가 없어짐.

outputDir = ctxt.options.scratchDir.absolutePath

- 자료 구조는 무조건 함수 없이 공개 변수만 포함하고, 객체비공개 변수와 공개 함수를 포함한다.

- 단순한 자료 구조에도 조회 함수와 설정 함수를 정의하라 요구하는 프레임워크와 표준이 존재

잡종 구조

- 절반은 객체, 절반은 자료 구조인 잡종 구조가 나옴.

- 잡종 구조는 중요한 기능을 수행하는 함수도 있고, 공개 변수나 공개 조회/설정 함수도 있다.

- 공개 조회/설정 함수비공개 변수를 그대로 노출하여 절차적인 프로그래밍의 자료 구조 접근 방식처럼 비공개 변수를 사용하고픈 유혹에 빠지게 됨

- 잡종 구조는 새로운 함수와 새로운 자료 구조 모두 추가하기 어렵다. 단점만 모아놓은 구조이기 때문에,,, 피하는 것이 좋다.

구조체 감추기

- 객체라면 내부 구조를 감춰야 한다!

# 1
ctxt.getAbsolutePathOfScratchDirectoryOption()

# 2
ctxt.getScratchDirectoryOption().getAbsolutePath()

- 첫 번째 방법은 ctxt 객체에 공개해야 하는 메서드가 너무 많아지고, 두 번째 방법은 getScratchDirectoryOption()이 자료 구조를 반환한다고 가정한다.

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

- 아래는 같은 모듈에서 가져온 코드

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

- 추상화 수준을 뒤섞어 놓아 불편하다. 객체를 부주의하게 마구 뒤섞으면 안 된다.

- 아무튼 위 코드는 임시 디렉터리의 절대 경로를 얻으려는 이유가 임시 파일을 생성하기 위한 목적이라는 사실이 드러난다.

- ctxt 객체에 임시 파일을 생성하라고 시킨다면?

bos = ctxt.createScratchFileStream(classFileName)

- 위 코드는 객체에 맡기기에 적당한 임무처럼 보임.

- ctxt는 내부 구조를 드러내지 않으며, 모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다

- 디미터 법칙을 위반하지 않는다.

자료 전달 객체

- 자료 구조체의 전형적인 형태는 공개 변수만 있고 함수가 없는 클래스. 이런 것을 자료 전달 객체(Data Transfer Objeect, DTO)

- DTO는 데이터베이스와 통신하거나 소켓에서 받은 메시지의 구문을 분석할 때 유용하고, 데이터베이스에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체

- 일반적인 형태는 빈(bean) 구조. 비공개 변수를 조회/설정 함수로 조작. 사이비 캡슐화.

class Address():
	def __init__(self):
    	self.street = ""
        self.streetExtra = ""
        self.city = ""
        self.state = ""
        self.zip = ""
        
	def Address(self, street, streetExtra, city, state, zip):
    	self.street = street
        self.streetExtra = streetExtra
        self.city = city
        self.state = state
        self.zip = zip
        
	def getStreet(self):
    	return self.street
        
    def getStreetExtra(self):
    	return self.streetExtra
        
    def getCity(self):
    	return self.city
        
    def getState(self):
    	return self.state
        
    def getZip(self):
    	return self.zip

활성 레코드

- 활성 레코드는 DTO의 특수한 형태. 공개 변수가 있거나 비공개 변수에 조회/설정 함수가 있는 자료 구조지만, 대개 save나 find와 같은 탐색 함수도 제공.

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

- 활성 레코드에 비즈니스 규칙 메서드를 추가해 이런 자료 구조를 객체로 취급하게 되면 잡종 구조가 나옴

- 활성 레코드는 자료 구조로 취급해야 한다. 비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성.

결론

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

- 기존 동작을 변경하지 않으면서 새 객체 타입을 추가하기는 쉽지만, 기존 객체에 새 동작을 추가하기는 어렵다.

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

- 기존 자료 구조에 새 동작을 추가하기는 쉽지만, 기존 함수에 새 자료 구조를 추가하기는 어렵다.

- 시스템을 구현할 때, 새로운 자료 타입을 추가하는 유연성이 필요하면 객체가 적합

- 새로운 동작을 추가하는 유연성이 필요하면 자료 구조와 절차적인 코드가 더 적합

 

'개발로그 > Clean Code' 카테고리의 다른 글

[8장] 경계  (0) 2022.12.26
[7장] 오류 처리  (0) 2022.12.19
[5장] 형식 맞추기  (0) 2022.12.02
[4장] 주석  (0) 2022.11.16
[3장] 함수  (0) 2022.11.02
Comments