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

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

#include <iostream>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <vector>
using namespace std;

//entity
class Order {
    int id;
    int sum;

public:
    Order(int id, int sum): id(id), sum(sum) {}

    int number() const {
        return id;
    }

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

//gateway
class Catalog {
public:
    virtual ~Catalog() = default;
    virtual optional<int> price(const string& sku) = 0;
};

//repository
class Orders {
public:
    virtual ~Orders() = default;
    virtual void save(const Order& order) = 0;
    virtual int count() const = 0;
};

//output port
class Report {
public:
    virtual ~Report() = default;
    virtual void say(const string& text) = 0;
};

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

public:
    PlaceOrder(Catalog& c, Orders& o, Report& r)
        : catalog(c), orders(o), report(r) {}

    void place(const vector<pair<string, int>>& items) {
        int total = 0;
        for (const auto& [sku, count] : items) {
            optional<int> price = catalog.price(sku);
            if (!price) {
                report.say("no " + sku);
                return;
            }
            total += *price * count;
        }
        Order order(nextId++, total);
        orders.save(order);
        report.say("order " + to_string(order.number())
                   + " for " + to_string(order.payable()));
    }
};

//adapters
class MemoryCatalog: public Catalog {
    map<string, int> prices{{"pen", 30}, {"lamp", 190}};

public:
    optional<int> price(const string& sku) override {
        if (prices.contains(sku)) {
            return prices.at(sku);
        }
        return nullopt;
    }
};

class MemoryOrders: public Orders {
    vector<Order> rows;

public:
    void save(const Order& o) override {
        rows.push_back(o);
    }

    int count() const override { return rows.size(); }
};

class ConsoleReport: public Report {
public:
    void say(const string& text) override {
        cout << text << endl;
    }
};

class SilentReport: public Report {
public:
    void say(const string&) override {}
};

//composition root: the only place that sees every layer
//at once, and the only place where an adapter is built.
//it OWNS the adapters through unique_ptr and lends them
//to the use case as references, so the use case owns
//nothing and cannot outlive its parts. the order of the
//fields matters: the adapters are built before useCase
struct ShopApp {
    unique_ptr<Catalog> catalog;
    unique_ptr<Orders> orders;
    unique_ptr<Report> report;
    PlaceOrder useCase;

    ShopApp(unique_ptr<Catalog> c, unique_ptr<Orders> o,
            unique_ptr<Report> r)
        : catalog(std::move(c)), orders(std::move(o)),
          report(std::move(r)),
          useCase(*catalog, *orders, *report) {}

    static ShopApp loud() {
        return ShopApp(make_unique<MemoryCatalog>(),
                       make_unique<MemoryOrders>(),
                       make_unique<ConsoleReport>());
    }

    static ShopApp quiet() {
        return ShopApp(make_unique<MemoryCatalog>(),
                       make_unique<MemoryOrders>(),
                       make_unique<SilentReport>());
    }
};

//client code
ShopApp app = ShopApp::loud();
app.useCase.place({{"pen", 2}, {"lamp", 1}});
app.useCase.place({{"chair", 1}});

//a second root builds the same use case differently
ShopApp night = ShopApp::quiet();
night.useCase.place({{"lamp", 1}});
cout << "saved " << night.orders->count() << endl;
//printed: order 1001 for 225
//         no chair
//         saved 1


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

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

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

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

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

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