组合根

设计模式 / 整洁架构模式
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


A composition root is the only place where the layers are connected and the adapters are built; the rest of the application only asks for its parts.
Read more

问题。用例需要一个价格目录、一个订单存储,以及一种报告结果的途径。如果用例自己创建这些部件,它就会指明外层的适配器,并依赖于它们。测试也无法为它提供别的部件。如果程序的每个部分都自行构建自己的部件,就没有人能看清应用程序是如何连接起来的。

思路。组合根是唯一一个连接各层、构建适配器的地方。适配器是实现端口的外层代码,而端口是内层声明的接口。用例只通过端口索取自己的部件,从不自己构建它们。组合根同时了解每一层,这正是它的职责。其余所有代码都遵守依赖规则:内层代码从不了解外层代码。这不需要任何框架或容器:组合根就是程序启动处的普通代码。

如何阅读示例。用例索取三个端口:一个查询价格的网关、一个保存订单的仓库,以及一个用于报告的输出端口。外层为它们提供了适配器:内存中的目录和存储,一个会打印的报告,还有一个什么也不说的报告。示例把应用程序构建了两次。第一次构建中,报告会打印:客户端代码下了订单 1001,应付 225,又下了一个含未知商品的订单。第二次构建使用静默的报告,因此它的订单什么也不打印。只有已保存订单的数量表明它们确实被保存了。两次构建中的用例完全相同。

何时使用。每个应用程序都有一个组合根,位于它的启动处;测试可以有自己的小型组合根,使用假的适配器。没有端口的短脚本不需要组合根。

常见错误。在用例内部创建适配器,哪怕只有一次。这样用例就依赖于外层,组合根也不再能展示应用程序是如何连接起来的。