Корень композиции

Паттерны проектирования / Паттерны чистой архитектуры
image

import "fmt"

//entity
type Order struct {
    ID    int
    Total int
}

func (o Order) Payable() int {
    if o.Total >= 200 {
        return o.Total - o.Total/10
    }
    return o.Total
}

//gateway
type Catalog interface {
    Price(sku string) (int, bool)
}

//repository
type Orders interface {
    Save(order Order)
    Count() int
}

//output port
type Report interface {
    Say(text string)
}

type Item struct {
    SKU   string
    Count int
}

//use case: asks for its parts, never builds them
type PlaceOrder struct {
    catalog Catalog
    orders  Orders
    report  Report
    nextID  int
}

func (u *PlaceOrder) Place(items []Item) {
    total := 0
    for _, item := range items {
        price, ok := u.catalog.Price(item.SKU)
        if !ok {
            u.report.Say("no " + item.SKU)
            return
        }
        total += price * item.Count
    }
    order := Order{u.nextID, total}
    u.nextID++
    u.orders.Save(order)
    u.report.Say(fmt.Sprintf("order %d for %d",
        order.ID, order.Payable()))
}

//adapters
type MemoryCatalog struct{}

func (MemoryCatalog) Price(sku string) (int, bool) {
    prices := map[string]int{"pen": 30, "lamp": 190}
    price, ok := prices[sku]
    return price, ok
}

type MemoryOrders struct {
    rows []Order
}

func (m *MemoryOrders) Save(order Order) {
    m.rows = append(m.rows, order)
}

func (m *MemoryOrders) Count() int {
    return len(m.rows)
}

type ConsoleReport struct{}

func (ConsoleReport) Say(text string) {
    fmt.Println(text)
}

type SilentReport struct{}

func (SilentReport) Say(text string) {
}

//composition root: the only place that sees every layer
//at once, and the only place where an adapter is built.
//go has no container for this on purpose: wiring is
//plain code, and in a real program it lives in main
type ShopApp struct {
    UseCase *PlaceOrder
    Orders  Orders
}

func newApp(report Report) *ShopApp {
    orders := &MemoryOrders{}
    return &ShopApp{
        UseCase: &PlaceOrder{MemoryCatalog{}, orders,
            report, 1001},
        Orders: orders,
    }
}

func newLoudApp() *ShopApp {
    return newApp(ConsoleReport{})
}

func newQuietApp() *ShopApp {
    return newApp(SilentReport{})
}

//client code
app := newLoudApp()
app.UseCase.Place([]Item{{"pen", 2}, {"lamp", 1}})
app.UseCase.Place([]Item{{"chair", 1}})

//a second root builds the same use case differently
night := newQuietApp()
night.UseCase.Place([]Item{{"lamp", 1}})
fmt.Println("saved", night.Orders.Count())
//printed: order 1001 for 225
//         no chair
//         saved 1


Корень композиции - единственное место, где слои соединяются и строятся адаптеры; остальное приложение только просит свои части.
Read more

Задача. Сценарию нужны каталог цен, хранилище заказов и способ выдать отчёт. Если сценарий сам создаёт эти части, он называет адаптеры внешнего слоя и зависит от них. Тест не может подставить ему другие части. А если каждая часть программы сама собирает свои части, никто не видит, как соединено приложение.

Идея. Корень композиции - единственное место, где соединяются слои и создаются адаптеры. Адаптер - это внешний код, который реализует порт, то есть интерфейс, объявленный внутренним слоем. Сценарий только просит свои части через порты и никогда не создаёт их сам. Корень знает все слои сразу, и в этом его работа. Весь остальной код соблюдает правило зависимостей: внутренний код никогда не знает внешнего. Ни фреймворк, ни контейнер для этого не нужны: корень - обычный код в начале программы.

Как читать пример. Сценарий просит три порта: шлюз для цен, репозиторий для заказов и выходной порт для отчётов. Во внешнем слое для них есть адаптеры: каталог и хранилище в памяти, отчёт, который печатает, и отчёт, который молчит. Пример собирает приложение дважды. В первой сборке отчёт печатает: клиентский код оформляет заказ 1001 с суммой к оплате 225 и заказ на неизвестный товар. Во второй сборке отчёт молчит, поэтому её заказы ничего не печатают. Сохранены ли они, видно только по числу заказов в хранилище. Сценарий в обеих сборках один и тот же.

Когда применять. У каждого приложения один корень композиции, в самом начале; у теста может быть свой маленький корень с поддельными адаптерами. Короткому скрипту без портов корень не нужен.

Частая ошибка. Создать адаптер внутри сценария, пусть даже один раз. Тогда сценарий зависит от внешнего слоя, а корень больше не показывает, как соединено приложение.