模版模式(Template Method Design Pattern),是指定义一个算法的骨架,并将某些步骤推迟到子类中实现。
这里的算法,可以理解为广义上的通用业务逻辑。这里的算法骨架就是“模板”,包含算法骨架的方法就是“模板方法”,这也是模板方法模式名字的由来。
模板方法模式可以让子类在不改变算法整体结构的情况下,重新定义算法中的某些步骤。
模版模式的应用场景
模版模式适用于以下情况:
-
一些方法非常通用,一次性实现算法中通用的作为不变部分,并将可变的行为留给子类来实现。
-
各子类中公共的行为被提取出来并集中到一个公共的父类中,从而避免代码重复。
模版模式的构成
模版模式的构成非常简单,主要就是两个部分:
- 模版类:主要定义不变的部分(模版方法),以及规范子类需要实现的方法,也就是可变的部分交给子类实现。
- 模版子类:继承模版类,并实现模版类中可变的部分。
通过一个制作麦当劳套餐的例子来说明。
麦当劳通常三件套套餐都是选择一个主食,一个小吃,一杯饮料。
这个套餐的出餐方法就是一个模版方法,我们只需要在具体的套餐子类中定制自己的选择即可。
模版类
class McDonaldPackage:
def get(self):
print("--- 先准备主食 ---")
self.staples()
print("--- 再准备小吃 ---")
self.snack()
print("--- 最后准备饮料 ---")
self.drink()
print("--- 出餐咯 --- ")
@abstractmethod
def staples(self):
"""主食"""
pass
@abstractmethod
def snack(self):
"""小吃"""
pass
@abstractmethod
def drink(self):
"""饮料"""
pass
上面的模版类中,我们定义了模版方法get
也就是出餐的逻辑,每个套餐中,都要 准备主食 -> 准备小吃 -> 准备饮料 -> 出餐。
模版子类
class Package1(McDonaldPackage):
def staples(self):
print("主食选择双层吉士汉堡")
def snack(self):
print("小吃选择薯条")
def drink(self):
print("饮料选择可乐")
class Package2(McDonaldPackage):
def staples(self):
print("主食选择巨无霸汉堡")
def snack(self):
print("小吃选择麦辣鸡翅")
def drink(self):
print("饮料选择雪碧")
在子类中,我们继承 McDonaldPackage 并各自实现了可变的部分,最后通过父类的get
方法实现整体的功能。
具体使用
# 套餐1
pkg1 = Package1()
pkg1.get()
# 套餐2
pkg2 = Package2()
pkg2.get()
# ==== 输出 ====
--- 先准备主食 ---
主食选择双层吉士汉堡
--- 再准备小吃 ---
小吃选择薯条
--- 最后准备饮料 ---
饮料选择可乐
--- 出餐咯 ---
--- 先准备主食 ---
主食选择巨无霸汉堡
--- 再准备小吃 ---
小吃选择麦辣鸡翅
--- 最后准备饮料 ---
饮料选择雪碧
--- 出餐咯 ---
通过定义了两个具体的套餐子类,实现可变的抽象方法,而不需要实现出餐方法,就实现了出餐的功能。
优缺点
优点
- 灵活性很大,只需要实现提供的少量扩展点。
- 符合抽象封装原则,只需要实现扩展的部分。
- 结构清晰,提取公共代码,便于维护。
缺点
- 每一个不同的实现都需要一个子类来实现,导致类的个数增加,系统变得庞大。
实际应用
在 python 中提供了内置的线程安全的 Queue 模块,其中就利用了模版模式,我们看一下其中LifoQueue
类的源码发现,只有下面短短几行:
class LifoQueue(Queue):
def _init(self, maxsize):
self.queue = []
def _qsize(self):
return len(self.queue)
def _put(self, item):
self.queue.append(item)
def _get(self):
return self.queue.pop()
这里的设计非常巧妙,当我们想实现一个自己的队列时,线程安全的问题已经被 Queue本身处理了,我们只需要在_init
中定义自己的数据结构,并且遵循下面的规则即可实现一个自己的队列:
_qsize
:返回队列的大小。_put
:实现放入队列的操作。_get
:实现获取队列数据的操作。
这种就是典型的,Queue类本身提供了模版方法和扩展点,子类只需要实现很少的几个方法,就能自定义一个自己的功能完善的队列,非常好用。
总结
模板模式有两大作用:复用和扩展。其中,复用指的是,所有的子类可以复用父类中提供的模板方法的代码。扩展指的是,框架通过模板模式提供功能扩展点,让框架用户可以在不修改框架源码的情况下,基于扩展点定制化框架的功能。