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

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

//entity
class Order(val id: Int, val total: Int) {
    val payable: Int
        get() = if (total >= 200) total - total / 10
                else total
}

//gateway
interface Catalog {
    fun price(sku: String): Int?
}

//repository
interface Orders {
    fun save(order: Order)
    fun count(): Int
}

//output port
interface Report {
    fun say(text: String)
}

//use case: asks for its parts, never builds them
class PlaceOrder(
    private val catalog: Catalog,
    private val orders: Orders,
    private val report: Report
) {
    private var nextId = 1001

    fun place(items: Map<String, Int>) {
        var total = 0
        for ((sku, count) in items) {
            val price = catalog.price(sku)
            if (price == null) {
                report.say("no $sku")
                return
            }
            total += price * count
        }
        val order = Order(nextId++, total)
        orders.save(order)
        report.say(
            "order ${order.id} for ${order.payable}")
    }
}

//adapter
class MemoryCatalog: Catalog {
    private val prices = mapOf("pen" to 30, "lamp" to 190)

    override fun price(sku: String): Int? {
        return prices[sku]
    }
}

//adapter
class MemoryOrders: Orders {
    private val rows = mutableListOf<Order>()

    override fun save(order: Order) {
        rows.add(order)
    }

    override fun count(): Int {
        return rows.size
    }
}

//adapter
class ConsoleReport: Report {
    override fun say(text: String) {
        println(text)
    }
}

//adapter
class SilentReport: Report {
    override fun say(text: String) {
    }
}

//composition root: the only place that sees every layer
//at once, and the only place where an adapter is built
class ShopApp(
    catalog: Catalog,
    val orders: Orders,
    report: Report
) {
    val useCase = PlaceOrder(catalog, orders, report)

    //a companion object holds the ready recipes
    companion object {
        fun loud(): ShopApp {
            return ShopApp(MemoryCatalog(),
                           MemoryOrders(),
                           ConsoleReport())
        }

        fun quiet(): ShopApp {
            return ShopApp(MemoryCatalog(),
                           MemoryOrders(),
                           SilentReport())
        }
    }
}

//client code
val app = ShopApp.loud()
app.useCase.place(linkedMapOf("pen" to 2, "lamp" to 1))
app.useCase.place(mapOf("chair" to 1))

//a second root builds the same use case differently
val night = ShopApp.quiet()
night.useCase.place(mapOf("lamp" to 1))
println("saved ${night.orders.count()}")
//printed: order 1001 for 225
//         no chair
//         saved 1


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

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

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

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

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

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