📘

Architecture Patterns with Python - Harry Percival, Bob Gregory

1. Domain Modeling

가. Domain Model

1) 도메인 모델 기본 이해

2) 테스트 케이스 작성법

나. 테스트 기반 도메인 모델링 절차

1) 특정 비지니스 사례 만족 테스트 작성

2) 도메인 모델링

3) 테스트 성공

4) 또 다른 비지니스 사례 만족 테스트 작성

5) 도메인 리모델링

다. Entity vs Value Object

1) Entity

2) Value Object

라. Domain Service Function

1) 객체 집착 지양

2) 사례

2. Repository Pattern ORM

가. Repository vs Active Record

1) 설계 비교

2) 코드 비교

3) Trade Offs

나. Repository Pattern

2) 책임 중심으로 테스트 케이스 작성

3) 테스트 케이스를 만족하는 기능 구현

Reference

1. Domain Modeling

가. Domain Model

1) 도메인 모델 기본 이해

•

Domain Model: 비지니스 문제 해결을 위해 비지니스 전문가들이 고안한 문제 해결 절차

◦

Domain: 해결하려는 비지니스 문제

◦

Model: 문제를 해결하기 위한 절차

•

비지니스 전문가들과 소통 시, 주요한 의미가 함축된 비지니스 용어에 대한 이해 필요

•

domain model에 대한 충분한 이해를 위해 사례 중심으로 이해 필요

2) 테스트 케이스 작성법

•

domain model에 대한 사례를 바탕으로 테스트 케이스 작성

→ business 용어를 변수나 함수의 이름으로 차용

ex) 20개 수량의 Batch에 대해 2개 수량이 포함된 Orderline이 할당되면 Batch 내 수량은 18개가 된다

def test_allocating_to_a_batch_reduces_the_available_quantity():
    batch = Batch("batch-001", "SMALL-TABLE", qty=20, eta=date.today())
    line = OrderLine("order-ref", "SMALL-TABLE", 2)

    batch.allocate(line)

    assert batch.available_quantity == 18
Python
복사

나. 테스트 기반 도메인 모델링 절차

1) 특정 비지니스 사례 만족 테스트 작성

•

Batch와 OrderLine의 할당 절차에 대한 테스트 케이스 작성

def test_allocating_to_a_batch_reduces_the_available_quantity():
    batch = Batch("batch-001", "SMALL-TABLE", qty=20, eta=date.today())
    line = OrderLine("order-ref", "SMALL-TABLE", 2)

    batch.allocate(line)

    assert batch.available_quantity == 18
Python
복사

2) 도메인 모델링

•

OrderLine과 Batch 객체 생성

•

Batch class 내 allocate 행동에 대한 메소드 추가

@dataclass(frozen=True)
class OrderLine:
    orderid: str
    sku: str
    qty: int


class Batch:
    def __init__(self, ref: str, sku: str, qty: int, eta: Optional[date]):
        self.reference = ref
        self.sku = sku
        self.eta = eta
        self.available_quantity = qty

    def allocate(self, line: OrderLine):
        self.available_quantity -= line.qty  #(3)
Python
복사

3) 테스트 성공

•

1)에 명시한 테스트 케이스 통화

4) 또 다른 비지니스 사례 만족 테스트 작성

•

Batch에 OrderLine 할당 조건에 대한 비지니스 사례를 만족하는 테스트 케이스 추가

def make_batch_and_line(sku, batch_qty, line_qty):
    return (
        Batch("batch-001", sku, batch_qty, eta=date.today()),
        OrderLine("order-123", sku, line_qty),
    )

def test_can_allocate_if_available_greater_than_required():
    large_batch, small_line = make_batch_and_line("ELEGANT-LAMP", 20, 2)
    assert large_batch.can_allocate(small_line)

def test_cannot_allocate_if_available_smaller_than_required():
    small_batch, large_line = make_batch_and_line("ELEGANT-LAMP", 2, 20)
    assert small_batch.can_allocate(large_line) is False

def test_can_allocate_if_available_equal_to_required():
    batch, line = make_batch_and_line("ELEGANT-LAMP", 2, 2)
    assert batch.can_allocate(line)

def test_cannot_allocate_if_skus_do_not_match():
    batch = Batch("batch-001", "UNCOMFORTABLE-CHAIR", 100, eta=None)
    different_sku_line = OrderLine("order-123", "EXPENSIVE-TOASTER", 10)
    assert batch.can_allocate(different_sku_line) is False
Python
복사

5) 도메인 리모델링

•

할당 조건에 대한 테스트 케이스를 성공시키기 위해 관련 메소드 추가 및 기존 할당 메소드 수정

class Batch:
    def __init__(self, ref: str, sku: str, qty: int, eta: Optional[date]):
        self.reference = ref
        self.sku = sku
        self.eta = eta
        self.available_quantity = qty

    def allocate(self, line: OrderLine):
        if self.can_allocate(line):
            self._allocations.add(line)

		def can_allocate(self, line: OrderLine) -> bool:
        return self.sku == line.sku and self.available_quantity >= line.qty
Python
복사

다. Entity vs Value Object

1) Entity

•

정의: 길게 유지되는 식별자를 통해 구분되는 객체

•

특징

→ Identity Equality: 유일성을 보장 받는 식별자로 구분됨

•

예시

→ reference가 같으면 같은 객체임

→ == 연산자로 객체 동등성을 연산하기 위해 reference 값을 기준으로 __eq__ 메소드를 오버라이딩함

→ set과 dict에서 관리되기 위해 reference 값을 기준으로 __hash__ 메소드를 오버라이딩함(set, dict에서 관리될 필요가 없다면 오버라이딩 할 필요 없음

class Batch:
    def __init__(self, ref: str, sku: str, qty: int, eta: Optional[date]):
        self.reference = ref
        self.sku = sku
        self.eta = eta
        self.available_quantity = qty

		def __eq__(self, other):
        if not isinstance(other, Batch):
            return False
        return other.reference == self.reference

    def __hash__(self):
        return hash(self.reference)
Python
복사

2) Value Object

•

정의: 객체의 단일 값이나 값의 조합으로 구분되는 객체

•

특징

→ Value Equality: 중복이 허용되는 값 또는 값의 조합으로 구분됨

→ Immutable: 값 자체로 구분되기 때문에 값의 불변성이 만족되어야 함

ref) 값이 불변해야하는 이유는 set이나 dict 자료구조에서 value object가 관리되기 위해서는 불변의 hash값이 필요한데, value object의 해쉬값은 value 기반으로 생성됨

•

예시

→ orderid, sku, qty라는 값의 조합이 같으면 같은 객체임

→ @dataclass(frozen=True): 인스턴스 생성 후 값의 불변성을 보장 받음

→ @dataclass(unsafe_hash=True): __hash__ 메소드가 추가됨

@dataclass(frozen=True)
class OrderLine:
    orderid: str
    sku: str
    qty: int
Python
복사

라. Domain Service Function

1) 객체 집착 지양

•

객체 내에서 처리하기 어려운 비지니스 모델이 있다고 무조건 관련 객체를 생성하지 말고 함수로 처리가능한지 고려해볼 것

→ 모든것을 객체로 처리하는 방식으로 설계하면 파이썬의 철학과 맞지 않게 복잡성이 높아질 수 있음

→ 파이썬은 객체지향 뿐만 아니라 여러 프로그래밍 패러다임을 지원함.

2) 사례

•

특정 Batch에 대한 OrderLine 할당이 아니라 다수의 Batch에 대한 OrderLine 할당에 대한 비지니스 사례에 대한 구현은 기존 객체(Batch, OrderLine)를 활용한 함수로 작업 가능

def allocate(line: OrderLine, batches: List[Batch]) -> str:
    try:
        batch = next(b for b in sorted(batches) if b.can_allocate(line))
        batch.allocate(line)
        return batch.reference
    except StopIteration:
        raise OutOfStock(f"Out of stock for sku {line.sku}")
Python
복사

2. Repository Pattern ORM

가. Repository vs Active Record

1) 설계 비교

Repository: Domain Modeling 단계에서 DB 고민 불필요 / Active Record: 비지니스 로직 설계 단계에서 DB 고민 필요

•

Repository Pattern: 표현계층과 DB계층이 모두 Domain Model에 의존함

◦

Presentation Layer → Domain Model  ← Database Layer

•

Active Record Pattern: 표현계층은 비지니스 로직에 의존하고, 비지니스 로직은 DB계층에 의존함

◦

Presentation Layer → Business Logic → Database Layer

2) 코드 비교

•

Repository

→ domain model을 가져옴(의존함 , import model)

→ domain model을 기준으로 DB 스키마 생성

→ start_mapper를 호출하여 domain 모델과 스키마를 토대로 DB 테이블 변환

from sqlalchemy.orm import mapper, relationship

import model


metadata = MetaData()

order_lines = Table(
    "order_lines",
    metadata,
    Column("id", Integer, primary_key=True, autoincrement=True),
    Column("sku", String(255)),
    Column("qty", Integer, nullable=False),
    Column("orderid", String(255)),
)

...

def start_mappers():
    lines_mapper = mapper(model.OrderLine, order_lines)
Python
복사

•

Active Record

→ DB 스키마 생성 == 도메인 모델 생성 == DB 테이블 생성

class Order(models.Model):
    pass

class OrderLine(models.Model):
    sku = models.CharField(max_length=255)
    qty = models.IntegerField()
    order = models.ForeignKey(Order)

class Allocation(models.Model):
    ...
Python
복사