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

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

<?php

//entity
class Order {
    function __construct(
        public readonly int $id,
        public readonly int $total
    ) {}

    function payable(): int {
        return $this->total >= 200
            ? $this->total - intdiv($this->total, 10)
            : $this->total;
    }
}

//gateway
interface Catalog {
    function price(string $sku): ?int;
}

//repository
interface Orders {
    function save(Order $order): void;

    function count(): int;
}

//output port
interface Report {
    function say(string $text): void;
}

//use case: asks for its parts, never builds them
class PlaceOrder {
    private int $nextId = 1001;

    function __construct(
        private Catalog $catalog,
        private Orders $orders,
        private Report $report
    ) {}

    function place(array $items): void {
        $total = 0;
        foreach ($items as $sku => $count) {
            $price = $this->catalog->price($sku);
            if ($price === null) {
                $this->report->say("no " . $sku);
                return;
            }
            $total += $price * $count;
        }
        $order = new Order($this->nextId++, $total);
        $this->orders->save($order);
        $this->report->say("order " . $order->id
            . " for " . $order->payable());
    }
}

//adapters
class MemoryCatalog implements Catalog {
    function price(string $sku): ?int {
        return ["pen" => 30, "lamp" => 190][$sku] ?? null;
    }
}

class MemoryOrders implements Orders {
    private array $rows = [];

    function save(Order $order): void {
        $this->rows[] = $order;
    }

    function count(): int {
        return count($this->rows);
    }
}

class ConsoleReport implements Report {
    function say(string $text): void {
        echo $text, "\n";
    }
}

class SilentReport implements Report {
    function say(string $text): void {
    }
}

//composition root: the only place that sees every layer
//at once, and the only place where an adapter is built
final class ShopApp {
    public readonly PlaceOrder $useCase;

    function __construct(
        Catalog $catalog,
        public readonly Orders $orders,
        Report $report
    ) {
        $this->useCase =
            new PlaceOrder($catalog, $orders, $report);
    }

    //named arguments: wiring reads as a list of parts
    static function loud(): self {
        return new self(
            catalog: new MemoryCatalog(),
            orders: new MemoryOrders(),
            report: new ConsoleReport());
    }

    static function quiet(): self {
        return new self(
            catalog: new MemoryCatalog(),
            orders: new MemoryOrders(),
            report: new SilentReport());
    }
}

//client code
$app = ShopApp::loud();
$app->useCase->place(["pen" => 2, "lamp" => 1]);
$app->useCase->place(["chair" => 1]);

//a second root builds the same use case differently
$night = ShopApp::quiet();
$night->useCase->place(["lamp" => 1]);
echo "saved ", $night->orders->count(), "\n";
//printed: order 1001 for 225
//         no chair
//         saved 1


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

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

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

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

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

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