实体

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

# entity: the rules of the shop speak with an error of
# their own, never with a bare string
class ShopRule < StandardError; end

# entity
class OrderLine
    attr_reader :sku, :price, :count

    def initialize(sku, price, count)
        raise ShopRule, "bad count" if count <= 0
        @sku = sku
        @price = price
        @count = count
        # a line never changes after it is born
        freeze
    end

    def cost = price * count
end

# entity
class Order
    attr_reader :id

    def initialize(id)
        @id = id
        @lines = []
        @paid = false
    end

    def add(sku, price, count)
        raise ShopRule, "order is paid" if @paid
        @lines << OrderLine.new(sku, price, count)
        self
    end

    # the inner list is never handed out as it is
    def lines = @lines.dup.freeze

    def size = @lines.size

    def total = @lines.sum(&:cost)

    # business rule: 10% off from 200
    def discount = total >= 200 ? total / 10 : 0

    def payable = total - discount

    # business rule: an empty order is never paid
    def pay
        raise ShopRule, "empty order" if @lines.empty?
        @paid = true
        self
    end

    def paid? = @paid
end

# client code
# no database and no screen anywhere above
order = Order.new(1001)
order.add("pen", 30, 2)
order.add("lamp", 190, 1)
puts "order #{order.id}"
puts "lines #{order.size}"
puts "total #{order.total}"
puts "discount #{order.discount}"
puts "payable #{order.payable}"

order.pay
puts "paid #{order.paid?}"

# every refusal comes from the rules themselves:
# no storage and no screen took part in them
begin
    order.add("pen", 30, 1)
rescue ShopRule => error
    puts "refused: #{error.message}"
end

begin
    Order.new(1002).pay
rescue ShopRule => error
    puts "refused: #{error.message}"
end

begin
    OrderLine.new("pen", 30, 0)
rescue ShopRule => error
    puts "refused: #{error.message}"
end

# the list handed out is frozen, so nobody adds a line
# behind the back of the rules above
begin
    order.lines << OrderLine.new("chair", 1, 1)
rescue FrozenError
    puts "refused: lines are frozen"
end
# printed: order 1001
#          lines 2
#          total 250
#          discount 25
#          payable 225
#          paid true
#          refused: order is paid
#          refused: empty order
#          refused: bad count
#          refused: lines are frozen


An entity holds a business rule of the shop and knows nothing about a database, a screen or the network, so it can be tested without them.
Read more

问题。商店对金额达到 200 的每笔订单减免 10%。如果这条规则写在网页里,又在数据库查询里写了一遍,两份副本很快就会不一致。要检查这条规则,就得启动网页或数据库。商店最重要的知识分散各处,难以测试。

思路。实体是一段数据,连同与它相关的业务规则:订单包含什么,总额如何计算,何时可以付款。它对数据库、界面或网络一无所知。整洁架构有一条主要规则,即依赖规则:外层代码可以了解内层代码,但内层代码从不了解外层代码。实体是最内层的代码,因此不依赖任何东西。

如何阅读示例。示例中有两个实体:订单行和订单本身。订单汇总各行,对 200 及以上的金额减免 10%,并计算应付金额。订单为空时,它拒绝付款。客户端代码构建含两个订单行的订单 1001,并打印其中的数字:总额 250,折扣 25,应付 225。它还尝试为一个空订单付款,实体予以拒绝。在某些语言中,实体是带有函数的普通值,而不是类;它的角色不变。

何时使用。业务中每个拥有自己规则的概念,例如订单或账户,都应做成一个实体。没有规则的数据不需要实体:简单的结构就够了。

常见错误。实体自己把自己保存到数据库,或者为界面格式化自己。这样它就依赖于外层代码,它的规则也无法再单独测试。