组合根

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

import "fmt"

//entity
type Order struct {
    ID    int
    Total int
}

func (o Order) Payable() int {
    if o.Total >= 200 {
        return o.Total - o.Total/10
    }
    return o.Total
}

//gateway
type Catalog interface {
    Price(sku string) (int, bool)
}

//repository
type Orders interface {
    Save(order Order)
    Count() int
}

//output port
type Report interface {
    Say(text string)
}

type Item struct {
    SKU   string
    Count int
}

//use case: asks for its parts, never builds them
type PlaceOrder struct {
    catalog Catalog
    orders  Orders
    report  Report
    nextID  int
}

func (u *PlaceOrder) Place(items []Item) {
    total := 0
    for _, item := range items {
        price, ok := u.catalog.Price(item.SKU)
        if !ok {
            u.report.Say("no " + item.SKU)
            return
        }
        total += price * item.Count
    }
    order := Order{u.nextID, total}
    u.nextID++
    u.orders.Save(order)
    u.report.Say(fmt.Sprintf("order %d for %d",
        order.ID, order.Payable()))
}

//adapters
type MemoryCatalog struct{}

func (MemoryCatalog) Price(sku string) (int, bool) {
    prices := map[string]int{"pen": 30, "lamp": 190}
    price, ok := prices[sku]
    return price, ok
}

type MemoryOrders struct {
    rows []Order
}

func (m *MemoryOrders) Save(order Order) {
    m.rows = append(m.rows, order)
}

func (m *MemoryOrders) Count() int {
    return len(m.rows)
}

type ConsoleReport struct{}

func (ConsoleReport) Say(text string) {
    fmt.Println(text)
}

type SilentReport struct{}

func (SilentReport) Say(text string) {
}

//composition root: the only place that sees every layer
//at once, and the only place where an adapter is built.
//go has no container for this on purpose: wiring is
//plain code, and in a real program it lives in main
type ShopApp struct {
    UseCase *PlaceOrder
    Orders  Orders
}

func newApp(report Report) *ShopApp {
    orders := &MemoryOrders{}
    return &ShopApp{
        UseCase: &PlaceOrder{MemoryCatalog{}, orders,
            report, 1001},
        Orders: orders,
    }
}

func newLoudApp() *ShopApp {
    return newApp(ConsoleReport{})
}

func newQuietApp() *ShopApp {
    return newApp(SilentReport{})
}

//client code
app := newLoudApp()
app.UseCase.Place([]Item{{"pen", 2}, {"lamp", 1}})
app.UseCase.Place([]Item{{"chair", 1}})

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

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

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