Python 使用一等函数实现设计模式(案例分析:重构“策略”模式)
案例分析:重构“策略”模式
如果合理利用作为一等对象的函数,某些设计模式可以简化,“策略”模
式就是其中一个很好的例子。本节接下来的内容中将说明“策略”模式,
并使用《设计模式:可复用面向对象软件的基础》一书中所述的“经
典”结构实现它。如果你熟悉这个经典模式,可以跳到 6.1.2 节,了解如
何使用函数重构代码来有效减少代码行数。
经典的“策略”模式
图 6-1 中的 UML 类图指出了“策略”模式对类的编排。
《设计模式:可复用面向对象软件的基础》一书是这样概述“策略”模式
的:
定义一系列算法,把它们一一封装起来,并且使它们可以相互替
换。本模式使得算法可以独立于使用它的客户而变化。
电商领域有个功能明显可以使用“策略”模式,即根据客户的属性或订单
中的商品计算折扣。
假如一个网店制定了下述折扣规则。
- 有 1000 或以上积分的顾客,每个订单享 5% 折扣。
- 同一订单中,单个商品的数量达到 20 个或以上,享 10% 折扣。
- 订单中的不同商品达到 10 个或以上,享 7% 折扣。
简单起见,我们假定一个订单一次只能享用一个折扣。
“策略”模式的 UML 类图见图 6-1,其中涉及下列内容。
- 上下文
把一些计算委托给实现不同算法的可互换组件,它提供服务。在这
个电商示例中,上下文是 Order,它会根据不同的算法计算促销折扣。 - 策略
实现不同算法的组件共同的接口。在这个示例中,名为 Promotion
的抽象类扮演这个角色。 - 具体策略
“策略”的具体子类。fidelityPromo、BulkPromo 和
LargeOrderPromo 是这里实现的三个具体策略。
示例 6-1 实现了图 6-1 中的方案。按照《设计模式:可复用面向对象软
件的基础》一书的说明,具体策略由上下文类的客户选择。在这个示例
中,实例化订单之前,系统会以某种方式选择一种促销折扣策略,然后
把它传给 Order 构造方法。具体怎么选择策略,不在这个模式的职责
范围内。
示例 6-1 实现 Order 类,支持插入式折扣策略
from abc import ABC, abstractmethod
from collections import namedtupleCustomer = namedtuple('Customer', 'name fidelity')
class LineItem:def __init__(self, product, quantity, price):self.product = productself.quantity = quantityself.price = pricedef total(self):return self.price * self.quantity
class Order: # 上下文def __init__(self, customer, cart, promotion=None):self.customer = customerself.cart = list(cart)self.promotion = promotiondef total(self):if not hasattr(self, '__total'):self.__total = sum(item.total() for item in self.cart)return self.__totaldef due(self):if self.promotion is None:discount = 0else:discount = self.promotion.discount(self)return self.total() - discountdef __repr__(self):fmt = '<Order total: {:.2f} due: {:.2f}>'return fmt.format(self.total(), self.due())
class Promotion(ABC) : # 策略:抽象基类@abstractmethoddef discount(self, order):"""返回折扣金额(正值)"""
class FidelityPromo(Promotion): # 第一个具体策略"""为积分为1000或以上的顾客提供5%折扣"""def discount(self, order):return order.total() * .05 if order.customer.fidelity >= 1000 else 0
class BulkItemPromo(Promotion): # 第二个具体策略"""单个商品为20个或以上时提供10%折扣"""def discount(self, order):discount = 0for item in order.cart:if item.quantity >= 20:discount += item.total() * .1return discountclass LargeOrderPromo(Promotion): # 第三个具体策略"""订单中的不同商品达到10个或以上时提供7%折扣"""def discount(self, order):distinct_items = {item.product for item in order.cart}if len(distinct_items) >= 10:return order.total() * .07return 0
注意,在示例 6-1 中,我把 Promotion 定义为抽象基类(Abstract Base
Class,ABC),这么做是为了使用 @abstractmethod 装饰器,从而明
确表明所用的模式。
在 Python 3.4 中,声明抽象基类最简单的方式是子类化
abc.ABC。我在示例 6-1 中就是这么做的。从 Python 3.0 到 Python
3.3,必须在 class 语句中使用 metaclass= 关键字(例
如,class Promotion(metaclass=ABCMeta):)。
示例 6-2 是一些 doctest,在某个实现了上述规则的模块中演示和验证相
关操作。
示例 6-2 使用不同促销折扣的 Order 类示例
>>> joe = Customer('John Doe', 0) ➊
>>> ann = Customer('Ann Smith', 1100)
>>> cart = [LineItem('banana', 4, .5), ➋
... LineItem('apple', 10, 1.5),
... LineItem('watermellon', 5, 5.0)]
>>> Order(joe, cart, FidelityPromo()) ➌
<Order total: 42.00 due: 42.00>
>>> Order(ann, cart, FidelityPromo()) ➍
<Order total: 42.00 due: 39.90>
>>> banana_cart = [LineItem('banana', 30, .5), ➎
... LineItem('apple', 10, 1.5)]
>>> Order(joe, banana_cart, BulkItemPromo()) ➏
<Order total: 30.00 due: 28.50>
>>> long_order = [LineItem(str(item_code), 1, 1.0) ➐
... for item_code in range(10)]
>>> Order(joe, long_order, LargeOrderPromo()) ➑
<Order total: 10.00 due: 9.30>
>>> Order(joe, cart, LargeOrderPromo())
<Order total: 42.00 due: 42.00>
❶ 两个顾客:joe 的积分是 0,ann 的积分是 1100。
❷ 有三个商品的购物车。
❸ fidelityPromo 没给 joe 提供折扣。
❹ ann 得到了 5% 折扣,因为她的积分超过 1000。
❺ banana_cart 中有 30 把香蕉和 10 个苹果。
❻ BulkItemPromo 为 joe 购买的香蕉优惠了 1.50 美元。
❼ long_order 中有 10 个不同的商品,每个商品的价格为 1.00 美元。
❽ LargerOrderPromo 为 joe 的整个订单提供了 7% 折扣。
示例 6-1 完全可用,但是利用 Python 中作为对象的函数,可以使用更少
的代码实现相同的功能。详情参见下一节。
使用函数实现“策略”模式
在示例 6-1 中,每个具体策略都是一个类,而且都只定义了一个方法,
即 discount。此外,策略实例没有状态(没有实例属性)。你可能会
说,它们看起来像是普通的函数——的确如此。示例 6-3 是对示例 6-1
的重构,把具体策略换成了简单的函数,而且去掉了 Promo 抽象类。
示例 6-3 Order 类和使用函数实现的折扣策略
from collections import namedtuple
Customer = namedtuple('Customer', 'name fidelity')
class LineItem:def __init__(self, product, quantity, price):self.product = productself.quantity = quantityself.price = pricedef total(self):return self.price * self.quantity
class Order: # 上下文def __init__(self, customer, cart, promotion=None):self.customer = customerself.cart = list(cart)self.promotion = promotiondef total(self):if not hasattr(self, '__total'):self.__total = sum(item.total() for item in self.cart)return self.__totaldef due(self):if self.promotion is None:discount = 0else:discount = self.promotion(self) ➊return self.total() - discountdef __repr__(self):fmt = '<Order total: {:.2f} due: {:.2f}>'return fmt.format(self.total(), self.due())
➋def fidelity_promo(order): ➌"""为积分为1000或以上的顾客提供5%折扣"""return order.total() * .05 if order.customer.fidelity >= 1000 else 0def bulk_item_promo(order):"""单个商品为20个或以上时提供10%折扣"""discount = 0for item in order.cart:if item.quantity >= 20:discount += item.total() * .1return discountdef large_order_promo(order):"""订单中的不同商品达到10个或以上时提供7%折扣"""distinct_items = {item.product for item in order.cart}if len(distinct_items) >= 10:return order.total() * .07return 0
❶ 计算折扣只需调用 self.promotion() 函数。
❷ 没有抽象类。
❸ 各个策略都是函数。
示例 6-3 中的代码比示例 6-1 少 12 行。不仅如此,新的 Order 类使用
起来更简单,如示例 6-4 中的 doctest 所示。
示例 6-4 使用函数实现的促销折扣的 Order 类示例
>>> joe = Customer('John Doe', 0) ➊
>>> ann = Customer('Ann Smith', 1100)
>>> cart = [LineItem('banana', 4, .5),
... LineItem('apple', 10, 1.5),
... LineItem('watermellon', 5, 5.0)]
>>> Order(joe, cart, fidelity_promo) ➋
<Order total: 42.00 due: 42.00>
>>> Order(ann, cart, fidelity_promo)
<Order total: 42.00 due: 39.90>
>>> banana_cart = [LineItem('banana', 30, .5),
... LineItem('apple', 10, 1.5)]
>>> Order(joe, banana_cart, bulk_item_promo) ➌
<Order total: 30.00 due: 28.50>
>>> long_order = [LineItem(str(item_code), 1, 1.0)
... for item_code in range(10)]
>>> Order(joe, long_order, large_order_promo)
<Order total: 10.00 due: 9.30>
>>> Order(joe, cart, large_order_promo)
<Order total: 42.00 due: 42.00>
❶ 与示例 6-1 一样的测试固件。
❷ 为了把折扣策略应用到 Order 实例上,只需把促销函数作为参数传
入。
❸ 这个测试和下一个测试使用不同的促销函数。
注意示例 6-4 中的标注:没必要在新建订单时实例化新的促销对象,函
数拿来即用。
值得注意的是,《设计模式:可复用面向对象软件的基础》一书的作者
指出:“策略对象通常是很好的享元(flyweight)。” 那本书的另一部
分对“享元”下了定义:“享元是可共享的对象,可以同时在多个上下文
中使用。” 共享是推荐的做法,这样不必在每个新的上下文(这里是
Order 实例)中使用相同的策略时不断新建具体策略对象,从而减少消
耗。因此,为了避免“策略”模式的一个缺点(运行时消耗),《设计模
式:可复用面向对象软件的基础》的作者建议再使用另一个模式。但此
时,代码行数和维护成本会不断攀升。
在复杂的情况下,需要具体策略维护内部状态时,可能需要把“策
略”和“享元”模式结合起来。但是,具体策略一般没有内部状态,只是
处理上下文中的数据。此时,一定要使用普通的函数,别去编写只有一
个方法的类,再去实现另一个类声明的单函数接口。函数比用户定义的
类的实例轻量,而且无需使用“享元”模式,因为各个策略函数在 Python
编译模块时只会创建一次。普通的函数也是“可共享的对象,可以同时
在多个上下文中使用”。
至此,我们使用函数实现了“策略”模式,由此也出现了其他可能性。假
设我们想创建一个“元策略”,让它为指定的订单选择最佳折扣。接下来
的几节会接着重构,利用函数和模块是对象,使用不同的方式实现这个
需求。
选择最佳策略:简单的方式
我们继续使用示例 6-4 中的顾客和购物车,在此基础上添加 3 个测试,
如示例 6-5 所示。
示例 6-5 best_promo 函数计算所有折扣,并返回额度最大的
>>> Order(joe, long_order, best_promo) ➊
<Order total: 10.00 due: 9.30>
>>> Order(joe, banana_cart, best_promo) ➋
<Order total: 30.00 due: 28.50>
>>> Order(ann, cart, best_promo) ➌
<Order total: 42.00 due: 39.90>
❶ best_promo 为顾客 joe 选择 larger_order_promo。
❷ 订购大量香蕉时,joe 使用 bulk_item_promo 提供的折扣。
❸ 在一个简单的购物车中,best_promo 为忠实顾客 ann 提供
fidelity_promo 优惠的折扣。
best_promo 函数的实现特别简单,如示例 6-6 所示。
示例 6-6 best_promo 迭代一个函数列表,并找出折扣额度最大
的
promos = [fidelity_promo, bulk_item_promo, large_order_promo] ➊
def best_promo(order): ➋
"""选择可用的最佳折扣
"""
return max(promo(order) for promo in promos) ➌
❶ promos 列出以函数实现的各个策略。
❷ 与其他几个 *_promo 函数一样,best_promo 函数的参数是一个
Order 实例。
❸ 使用生成器表达式把 order 传给 promos 列表中的各个函数,返回
折扣额度最大的那个函数。
示例 6-6 简单明了,promos 是函数列表。习惯函数是一等对象后,自
然而然就会构建那种数据结构存储函数。
虽然示例 6-6 可用,而且易于阅读,但是有些重复可能会导致不易察觉
的缺陷:若想添加新的促销策略,要定义相应的函数,还要记得把它添加到 promos 列表中;否则,当新促销函数显式地作为参数传给 Order
时,它是可用的,但是 best_promo 不会考虑它。
继续往下读,了解这个问题的几种解决方案。
找出模块中的全部策略
在 Python 中,模块也是一等对象,而且标准库提供了几个处理模块的函
数。Python 文档是这样说明内置函数 globals 的。
- globals()
返回一个字典,表示当前的全局符号表。这个符号表始终针对当前
模块(对函数或方法来说,是指定义它们的模块,而不是调用它们的模
块)。
示例 6-7 使用 globals 函数帮助 best_promo 自动找到其他可用的
*_promo 函数,过程有点曲折。
示例 6-7 内省模块的全局命名空间,构建 promos 列表
promos = [globals()[name] for name in globals() ➊if name.endswith('_promo') ➋and name != 'best_promo'] ➌def best_promo(order):"""选择可用的最佳折扣"""return max(promo(order) for promo in promos) ➍
❶ 迭代 globals() 返回字典中的各个 name。
❷ 只选择以 _promo 结尾的名称。
❸ 过滤掉 best_promo 自身,防止无限递归。
❹ best_promo 内部的代码没有变化。
收集所有可用促销的另一种方法是,在一个单独的模块中保存所有策略
函数,把 best_promo 排除在外。
在示例 6-8 中,最大的变化是内省名为 promotions 的独立模块,构建
策略函数列表。注意,示例 6-8 要导入 promotions 模块,以及提供高
阶内省函数的 inspect 模块(简单起见,这里没有给出导入语句,因
为导入语句一般放在文件顶部)。
示例 6-8 内省单独的 promotions 模块,构建 promos 列表
promos = [func for name, func in
inspect.getmembers(promotions, inspect.isfunction)]def best_promo(order):"""选择可用的最佳折扣"""return max(promo(order) for promo in promos)
inspect.getmembers 函数用于获取对象(这里是 promotions 模块)
的属性,第二个参数是可选的判断条件(一个布尔值函数)。我们使用
的是 inspect.isfunction,只获取模块中的函数。
不管怎么命名策略函数,示例 6-8 都可用;唯一重要的
是,promotions 模块只能包含计算订单折扣的函数。当然,这是对代
码的隐性假设。如果有人在 promotions 模块中使用不同的签名定义函
数,那么 best_promo 函数尝试将其应用到订单上时会出错。
我们可以添加更为严格的测试,审查传给实例的参数,进一步过滤函
数。示例 6-8 的目的不是提供完善的方案,而是强调模块内省的一种用
途。
动态收集促销折扣函数更为显式的一种方案是使用简单的装饰器。第 7
章讨论函数装饰器时会使用其他方式实现这个电商“策略”模式示例。