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

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

;; Composition root folds into one function that builds
;; the adapters and hands them to the use case: no
;; container, only arguments

;; Entity
(defn payable [order]
  (let [total (:total order)]
    (if (>= total 200)
      (- total (quot total 10))
      total)))

;; Gateway
(defprotocol Catalog
  (price [catalog sku]))

;; Repository: it numbers what it saves
(defprotocol Orders
  (save [orders order])
  (saved [orders]))

;; Output port
(defprotocol Report
  (say [report text]))

;; Use case: asks for its parts, never builds them
(defn place-order [catalog orders report]
  (fn [items]
    (if-let [sku (first (remove #(price catalog %)
                                (keys items)))]
      (say report (str "no " sku))
      (let [total (reduce + 0
                          (for [[sku qty] items]
                            (* (price catalog sku) qty)))
            order (save orders {:total total})]
        (say report (str "order " (:id order)
                         " for " (payable order)))))))

;; Adapters
(defrecord MemoryCatalog [prices]
  Catalog
  (price [_ sku]
    (get prices sku)))

(defrecord MemoryOrders [rows]
  Orders
  (save [_ order]
    (peek (swap! rows
                 (fn [kept]
                   (conj kept
                         (assoc order :id
                                (+ 1001 (count kept))))))))
  (saved [_]
    (count @rows)))

(def console-report
  (reify Report
    (say [_ text]
      (println text))))

(def silent-report
  (reify Report
    (say [_ _])))

;; Composition root: the only place that sees every
;; layer at once, and the only place that names an
;; adapter. The app it returns is a plain map
(defn shop-app [report]
  (let [orders (->MemoryOrders (atom []))]
    {:place (place-order
              (->MemoryCatalog {"pen" 30 "lamp" 190})
              orders
              report)
     :orders orders}))

(defn loud [] (shop-app console-report))
(defn quiet [] (shop-app silent-report))

;; Client code
(def app (loud))
((:place app) {"pen" 2 "lamp" 1})
((:place app) {"chair" 1})

;; A second root builds the same use case differently
(def night (quiet))
((:place night) {"lamp" 1})
(println "saved" (saved (:orders night)))
;; printed: order 1001 for 225
;;          no chair
;;          saved 1


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

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

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

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

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

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