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

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

import java.util.*;

//entity
class Order {
    final int id;
    final int total;

    Order(int id, int total) {
        this.id = id;
        this.total = total;
    }

    int payable() {
        return total >= 200 ? total - total / 10 : total;
    }
}

//gateway
interface Catalog {
    Integer price(String sku);
}

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

    int count();
}

//output port
interface Report {
    void say(String text);
}

//use case: asks for its parts, never builds them
class PlaceOrder {
    private final Catalog catalog;
    private final Orders orders;
    private final Report report;
    private int nextId = 1001;

    PlaceOrder(Catalog catalog, Orders orders,
               Report report) {
        this.catalog = catalog;
        this.orders = orders;
        this.report = report;
    }

    void place(Map<String, Integer> items) {
        int total = 0;
        for (var item : items.entrySet()) {
            Integer price = catalog.price(item.getKey());
            if (price == null) {
                report.say("no " + item.getKey());
                return;
            }
            total += price * item.getValue();
        }
        Order order = new Order(nextId++, total);
        orders.save(order);
        report.say("order " + order.id
                   + " for " + order.payable());
    }
}

//adapters
class MemoryCatalog implements Catalog {
    public Integer price(String sku) {
        return Map.of("pen", 30, "lamp", 190).get(sku);
    }
}

class MemoryOrders implements Orders {
    private final List<Order> rows = new ArrayList<>();

    public void save(Order order) {
        rows.add(order);
    }

    public int count() {
        return rows.size();
    }
}

class ConsoleReport implements Report {
    public void say(String text) {
        System.out.println(text);
    }
}

class SilentReport implements Report {
    public void say(String text) {
    }
}

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

    ShopApp(Catalog catalog, Orders orders, Report report) {
        this.orders = orders;
        this.useCase =
            new PlaceOrder(catalog, orders, report);
    }

    static ShopApp loud() {
        return new ShopApp(new MemoryCatalog(),
                           new MemoryOrders(),
                           new ConsoleReport());
    }

    static ShopApp quiet() {
        return new ShopApp(new MemoryCatalog(),
                           new MemoryOrders(),
                           new SilentReport());
    }
}

//client code
var app = ShopApp.loud();
app.useCase.place(Map.of("pen", 2, "lamp", 1));
app.useCase.place(Map.of("chair", 1));

//a second root builds the same use case differently
var night = ShopApp.quiet();
night.useCase.place(Map.of("lamp", 1));
System.out.println("saved " + night.orders.count());
//printed: order 1001 for 225
//         no chair
//         saved 1


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

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

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

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

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

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