组合根

设计模式 / 整洁架构模式
image

constexpr size_t maxOrders = 8;

//entity
typedef struct {
    int id;
    int sum;
} Order;

int orderPayable(const Order *order) {
    int sum = order->sum;
    return sum >= 200 ? sum - sum / 10 : sum;
}

//gateway
typedef struct Catalog {
    bool (*price)(struct Catalog *self, const char *sku,
                  int *price);
} Catalog;

//repository
typedef struct Orders {
    bool (*save)(struct Orders *self, const Order *order);
    size_t (*count)(struct Orders *self);
} Orders;

//output port
typedef struct Report {
    void (*say)(struct Report *self, const char *text);
} Report;

typedef struct {
    const char *sku;
    int count;
} Item;

//use case: asks for its parts, never builds them
typedef struct {
    Catalog *catalog;
    Orders *orders;
    Report *report;
    int nextId;
} PlaceOrder;

void placeOrder(PlaceOrder *useCase, const Item items[],
                size_t count) {
    Catalog *catalog = useCase->catalog;
    Report *report = useCase->report;
    char text[32];
    int total = 0;
    for (size_t i = 0; i < count; i++) {
        const Item *item = &items[i];
        int price = 0;
        if (!catalog->price(catalog, item->sku, &price)) {
            snprintf(text, sizeof text, "no %s", item->sku);
            report->say(report, text);
            return;
        }
        total += price * item->count;
    }
    Order order = {useCase->nextId, total};
    if (!useCase->orders->save(useCase->orders, &order)) {
        report->say(report, "not saved");
        return;
    }
    useCase->nextId++;
    snprintf(text, sizeof text, "order %d for %d", order.id,
             orderPayable(&order));
    report->say(report, text);
}

//adapters
bool memoryPrice(Catalog *, const char *sku, int *price) {
    static const struct {
        const char *sku;
        int price;
    } prices[] = {{"pen", 30}, {"lamp", 190}};
    size_t count = sizeof prices / sizeof prices[0];
    for (size_t i = 0; i < count; i++) {
        if (strcmp(prices[i].sku, sku) == 0) {
            *price = prices[i].price;
            return true;
        }
    }
    return false;
}

typedef struct {
    Orders base;
    Order rows[maxOrders];
    size_t size;
} MemoryOrders;

bool memorySave(Orders *self, const Order *order) {
    MemoryOrders *memory = (MemoryOrders *)self;
    if (memory->size == maxOrders) {
        return false;
    }
    memory->rows[memory->size++] = *order;
    return true;
}

size_t memoryCount(Orders *self) {
    return ((MemoryOrders *)self)->size;
}

void consoleSay(Report *, const char *text) {
    printf("%s\n", text);
}

void silentSay(Report *, const char *) {}

//composition root: the only place that sees every layer
//at once, and the only place where an adapter is built.
//C has no unique_ptr: the root holds the adapters by
//value, so they live exactly as long as the root does
typedef struct {
    Catalog catalog;
    MemoryOrders orders;
    Report report;
    PlaceOrder useCase;
} ShopApp;

//the use case points into the root, so a root is built
//in its place and never copied afterwards
void shopAppBuild(ShopApp *app, Report report) {
    app->catalog = (Catalog){memoryPrice};
    app->orders = (MemoryOrders){
        .base = {memorySave, memoryCount}};
    app->report = report;
    app->useCase = (PlaceOrder){&app->catalog,
                                &app->orders.base,
                                &app->report, 1001};
}

void shopAppLoud(ShopApp *app) {
    shopAppBuild(app, (Report){consoleSay});
}

void shopAppQuiet(ShopApp *app) {
    shopAppBuild(app, (Report){silentSay});
}

//client code
ShopApp app;
shopAppLoud(&app);
Item wanted[] = {{"pen", 2}, {"lamp", 1}};
placeOrder(&app.useCase, wanted, 2);
placeOrder(&app.useCase, (Item[]){{"chair", 1}}, 1);

//a second root builds the same use case differently
ShopApp night;
shopAppQuiet(&night);
placeOrder(&night.useCase, (Item[]){{"lamp", 1}}, 1);
Orders *orders = &night.orders.base;
printf("saved %zu\n", orders->count(orders));
//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,又下了一个含未知商品的订单。第二次构建使用静默的报告,因此它的订单什么也不打印。只有已保存订单的数量表明它们确实被保存了。两次构建中的用例完全相同。

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

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